feat(docs): self-maintaining llms.txt generated from nav.yml#3695
Open
aheritier wants to merge 1 commit into
Open
feat(docs): self-maintaining llms.txt generated from nav.yml#3695aheritier wants to merge 1 commit into
aheritier wants to merge 1 commit into
Conversation
Add a spec-compliant (https://llmstxt.org/) /llms.txt to the edge docs site, generated at Hugo build time from docs/data/nav.yml so it stays in sync as pages are added — deployed by the existing docs-deploy workflow with no new CI or cron. - hugo.yaml: register a plain-text 'llms' output format attached to the home page (outputs.home) so it is actually rendered. - layouts/home.llms.txt: template emitting the H1, blockquote summary, and one H2 per nav section with '- [title](url): note' links (absolute URLs via absURL; note from each page's front-matter description). Flattens both items and groups[].items, and hard-fails the build when a nav page is unresolved or its description is empty. - layouts/_partials/footer.html: add an llms.txt discoverability link. - scripts/docs-check-llms-txt.sh: CI-invoked semantic validator that rebuilds the site and asserts llms.txt matches nav.yml's sections, titles, order, count and per-entry URL — catching template regressions a green build would miss. - docs-lint.yml: wire in the new llms-txt-check job (pinned Hugo). - STYLE.md: document generation, the description requirement, and CI.
Sayt-0
approved these changes
Jul 16, 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
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
Adds a spec-compliant
/llms.txtto the edge documentation site (docker.github.io/docker-agent), generated at Hugo build time fromdocs/data/nav.yml. Adding a page to the nav automatically adds it tollms.txt— it self-maintains, deployed by the existingdocs-deployworkflow with no new CI or cron.Why
The docs describe an agent runtime, so their audience is disproportionately LLMs pulling them into a coding context.
llms.txtgives models a curated, single-file index of the documentation.docs/data/nav.ymlis already the hand-curated canonical index, so driving generation from it keeps the two in lockstep with zero extra maintenance.Changes
docs/hugo.yamlllmsoutput format, attached to the home page viaoutputs.home(without which it is never rendered).disableKindsuntouched.docs/layouts/home.llms.txt##section per nav group with- [title](url): notelinks (absolute viaabsURL, note from each page's front-matterdescription). Flattens bothitemsandgroups[].items; hard-fails the build if a nav page is unresolvable or its description is empty.docs/layouts/_partials/footer.htmlllms.txtdiscoverability link.scripts/docs-check-llms-txt.shllms.txtmatchesnav.yml's sections, titles, order, count and per-entry URL (position-for-position). Catches template regressions a green build alone would miss..github/workflows/docs-lint.ymlllms-txt-checkjob (pinned Hugo0.163.0, matchingdocs-deploy/docs-a11y).docs/STYLE.mdValidation
0.163.0build →llms.txt OK: 102 entries across 7 sections, matching docs/data/nav.ymlgroups[].itemstraversal), duplicated/wrong same-origin URLs, missing/whitespace-only descriptions, and section-order driftshellcheckclean; ran 25× consecutively with no flakiness🤖 Generated with human review via the multi-agent workflow (implement → review loop → merge-ready).