API docs/tutorial/reference/example grouping
Docs LLMs.txt Generator
Turn nested documentation into a concise guide that points to quickstarts, references, tutorials, and examples.
LLMs.txt is an emerging proposed standard. Use this workflow as a practical guide, not as a ranking guarantee.
Workflow
Practical checks
Include quickstartReview before publishing.
Include API referenceReview before publishing.
Include tutorialsReview before publishing.
- Include examples
- Include changelog if useful
- Exclude duplicate version pages
Implementation note
Keep the file curated.
Start with the pages that explain the product, service, documentation, policies, and examples. Exclude login pages, carts, search results, tag archives, duplicate pages, private URLs, and other low-value resources. Validate the file, then place it at your domain root as /llms.txt.
Common states to handle
Invalid or private URL
Block localhost, private networks, metadata endpoints, and non-http protocols.
Blocked by robots.txt
Respect robots rules and allow manual URL input when crawling is restricted.
Download success
Copy or download the file, then verify the public root path.