Skip to content

AI & LLM endpoints

How this documentation is made consumable by LLMs and AI agents — indexes, Markdown twins, metadata, and per-page actions.

Updated View as Markdown

This site is built to be consumed by LLMs and coding agents, not just humans. Nimbus generates its agent-facing surface alongside the static documentation at build time.

Site and section indexes

Following the llms.txt standard, the site publishes:

  • /llms.txt — the overview index. It links to standalone pages and to the more focused section indexes.
  • /llms-full.txt — the complete documentation corpus in one Markdown document, ready to place in a model’s context.
  • /<section>/llms.txt — an index for one documentation section. For example, /guides/llms.txt lists the guide pages without requiring an agent to scan the whole site.

Point an assistant at /llms.txt when it should discover only the material it needs, or at /llms-full.txt when the full corpus fits its context window.

Per-page Markdown and MDX twins

Every documentation page is published in two agent-readable forms under its page directory:

  • /<page>/index.md — clean Markdown with Nimbus components downleveled for readers that do not process MDX.
  • /<page>/index.mdx — the authored MDX source, preserving component tags and other source-level structure.

For example, the Configuration guide is available as /guides/configuration/index.md and /guides/configuration/index.mdx.

Use the Markdown twin for ingestion and copying. Use the MDX twin when an agent needs to inspect how the page was authored.

Per-page actions

Every documentation page displays these actions under its title:

  • Copy page — fetches the clean Markdown twin and copies it to the clipboard.
  • View as Markdown — opens that Markdown twin directly.

Nimbus does not add provider-specific “Open in ChatGPT” or “Open in Claude” actions. Agents can instead follow the page’s Markdown alternate or start from /llms.txt.

Discovery and metadata

The static build also publishes the conventional discovery and structured-data surface:

  • Per-page Open Graph images at /og/<page>.png, plus the site-level /og.png image.
  • JSON-LD metadata embedded in each documentation page.
  • /sitemap-index.xml for search engines and crawlers.
  • /robots.txt with the sitemap location.
Navigation

Type to search…

↑↓ navigate↵ selectEsc close