# AFDocs

> Test your documentation site against the Agent-Friendly Documentation Spec. AFDocs runs 23 checks across 7 categories to measure how well AI coding agents can discover, navigate, and consume your docs.

## The Score

- [What Is the Agent Score?](https://afdocs.dev/what-is-agent-score.md)
- [Why Agent-Friendliness Matters](https://afdocs.dev/why-agent-friendliness-matters.md)
- [Score Calculation](https://afdocs.dev/agent-score-calculation.md)
- [Interaction Diagnostics](https://afdocs.dev/interaction-diagnostics.md)

## Get Started

- [Quick Start](https://afdocs.dev/quick-start.md)
- [Run Locally](https://afdocs.dev/run-locally.md)
- [Improve Your Score](https://afdocs.dev/improve-your-score.md)
- [CI Integration](https://afdocs.dev/ci-integration.md)

## Checks Reference

- [Checks Overview](https://afdocs.dev/checks/index.md)
- [Content Discoverability](https://afdocs.dev/checks/content-discoverability.md): llms.txt existence, validity, size, link resolution, markdown links, directive
- [Markdown Availability](https://afdocs.dev/checks/markdown-availability.md): .md URL support, content negotiation
- [Page Size](https://afdocs.dev/checks/page-size.md): rendering strategy, HTML/markdown size, content start position
- [Content Structure](https://afdocs.dev/checks/content-structure.md): tabbed content serialization, header quality, code fence validity
- [URL Stability](https://afdocs.dev/checks/url-stability.md): HTTP status codes, redirect behavior
- [Observability](https://afdocs.dev/checks/observability.md): llms.txt coverage, markdown content parity, cache headers
- [Authentication](https://afdocs.dev/checks/authentication.md): auth gate detection, alternative access paths

## API Reference

- [API Reference Overview](https://afdocs.dev/reference/index.md)
- [CLI Reference](https://afdocs.dev/reference/cli.md): flags, output formats, sampling strategies
- [Programmatic API](https://afdocs.dev/reference/programmatic-api.md): TypeScript API for running checks
- [Scoring API](https://afdocs.dev/reference/scoring-api.md): computing scores from check results
- [Config File](https://afdocs.dev/reference/config-file.md): agent-docs.config.yml format and options

## Migration

- [Migrating to v0.17.0](https://afdocs.dev/migration/v0.17.0.md)

## About

- [About AFDocs](https://afdocs.dev/about.md)
- [AFDocs Home](https://afdocs.dev/index.md)