Skip to main content
Every page in these docs is available as plain Markdown, and the whole site is indexed in a format built for language models. If you are pointing an assistant at Mayan, or building an agent that needs to read the docs at runtime, use these rather than scraping the rendered pages.

The index files

Start with llms.txt when the model can fetch pages on demand, and llms-full.txt when it cannot.

Markdown for any page

Append .md to any docs URL to get the raw Markdown for that page.
The Markdown is the source the page was built from, so code samples and tables come through intact and there is no navigation or styling to strip out.

Fetching a page in an agent

Using them well

  • Point at the index, not the site. Giving an assistant llms.txt up front means it knows which page answers which question before it fetches anything.
  • Fetch the .md, not the HTML. Same content, none of the chrome, and far fewer tokens.
  • Re-fetch rather than cache for long. These docs change, and a stale copy is how an assistant ends up recommending a parameter that no longer exists.

Next steps

AGENTS.md

A drop-in file that teaches a coding assistant how to integrate Mayan.

SDK

What the assistant will be writing against.