Repository navigation
Conversation
The docs site had no llms.txt, so AI tools and coding agents had no simple way to read the user guide and guessed or scraped the HTML. Add vitepress-plugin-llms as a devDependency of the docs package (not the root package) and register it under vite.plugins in docs/.vitepress/config.mjs, next to the existing vite.server block. The files are generated on every docs build, so a page added or renamed cannot leave them behind the way a hand-written file would. Verified with npm run docs:build: dist/llms.txt lists all 21 guide pages with links, dist/llms-full.txt (119 KB) contains the full guide, and the srcExclude'd testing.md appears in neither.
Pre-merge checks:
|
This branch has not been deployed
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.
Closes #755.
The docs site had no
llms.txt, so AI tools and coding agents had no simple way to read the user guide. Following the implementation the issue lays out:vitepress-plugin-llmsadded as a devDependency indocs/package.jsononly — not the root package, whose postinstall (electron-builder, esbuild) a docs build should not pay for.docs/.vitepress/config.mjsimports it and adds it tovite.plugins, next to the existingvite.serverblock, with a comment saying why the files are generated rather than hand-written.npm install --save-dev vitepress-plugin-llms; thevitepressversion is unchanged.As the issue notes, the files will be served at
https://wordpress.github.io/contributor-toolkit/llms.txt(project Pages subpath) and go live with the next manually-rundocs.ymlrelease, not on merge.Verification —
npm run docs:buildfrom the repo root, then the three checks from the issue againstdocs/.vitepress/dist/:llms.txtlists every guide page with a link — all 21 pages underdocs/guide/are present.llms-full.txt(119 KB) contains the full guide text.testing.mdis in neither file. It is insrcExclude; the only 'testing' hits inllms-full.txtare ordinary prose inside guide pages.Pre-PR review (per AGENTS.md, against
.github/instructions/code-review.instructions.md, on this branch's diff — 3 files, all underdocs/): Architecture — the plugin sits in the docs package, matching the separation that package exists for; generation at build time keeps the files in sync with the guide. Security — build-time-only devDependency in the docs package; nothing ships in the app and no app dependency changed. Performance — no runtime cost; the build measured 57s here including generation. Cross-platform — the plugin is plain JS with no platform-specific behaviour. Tests — the docs package has no test suite; the build-and-inspect checks above are the verification, and a dead link would fail the build (ignoreDeadLinks: false). No findings needed fixing; nothing deferred.