Repository navigation
LOU-D12: llms.txt, llms-full.txt and docs shipped in the npm package - #51
Merged
Merged
Conversation
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
scripts/generate-llms-txt.ts(+ pure helpers inscripts/llmsTxt.ts, 16 unit tests) generatesllms.txt(llmstxt.org layout: Docs / Examples / Optional, absolute GitHub URLs frompackage.jsonrepository.url) andllms-full.txt(README, then installation, quick-start, api-overview, rest alphabetical; each under# Title+Source:line; relative links made absolute; HTML comments and badges stripped).docs:llmsanddocs:llms:check; the check runs in CI next to the docs snippet check and prints "llms.txt is stale: run npm run docs:llms".package.jsonfilesnow shipsllms.txt,llms-full.txt,docs/*.md(minusdocs/eslint-baseline-followup.md; research/plan are in subdirs so never matched).Why
Agents should be able to read the docs from
node_modules, and the files must not go stale.How verified
npm pack --dry-run: includesdocs/agent-forge.md api-overview.md configuration.md deployment.md installation.md quick-start.md testing.md,llms-full.txt(88.5kB),llms.txt(3.8kB); nodocs/research,docs/plan,docs/eslint-baseline-followup.md. total files: 152npx tsc --noEmitclean;npm run lint: 0 errors (434 warnings, none from this change;src/untouched)npm run test:coverage: 99 files passed, 1301 tests passed, 3 skippednpm run fallowexit 0 (fixed 2 unused exports along the way)npm run docs:verify-snippets: all 33 snippets type-check, 5 rundocs:llms:checkexits 0 on fresh output and 1 with the stale message after tamperingNotes for reviewer
origin/mainbefore final verification: it was already up to date (no new commits).npm run docs:llmsand commitllms.txt/llms-full.txt(do not hand-resolve conflicts in them); CI will fail otherwise.🤖 Generated with Claude Code