fix(docs): improve agentdocsspec compliance#463
Merged
Conversation
- Move agent signaling blockquote from Banner component to post-build injection right after <body>, placing it at ~12% of the document instead of >50% (past nav/sidebar). Addresses the "buried deep" warning from the agentdocsspec checker. - Split the monolithic CLI reference (52K+ chars) into 63 per-command markdown endpoints under reference/cli/. Top-level commands are listed in llms.txt; subcommand files include linked navigation to siblings. Includes build-time validation for slug collisions, broken links, and format changes. - Copy sitemap-index.xml to sitemap.xml so the agentdocsspec freshness check can discover it at the conventional path. Move agentDocs() integration after starlight() to ensure sitemap exists when the hook runs.
raymondk
approved these changes
Mar 23, 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
<body>injection (~12% position vs >50%), addressing the "buried deep" checker warning.mdendpoints with linked subcommand navigation, so agents can fetch individual commands on demandsitemap-index.xml→sitemap.xmlfor agentdocsspec freshness check discovery