File size: 1,785 Bytes
5dd1bb4 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 | # 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 |
|