AI-readable docs

Radiant publishes AI-readable files with every deployed docs site. These files help external AI assistants, developer tools, crawlers, and code editors read your docs from stable Markdown and text endpoints instead of scraping rendered HTML.

No setup is required. If your docs site is public, the AI-readable files are public too.

Published files

Each successful deployment can include these public files:

URLWhat it contains
/llms.txtA compact index of docs pages, page descriptions, Markdown page links, and OpenAPI specs
/llms-full.txtA larger combined context file with page content and local OpenAPI specs
/.well-known/llms.txtCompatibility alias for /llms.txt
/.well-known/llms-full.txtCompatibility alias for /llms-full.txt
/{page}.mdMarkdown version of an individual docs page
/open-api/{spec}.jsonPublished OpenAPI spec used by generated API reference pages

For example, a page available at /getting-started/quickstart is also available to tools at /getting-started/quickstart.md.

Markdown page versions

Radiant publishes a Markdown version of each routed docs page. For MDX pages, the Markdown version exposes the source content used to build the page, including frontmatter and supported Radiant components.

For generated OpenAPI endpoint pages, the Markdown version includes endpoint-specific content instead of the entire OpenAPI file:

  • Method and path.
  • Operation description.
  • Parameters.
  • Request body details.
  • Responses.
  • A link to the full OpenAPI spec.
  • A compact OpenAPI operation block with only the referenced schemas and security schemes needed for that endpoint.

Page descriptions

/llms.txt uses each page description to summarize what the page is about. Radiant resolves descriptions in this order:

  1. description in the page frontmatter.
  2. A generated fallback based on the page title and docs site title.

Use frontmatter descriptions on important pages when you want more specific summaries.

---title: Deploymentsdescription: Understand deployment triggers, status, and rollout behavior.---

OpenAPI specs

When your docs include generated API reference pages, Radiant links the full OpenAPI spec from /llms.txt and publishes local specs at their public paths. Endpoint Markdown pages link back to the full spec and include a focused operation slice for that endpoint.

Keep your OpenAPI descriptions, parameters, request bodies, responses, examples, and authentication details accurate. Those fields become part of the AI-readable output.

Custom llms files

Radiant generates /llms.txt and /llms-full.txt automatically. If you need full control, add either file at the docs root:

docs.jsonllms.txtllms-full.txtgetting-started/  quickstart.mdx

When present, the custom file is published instead of the generated version. Use this only when you need a hand-authored index or context file.

Common questions

No. Radiant publishes AI-readable docs files automatically during deployment.

No. AI-readable docs are part of the public docs output. Ask AI is a separate Radiant feature.

Not currently. Treat them as part of the public docs site, like HTML pages, images, and OpenAPI specs.

Add description to the page frontmatter. If no description is set, Radiant uses a generated fallback.