Write an /llms.txt for this repo following the llms.txt v2 spec (https://llmstxt.org/). Agents read it to find the right page fast, so keep it small and precise, and point every link at clean markdown.
Steps
- Read the repo: README, docs, config, routes, and the deploy setup. Work out what the project is, where it is served from, and which path the file should cover (
/llms.txt at the root, or /docs/llms.txt if only the docs are served). A file covers everything under its path.
- Pick the pages an agent actually needs: quick start, core concepts, API or CLI reference, key guides, examples, and policies. Skip marketing pages, changelogs, legal boilerplate, and duplicates.
- Link LLM-friendly URLs. Use the same URL with
.md appended (page.html.md) or with the extension swapped (page.md), and index.md / index.html.md for bare paths. If no markdown version exists, link the cleanest source available (raw markdown in the repo) and note it under the output.
- Write the file in exactly this order:
# {{Name}}: the H1, the only required section.
> a one- or two-sentence blockquote summary with the key facts needed to understand the rest.
- Optional plain paragraphs or lists (no headings) for important notes: what the project is not, compatibility gotchas, naming, and version.
## Section file lists (Docs, API, Examples, and so on). Each item is - [Title](url): one-line note on what's there and when to read it.
## Optional last, for secondary links an agent can skip when context is short.
- Keep it tight. Use plain language with no unexplained jargon and no headings other than the H1 and H2s. The file should fit comfortably in context; the detail lives behind the links.
- Save it where the site will serve it at that path (for example
public/llms.txt).
Self-check
- The structure parses: H1, blockquote, non-heading notes, H2 file lists, with
## Optional last.
- Every link resolves and points to markdown where possible. No dead links and no tracking params.
- Answer five realistic questions an agent would ask about this project using only the llms.txt and its links. If any answer is hard to find, fix the file.
Output
- The file, written to the repo, and its path.
- A short list of pages that still need a
.md version.
- Optional serving notes: the
Link: <…/page.md>; rel="alternate"; type="text/markdown", <…/llms.txt>; rel="describedby" header or the matching <link> tags.