Repository navigation
Make documentation discoverable and readable by AI agents - #44
Merged
Merged
Conversation
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
2 participants
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.
The documentation site serves HTML but offers no plain-text index or Markdown endpoints for agents. Add
/llms.txtwith links to all 426 published pages,/llms-full.txtwith the complete documentation, and/markdown/<doc-slug>.mdfor each page. All exports use the same sources as the HTML pages, including generated APIs and examples for every scripting language.Normalize documentation links to their canonical Markdown destinations while preserving code examples. Expose the index in navigation and HTML metadata, advertise each page's Markdown alternative, and add a canonical sitemap, permissive robots file, and Cloudflare Pages content-type headers. Everything is generated during the existing static build.
Validation: build, lint with zero warnings, TypeScript, dependency audit (zero vulnerabilities), all 38 tests, documentation structure and export links/anchors. The four new tests verify every indexed Markdown file, complete full-text coverage, unchanged code examples, reachable Markdown links, discovery metadata, and hosting headers. Re-ran the export tests and TypeScript after the final navigation change.
Production publishing remains handled by the existing workflow after merge to
main.