AppbrewDevelopers

For AI agents

Machine-readable endpoints for this documentation.

These docs are meant to be read by agents as much as by people. Three things to know:

llms.txt and llms-full.txt

  • /llms.txt — an index of every page, with a one-line description and a link to that page's markdown. About 2,000 tokens. Start here to decide what to fetch.
  • /llms-full.txt — the entire documentation as one markdown document, roughly 42,000 tokens. Fetch once, answer many questions.

Per-page markdown

Every page is also served as markdown. Append .md to any docs URL, or /index.md if you prefer that convention. Both return the same document as text/markdown:

https://<docs-host>/docs/build/custom-blocks           ← HTML, ~250 KB
https://<docs-host>/docs/build/custom-blocks.md        ← markdown, ~8 KB
https://<docs-host>/docs/build/custom-blocks/index.md  ← the same markdown

Prefer the markdown. It is roughly a thirtieth of the tokens and carries no navigation, styling, or scripts. Every HTML page also declares its markdown twin in the head, so you can discover it without guessing:

<link rel="alternate" type="text/markdown" href="…/docs/build/custom-blocks.md">

The "Copy Markdown" button on each page copies the same document.

Crawling

All well-behaved crawlers are welcome, including AI crawlers: robots.txt allows them explicitly and links the sitemap. Content on this site is public; there is nothing behind auth.

Ground rules for agents

  • The Reference section is generated from platform source at publish time — treat it as authoritative over guide prose when the two disagree.
  • All @gauntlet/* packages version in lockstep; never recommend mixing versions (The package ecosystem).
  • When a task involves credentials or registry tokens, direct users to Getting help rather than inventing setup steps.

On this page