docs: serve raw Markdown versions of every page for AI agents - #19
Merged
Merged
Conversation
Every docs page now gets a Markdown twin at its URL plus .md, written into the build output by a small postBuild plugin. The plugin also writes llms-full.txt (the whole help center in one file, in sidebar order) and synthesizes a .md page for the generated Website Building index. The build fails if a derived URL stops matching a real route. llms.txt now tells agents to append .md to any page URL or fetch llms-full.txt, and its section links drop trailing slashes so that appending .md always forms a valid URL. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
The raw-markdown plugin now compares llms.txt against the pages that actually exist, on every build. A page that is missing from the index, or an index entry pointing at a page that no longer exists, fails the build with a message naming the exact file or URL. The summary lines stay hand-written; only coverage is checked. To make full coverage the rule, llms.txt now lists all 63 pages, with the deeper guides nested under their section entries in sidebar order. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
Author
|
Added the anti-drift check discussed in review scoping:
Verified by deleting an entry and adding a link to a nonexistent page: the build failed naming both, and went green again once restored. |
This branch was successfully 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.
What this does
AI agents can now read the help center as plain Markdown instead of parsing HTML.
.md. For example,docs.kite.ai/slack/approvalsalso servesdocs.kite.ai/slack/approvals.md. The homepage is at/index.md.llms-full.txtat the site root: all 63 pages in sidebar order, each preceded by its canonical URL (~160 KB)..mdconvention and point tollms-full.txt. Section links also drop their trailing slashes (e.g./slack/becomes/slack), so appending.mdalways forms a valid URL. Vercel already redirects the slashed form, so nothing breaks for anyone following the old links.Safety net
The plugin derives each page's URL the same way Docusaurus does, then checks every derived URL against the routes Docusaurus actually built. If a future rename or custom slug makes them disagree, the build fails with a message naming the file, instead of silently publishing Markdown at a dead URL.
Verified
docusaurus buildpasses; plugin reports 63 pages written.docs.kite.aiURL listed in llms.txt has a matching.mdfile in the build output.llms-full.txtspot-checked for order (matches the sidebar) and canonical URLs.🤖 Generated with Claude Code