Skip to content

Add llms.txt file #360

@gkorland

Description

@gkorland
  • Add an llms.txt file
    Create a /llms.txt file at your site root that summarizes your documentation structure for AI tools. This is the single most impactful thing you can do for AI readability.

  • Fix your llms.txt format
    Your llms.txt should have an H1 title, a blockquote description, H2 sections, and list items with links. Follow the llmstxt.org specification.

  • Add descriptions to your links
    Each link in your llms.txt should include a colon-separated description, e.g., '- Auth: How to authenticate with API keys'. This helps AI understand what each page covers without loading it.

  • Add an Optional section
    Add a '## Optional' section to your llms.txt for secondary content like changelogs and migration guides. This helps AI prioritize what to read within its context window.

  • Add a clear product description
    Your llms.txt blockquote should clearly describe what your product does in 10+ words. Don't make AI guess — be explicit.

  • List key constraints and requirements
    Add notes about authentication requirements, rate limits, prerequisites, and version compatibility in the opening section of your llms.txt.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions