Using LLMs
These docs are LLM-friendly. Every page is published in plain Markdown and the
whole site is aggregated into llms.txt context files,
so you can feed the documentation to AI assistants like ChatGPT, Claude, Cursor,
or GitHub Copilot and get accurate, up-to-date answers about the Grunt protocol.
Endpoints
Section titled “Endpoints”The following files are generated automatically at build time and stay in sync with the docs you are reading:
| Endpoint | Description |
|---|---|
/llms.txt |
An index of the documentation following the llms.txt standard: the project description plus a link to the Markdown version of every page. Best for tools that fetch linked pages on demand. |
/llms-full.txt |
The entire documentation concatenated into a single Markdown file. Best when you want to give a model the full context in one paste. |
/llms-small.txt |
A compressed version of the full docs with non-essential markup stripped out, sized for models with smaller context windows. |
You can also append .md to any page URL (for example
/protocol/overview.md) to get the raw Markdown source
of a single page. This is the same Markdown that the Copy as Markdown button
at the top of each page copies.
Using the docs with AI tools
Section titled “Using the docs with AI tools”Chat assistants (ChatGPT, Claude, etc.)
Section titled “Chat assistants (ChatGPT, Claude, etc.)”Use the Open in ChatGPT or Open in Claude buttons at the top of any page
to start a conversation pre-seeded with that page as context. To work from the
whole site instead, paste the URL of llms-full.txt into the chat, or download
it and attach it as a file, then ask your question:
Read https://docs.3f.xyz/llms-full.txt and explain how the Position Managerrebalances a borrow position.If the documentation is larger than the model’s context window, use
llms-small.txt instead, or share the more specific llms.txt index and let the
assistant follow the links it needs.
Code editors (Cursor, Copilot, Windsurf, etc.)
Section titled “Code editors (Cursor, Copilot, Windsurf, etc.)”Most AI-enabled editors let you add external documentation as context. Point them
at the llms-full.txt endpoint so the protocol docs are available while you
write integration code:
- Cursor — add
https://docs.3f.xyz/llms-full.txtunder Settings → Indexing & Docs → Add new doc, then reference it with@Docsin chat. - Other editors — provide the same URL wherever the tool accepts custom documentation sources.
Per-page Markdown
Section titled “Per-page Markdown”When you only need context for a single topic, link the model directly to that
page’s Markdown by appending .md to its URL. This keeps the context small and
focused on the contract or flow you are working on.
How it works
Section titled “How it works”The endpoints are generated by the
starlight-llms-txt plugin,
which crawls the Starlight content collection on each build and renders the
llms.txt, llms-full.txt, and llms-small.txt files from the same Markdown
that powers the human-readable site. There is nothing to maintain by hand — new
and updated pages are picked up automatically.