Skip to content

docs: improve agentdocsspec compliance#451

Merged
raymondk merged 4 commits intomainfrom
docs/improve-agentdocsspec-compliance
Mar 19, 2026
Merged

docs: improve agentdocsspec compliance#451
raymondk merged 4 commits intomainfrom
docs/improve-agentdocsspec-compliance

Conversation

@marc0olo
Copy link
Member

Summary

Addresses issues flagged by npx afdocs check:

  • cache-header-hygiene: Add Cache-Control: public, max-age=300 for .md and .txt files (previously had no cache headers)
  • llms-txt-directive: Move agent signaling from the rehype content area (buried past 50%) to the Banner component (top of <main>) and a <link rel="help"> in <head>
  • llms.txt title: Include version in the title for versioned builds (e.g., "ICP CLI Documentation (v0.2)")
  • skills registry: Add IC skills discovery endpoint to llms.txt so agents can find and install specialized skills

Not addressed

The agentdocsspec checker flagged missing cache headers on .md and .txt
files. Add Cache-Control: public, max-age=300 to match the HTML pages.
The agentdocsspec checker flagged the llms.txt directive as "buried deep
(past 50%)" because the rehype plugin injected it into the Starlight
content area, after the header, nav, and sidebar.

Move the directive to the Banner component (top of <main>) and add a
<link rel="help"> in <head>. Remove the now-unused rehype plugin.
When built with a versioned base path (e.g. /0.2/), the llms.txt title
now reads "ICP CLI Documentation (v0.2)" instead of the generic title.
Point agents to the skills discovery endpoint so they can find
and install specialized IC development skills (icp-cli, canister
security, ICRC ledger, etc.) alongside the documentation.
@marc0olo marc0olo requested a review from a team as a code owner March 19, 2026 20:02
@marc0olo marc0olo changed the title fix(docs): improve agentdocsspec compliance docs: improve agentdocsspec compliance Mar 19, 2026
@raymondk raymondk merged commit eb31bd9 into main Mar 19, 2026
94 checks passed
@raymondk raymondk deleted the docs/improve-agentdocsspec-compliance branch March 19, 2026 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants