Add llms.txt and per-page markdown for LLM-friendly docs#2185
Open
Add llms.txt and per-page markdown for LLM-friendly docs#2185
Conversation
Adds a post-build script that runs after `zensical build` to generate: - llms.txt: structured index linking to .md versions of all doc pages - llms-full.txt: full documentation content for curated (non-generated) pages - Per-page .md files served alongside HTML in the site output The script parses mkdocs.yml nav automatically, so new docs are picked up without manual updates. Directory-expanded pages (blocks, kinds, gallery) are linked in llms.txt but excluded from llms-full.txt to keep it focused. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Erol444
requested review from
PawelPeczek-Roboflow,
dkosowski87,
grzegorz-roboflow,
hansent,
probicheaux and
yeldarby
as code owners
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
PawelPeczek-Roboflow
approved these changes
Mar 31, 2026
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.
Summary
docs/scripts/generate_llms_txt.py— a post-build script that generatesllms.txt,llms-full.txt, and per-page.mdfiles from themkdocs.ymlnav structurezensical build, plus a verification checkmkdocs.yml— no manual file lists to maintainHow it works
mkdocs.ymlnav to find all doc pages.mdfiles intosite/alongside their HTML counterparts (e.g.site/start/overview/index.md)llms.txtwith links to all 302 pages across 4 sectionsllms-full.txtwith full content for 102 curated pages (~600KB), excluding auto-generated directory-expanded pages (workflow blocks, kinds, gallery) to keep it focusedWhy
inference.roboflow.com currently fails coding agent benchmarks for LLM discoverability:
llms.txt.mdURL supportThis addresses all three.
Test plan
zensical build && python docs/scripts/generate_llms_txt.pyllms.txt,llms-full.txt, and.mdfiles are served correctly🤖 Generated with Claude Code