llms

Deep Wiki: Generate llms.txt

You are generating llms.txt and llms-full.txt files that provide LLM-friendly access to the wiki documentation. These follow the llms.txt specification.

Source Repository Resolution (MUST DO FIRST)

Before generating, resolve the source repository context:

1. Check for git remote: Run git remote get-url origin
2. Ask the user: "Is this a local-only repository, or do you have a source repository URL?"
   • Remote URL → store as REPO_URL, use linked references: [Title](REPO_URL/blob/BRANCH/path)
   • Local → use relative paths to wiki files
3. Determine default branch: Run git rev-parse --abbrev-ref HEAD
4. Do NOT proceed until resolved

What is llms.txt

llms.txt is a standardized markdown file that helps LLMs quickly understand a project. It provides:

• A concise project summary
• Links to key documentation files with brief descriptions
• Structured sections (Onboarding, Architecture, API, etc.)

Two files are generated:

File	Purpose	Size
llms.txt	Links + brief descriptions — fits in small context windows	Small (1-5 KB)
llms-full.txt	Full inlined content of all linked pages	Large (50-500 KB)

Step 1: Gather Project Context

Scan the repository and existing wiki (if generated) to collect:

1. Project identity — name, one-sentence description, primary language, key technologies
2. Wiki pages — scan wiki/ directory for all generated .md files
3. Onboarding guides — check for onboarding/ folder with audience-tailored guides
4. README — extract the core project description
5. Key entry points — main files, API surface, configuration

Step 2: Generate llms.txt

Create wiki/llms.txt following the llms.txt spec format:

# {Project Name}

> {One-paragraph summary: what it does, who it's for, key technologies. Dense and informative.}

{2-3 paragraphs of important context: architectural philosophy, key constraints, what makes this project different. Include things an LLM needs to know to give accurate answers about this project.}

## Onboarding

- [{Contributor Guide}](./onboarding/contributor-guide.md): Step-by-step guide for new contributors — environment setup, first task, testing, and coding conventions
- [{Staff Engineer Guide}](./onboarding/staff-engineer-guide.md): Architectural deep-dive for senior engineers — design decisions, domain model, component types, and failure modes
- [{Executive Guide}](./onboarding/executive-guide.md): Capability overview for engineering leaders — risk assessment, technology investment, and scaling model
- [{Product Manager Guide}](./onboarding/product-manager-guide.md): Feature-focused guide for PMs — user journeys, capabilities, limitations, and data/privacy

## Architecture

- [{Architecture Overview}](./02-architecture/overview.md): System architecture, component boundaries, and deployment topology
- [{Data Model}](./02-architecture/data-model.md): Core entities, relationships, and data invariants
- [{API Reference}](./02-architecture/api-reference.md): Endpoints, authentication, and wire format

## Getting Started

- [{Setup Guide}](./01-getting-started/setup.md): Prerequisites, installation, and first run
- [{Configuration}](./01-getting-started/configuration.md): Environment variables, feature flags, and config files

## Deep Dive

- [{Component Name}](./03-deep-dive/component.md): Description of component purpose and scope
- ...additional pages...

## Optional

- [{Changelog}](./changelog.md): Recent changes and version history
- [{Contributing}](./contributing.md): How to contribute to the project