Agent Ready HTML

ReadMe: what an agent reads

In short

ReadMe does not promise that an agent will request llms.txt. ReadMe totals 13 of 16 on the eight numeric keys, from cited documentation read 4 November 2026. It also does not keep a custom llms.txt in sync with content changes.

rubric.txt readme

initial_html_by_default  = 2
real_status_codes        = 2
llms_txt_generation      = 2
llms_txt_linking         = 2
markdown_negotiation     = 1
jsonld_output            = 0
openapi_exposure         = 2
fenced_code              = 2
total                    = 13 of 16

Read 2026-11-04. Documentation, not a test build.

ReadMe Docs platform, ReadMe

API docs platform with llms.txt on by default, markdown pages with agentTools front matter, markdown 404s, and an AI Discoverability panel graded against the AFDocs spec.

Work left to the developer: Low: review the AI Discoverability toggles; a custom llms.txt stops automatic updates.

The nine scores

KeyScoreEvidenceSource
Content in the initial HTML2, on by defaultHub pages render content server-side; markdown versions exist for every page. Not test-built: a ReadMe project needs an account and a paid plan for the AI features. Score from the documentation page cited, read 2026-11-04.docs.readme.com/main/docs/ai-discoverability, 2026-11-04
Real status codes2, on by defaultMarkdown 404s return a 404 with recovery links. Not test-built: a ReadMe project needs an account and a paid plan for the AI features. Score from the documentation page cited, read 2026-11-04.docs.readme.com/main/docs/llmstxt, 2026-11-04
llms.txt generation2, on by defaultOn by default for all projects. Not test-built: a ReadMe project needs an account and a paid plan for the AI features. Score from the documentation page cited, read 2026-11-04.docs.readme.com/main/docs/llmstxt, 2026-11-04
llms.txt linking2, on by defaultMarkdown pages carry agentTools front matter pointing at llms.txt, and link headers are a documented setting. Not test-built: a ReadMe project needs an account and a paid plan for the AI features. Score from the documentation page cited, read 2026-11-04.docs.readme.com/main/docs/ai-discoverability, 2026-11-04
Markdown on request1, with setupMarkdown for Agents is a documented setting under AI Discoverability; defaults vary by setting. Not test-built: a ReadMe project needs an account and a paid plan for the AI features. Score from the documentation page cited, read 2026-11-04.docs.readme.com/main/docs/ai-discoverability, 2026-11-04
JSON-LD output0, not offeredNot documented on the pages read. Not test-built: a ReadMe project needs an account and a paid plan for the AI features. Score from the documentation page cited, read 2026-11-04.docs.readme.com/main/docs/ai-discoverability, 2026-11-04
OpenAPI exposure2, on by defaultMarkdown for API Reference intro pages includes servers and security schemes when the OpenAPI definition is visible. Not test-built: a ReadMe project needs an account and a paid plan for the AI features. Score from the documentation page cited, read 2026-11-04.docs.readme.com/main/changelog/upgraded-llms-txt, 2026-11-04
Fenced, tagged code2, on by defaultMarkdown output keeps code samples as fenced blocks. Not test-built: a ReadMe project needs an account and a paid plan for the AI features. Score from the documentation page cited, read 2026-11-04.docs.readme.com/main/changelog/upgraded-llms-txt, 2026-11-04
Work left to the developerLow: review the AI Discoverability toggles; a custom llms.txt stops automatic updates. Custom files stop auto-updates. Not test-built: a ReadMe project needs an account and a paid plan for the AI features. Score from the documentation page cited, read 2026-11-04.docs.readme.com/main/docs/llmstxt, 2026-11-04

Test build

Not test-built: the scores above come from the documentation pages cited in each row, read 4 November 2026, because the platform needs an account or a paid plan. The reason is in each evidence cell.

What the documentation says

Each statement below carries its source and the date read. Statements a vendor makes about itself are labelled as vendor claims.

  • LLMs.txt is enabled on all ReadMe projects by default and is regenerated whenever the docs change. [primary source] source, read 4 November 2026.
  • A custom llms.txt can be committed at the repo root or a section root; once used, automatic updates stop until it is disabled. [primary source] source, read 4 November 2026.
  • With LLMs.txt on, a request for a missing .md page returns a markdown 404 with agentTools front matter pointing to llms.txt and a search URL. [primary source] source, read 4 November 2026.
  • ReadMe tells customers that whether an agent requests the file is up to the agent, and calls llms.txt control over what an agent finds when it looks rather than a guarantee. [primary source] source, read 4 November 2026.
  • The AI Discoverability panel crawls a sample of published pages and scores the project against the Agent-Friendly Docs spec. [primary source] source, read 4 November 2026.
  • The upgraded llms.txt groups pages under sidebar categories, offers a Summarize Index option that links per-section files, and redirects guessed URLs such as /docs.md to the matching llms.txt. [primary source] source, read 4 November 2026.
  • On 2026-11-04 readme.com answered Accept: text/markdown on its home page with a 307 redirect to a text/plain response. [primary source] source, read 4 November 2026.

What it does not do

  • Does not promise that an agent will request llms.txt.
  • Does not keep a custom llms.txt in sync with content changes.

Compare and replace

Sources

  1. ReadMe docs: LLMs.txt https://docs.readme.com/main/docs/llmstxt, read 4 November 2026
  2. ReadMe docs: AI Discoverability https://docs.readme.com/main/docs/ai-discoverability, read 4 November 2026
  3. ReadMe changelog: Upgraded LLMs.txt https://docs.readme.com/main/changelog/upgraded-llms-txt, read 4 November 2026
  4. readme.com https://readme.com/, read 4 November 2026

Last reviewed 4 November 2026