• Review the official specification at https://llmstxt.org/ to ensure full compliance
• Understand the required format structure and guidelines
• Note the specific markdown structure requirements

• Examine the complete repository structure using appropriate tools
• Identify the primary purpose and scope of the repository
• Catalog all important directories and their purposes
• List key files that would be valuable for LLM understanding

• Identify README files and their locations
• Find documentation files (

  .md

  files in

  /docs/

  ,

  /spec/

  , etc.)
• Locate specification files and their purposes
• Discover configuration files and their relevance
• Find example files and code samples
• Identify any existing documentation structure

• Repository purpose and scope summary
• Priority-ordered list of essential files for LLM understanding
• Secondary files that provide additional context
• Organizational structure for the llms.txt file

llms.txt

1. H1 Header: Single line with repository/project name (required)
2. Blockquote Summary: Brief description in blockquote format (optional but recommended)
3. Additional Details: Zero or more markdown sections without headings for context
4. File List Sections: Zero or more H2 sections containing markdown lists of links

• Project Name: Clear, descriptive title as H1
• Summary: Concise blockquote explaining the repository's purpose
• Key Files: Essential files organized by category (H2 sections)

• Documentation: Core documentation files
• Specifications: Technical specifications and requirements
• Examples: Sample code and usage examples
• Configuration: Setup and configuration files
• Optional: Secondary files (special meaning - can be skipped for shorter context)

• Use concise, clear, unambiguous language
• Avoid jargon without explanation
• Write for both human and LLM readers
• Be specific and informative in descriptions

• Explain the repository's purpose and scope
• Provide essential technical documentation
• Show usage examples and patterns
• Define interfaces and specifications
• Contain configuration and setup instructions

• Are purely implementation details
• Contain redundant information
• Are build artifacts or generated content
• Are not relevant to understanding the project

1. Examine the repository structure completely
2. Read the main README.md to understand the project
3. Identify all documentation directories and files
4. Catalog specification files and their purposes
5. Find example files and configuration files

1. Determine the primary purpose statement
2. Write a concise summary for the blockquote
3. Group identified files into logical categories
4. Prioritize files by importance for LLM understanding
5. Create descriptions for each file link

1. Create the

   llms.txt

   file in the repository root
2. Follow the exact format specification
3. Include all required sections
4. Use proper markdown formatting
5. Ensure all links are valid relative paths

1. Verify compliance with https://llmstxt.org/ specification
2. Check that all links are valid and accessible
3. Ensure the file serves as an effective LLM navigation tool
4. Confirm the file is both human and machine readable

• ✅ H1 header with project name
• ✅ Blockquote summary (if included)
• ✅ H2 sections for file lists
• ✅ Proper markdown link format
• ✅ No broken or invalid links
• ✅ Consistent formatting throughout

• ✅ Clear, unambiguous language
• ✅ Comprehensive coverage of essential files
• ✅ Logical organization of content
• ✅ Appropriate file descriptions
• ✅ Serves as effective LLM navigation tool

• ✅ Follows https://llmstxt.org/ format exactly
• ✅ Uses required markdown structure
• ✅ Implements optional sections appropriately
• ✅ File located at repository root (

  /llms.txt

  )

[Concise description of the repository's purpose and scope]

• Main README: Primary project documentation and getting started guide
• Contributing Guide: Guidelines for contributing to the project
• Code of Conduct: Community guidelines and expectations

• Technical Specification: Detailed technical requirements and constraints
• API Specification: Interface definitions and data contracts

• Basic Example: Simple usage demonstration
• Advanced Example: Complex implementation patterns

• Setup Guide: Installation and configuration instructions
• Deployment Guide: Production deployment guidelines

• Architecture Documentation: Detailed system architecture
• Design Decisions: Historical design decision records

undefined

llms.txt

1. Enable LLMs to quickly understand the repository's purpose
2. Provide clear navigation to essential documentation
3. Follow the official llms.txt specification exactly
4. Be comprehensive yet concise
5. Serve both human and machine readers effectively
6. Include all critical files for project understanding
7. Use clear, unambiguous language throughout
8. Organize content logically for easy consumption