feat(agents): publish llms.txt per section and a metadata sitemap.md from the nav - #2392
Merged
marcus-souza-azion merged 2 commits intoSep 28, 2026
Conversation
marcus-souza-azion
added this pull request to stack #2393
September 28, 2026 22:20
Base automatically changed from
docs/review-1-taxonomy-nav-fixes
to
release/new-azion-docs
September 28, 2026 22:33
marcus-souza-azion
requested review from
a team,
bruno-andrade-azion,
isaque-bock-azion and
pedro-ribeiro-azion
as code owners
September 28, 2026 22:33
…from the nav
The docs index was one flat list of every collection file (orphans and the style
guide included), with a title and a link and nothing else. The nav model already
holds the order, the section, the kind, the products, and the last change, so the
index now comes from it: /{lang}/{docs}/llms.txt lists the sections, every
section root serves its own llms.txt, /{lang}/{docs}/sitemap.md carries type,
section, topics, updated, and summary per page, and /{lang}/docs-llms.txt stays as
the full list the agent-setup pages cite. Every page also announces its Markdown
twin with a rel=alternate link.
marcus-souza-azion
force-pushed
the
docs/review-2-machine-readable-index
branch
from
September 28, 2026 22:33
8f5b1f0 to
a09f8ea
Compare
marcus-souza-azion
merged commit Sep 28, 2026
5bd122f
into
release/new-azion-docs
6 of 7 checks passed
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
1 participant
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.
Related Issue: MM-16034
What & why
The docs index was one flat list of every collection file (orphans, the style guide, the coming-soon page included), title and link only, in no order. The nav model already holds the order, the section, the kind, the products, and the last change, so the index now comes from it, at the documentation root, which is the conventional path for a docs site that does not own the site root.
/{lang}/documentation/llms.txt: the sections, one entry per section, each pointing at that section's own index./{lang}/documentation/<section>/llms.txt: one file per section root with every page it lists./{lang}/documentation/sitemap.md: one entry per page with type, section, topics, last change, summary, and the Markdown link./{lang}/docs-llms.txtstays as the full list the agent-setup pages and prompts cite.<link rel="alternate" type="text/markdown">.Only pages a nav tree lists are indexed (725 per language); a page in no tree never reaches an index.
Verify on
pnpm dev: open/en/documentation/llms.txt,/en/documentation/build/functions/llms.txt,/en/documentation/sitemap.md, and/en/docs-llms.txt; the style guide, the agreements orphans, and coming-soon are absent; the sitemap'stypevalues are catalog kinds; view-source of any page shows the alternate link.Related issue: none
Pages affected: no content page;
src/util/machineIndex.ts(new),src/pages/[lang]/[...path]/llms.txt.ts(new),src/pages/[lang]/[docs]/sitemap.md.ts(new),src/pages/[lang]/docs-llms.txt.ts(replaces the.jsgenerator),src/components/HeadSEO.astro.Type of change
feat)fix) — typo, broken link, wrong informationdocs) — rewrite, expansion, upkeepi18n)refactor/chore) — reviewed by UXE, no content mixed inAuthor checklist
type(scope): summary(see GOVERNANCE.md §4)title,description,meta_tags,namespace,permalink,last_reviewed— no page frontmatter changedpt-brupdated in this PR or follow-upi18nissue created: every generated file has its Portuguese editionpnpm build:local(build + frontmatter check) without errors