# Docs

This directory is the system-of-record for durable project knowledge.

## Quick Links

| Category | Index | Type | Purpose |
|----------|-------|------|---------|
| **Guides** | [guides/README.md](guides/README.md) | how-to | Practical step-by-step procedures |
| **Design** | [design-docs/index.md](design-docs/index.md) | explanation | Feature design, ADRs, decision rationale |
| **ADR Template** | [design-docs/decisions/0001-template.md](design-docs/decisions/0001-template.md) | reference | Decision record template |
| **References** | [references/README.md](references/README.md) | reference | External docs for agent context |

## System Docs

- Architecture: [ARCHITECTURE.md](ARCHITECTURE.md)
- Operations: [RUNBOOK.md](RUNBOOK.md)

## Directory Structure

```
docs/
├── README.md                    # This file (index)
├── ARCHITECTURE.md              # System design overview [reference]
├── RUNBOOK.md                   # Operations guide [how-to]
├── guides/                      # How-to guides [how-to]
│   └── README.md                # Guide index
├── design-docs/                 # Decision rationale [explanation]
│   ├── index.md                 # Design docs catalogue
│   └── decisions/               # Architectural Decision Records
└── references/                  # External docs [reference]
    └── README.md                # External docs for agent context
```

## Adding Documentation

| If you need... | Create in... | Type |
|----------------|--------------|------|
| Step-by-step procedure | `docs/guides/<topic>.md` | how-to |
| Design for a feature | `docs/design-docs/<feature>.md` | explanation |
| External library docs | `docs/references/<library>-llms.txt` | reference |