Specifications
For AI agents: a documentation index is available at /llms.txt — markdown
versions of all pages are available by appending index.md to any URL path.
Agent-friendly documentation has more than one surface. This page is the home for the specification family; each spec covers one surface and versions independently.
Available now #
- Web Documentation Delivery Spec:
28 checks across 7 categories evaluating whether coding agents can
discover, fetch, and receive a documentation site’s content intact.
Covers llms.txt discovery, markdown availability, page size and
truncation risk, content structure, URL stability, observability, and
authentication/access. This spec was formerly served in full at this
URL; it now lives at
/spec/web/, split into per-category pages so that each page fits comfortably within agent fetch limits (its own recommendation, applied to itself).
Planned #
Companion specifications will be added here as the evidence base for them matures (see Related Surfaces in the web delivery spec):
- Content composition: what documentation should contain to serve agents well: factual consistency across pages, structure and density suited to machine consumption.
- Repository-local documentation: docs serving coding agents that work inside a repository, where discovery happens through grep and file listings rather than HTTP.
Implementation #
afdocs is the reference
implementation of the web delivery spec: npx afdocs check <url> tests a
documentation site against it.
