|
| 1 | +# Documentation Index |
| 2 | + |
| 3 | +A map of the Kiwi documentation tree and a suggested reading order. If you are not |
| 4 | +sure where to start, follow the **Newcomer** path below. |
| 5 | + |
| 6 | +## Top-level entry points |
| 7 | + |
| 8 | +| Document | Audience | What it covers | |
| 9 | +|----------|----------|----------------| |
| 10 | +| [`README.md`](../README.md) / [`README_CN.md`](../README_CN.md) | Everyone | Project intro, features, quickstart, toolchain, and documentation entry points | |
| 11 | +| [`CLAUDE.md`](../CLAUDE.md) (a.k.a. `AGENTS.md`) | Contributors / AI agents | Dev commands, crate layout, code style, behavioral guidelines | |
| 12 | +| [`CONTRIBUTING.md`](../CONTRIBUTING.md) | Contributors | How to contribute | |
| 13 | +| [`CHANGELOG.md`](../CHANGELOG.md) | Everyone | Notable changes (history) | |
| 14 | + |
| 15 | +## Planning & requirements (source of truth for roadmap) |
| 16 | + |
| 17 | +The `.planning/` directory holds the north star, requirements, milestones, current |
| 18 | +state, and Kanban. These files are referenced from the README and the PRD and are |
| 19 | +the authoritative tracking surface: |
| 20 | + |
| 21 | +- `.planning/PROJECT.md` — constitution / north star |
| 22 | +- `.planning/REQUIREMENTS.md` — acceptance requirements (`REQ-*`) |
| 23 | +- `.planning/ROADMAP.md` — milestones (`M0`–`M10`) |
| 24 | +- `.planning/STATE.md` — current state |
| 25 | +- `.planning/KANBAN.md` — work board |
| 26 | +- `.planning/DECISIONS.md` / `.planning/OPEN_QUESTIONS.md` / `.planning/REFERENCES.md` |
| 27 | + |
| 28 | +## Developer docs |
| 29 | + |
| 30 | +| Document | What it covers | |
| 31 | +|----------|----------------| |
| 32 | +| [`docs/development.md`](development.md) | Dev environment, build optimization, sccache, lint rules, testing (incl. Python integration) | |
| 33 | +| [`docs/cluster.md`](cluster.md) | Raft cluster quickstart and write-path verification | |
| 34 | +| [`docs/key-encoding.md`](key-encoding.md) | Key/value encoding internals (Chinese, with diagrams) | |
| 35 | + |
| 36 | +## Product & compatibility |
| 37 | + |
| 38 | +| Document | What it covers | |
| 39 | +|----------|----------------| |
| 40 | +| [`docs/prd.md`](prd.md) | Product requirements; goals, scope, Redis 8.8.1 compatibility target | |
| 41 | +| [`docs/personas-and-user-stories.md`](personas-and-user-stories.md) | Target users and usage scenarios | |
| 42 | +| [`docs/compatibility/redis-8.8.1.md`](compatibility/redis-8.8.1.md) | Exact Oracle, raw RESP, TCL, and client-test boundaries | |
| 43 | +| [`docs/compatibility/redisraft-public-profile.md`](compatibility/redisraft-public-profile.md) | RedisRaft public compatibility profile | |
| 44 | + |
| 45 | +## Architecture |
| 46 | + |
| 47 | +| Document | What it covers | |
| 48 | +|----------|----------------| |
| 49 | +| [`docs/architecture/redis-8.8.1-system-boundaries.md`](architecture/redis-8.8.1-system-boundaries.md) | Cache OFF request, storage, and consensus boundaries | |
| 50 | +| [`docs/architecture/redis-hot-tier-native-abi.md`](architecture/redis-hot-tier-native-abi.md) | Deferred native ABI contract (future design, not an implementation authorization) | |
| 51 | +| [`docs/architecture/combined-distribution-licensing.md`](architecture/combined-distribution-licensing.md) | Future Redis-derived library and source-distribution licensing obligations | |
| 52 | + |
| 53 | +## Quality & stability |
| 54 | + |
| 55 | +| Document | What it covers | |
| 56 | +|----------|----------------| |
| 57 | +| [`docs/quality/system-stability-gate.md`](quality/system-stability-gate.md) | Required evidence (G1–G7) before deferred hot-tier work is reconsidered | |
| 58 | +| [`docs/quality/quality-gates.md`](quality/quality-gates.md) | Code, test, and release quality gates | |
| 59 | +| [`docs/performance/storage-runtime-baseline.md`](performance/storage-runtime-baseline.md) | Storage-runtime performance baseline | |
| 60 | + |
| 61 | +## Design history (`docs/superpowers/`) |
| 62 | + |
| 63 | +`docs/superpowers/plans/` and `docs/superpowers/specs/` contain **dated design |
| 64 | +records** (filename prefix `YYYY-MM-DD-`). They are historical decision logs, not |
| 65 | +a second roadmap. Follow related specs and plans by topic and by their explicit |
| 66 | +cross-references; dates do not define a one-to-one pairing. For the current |
| 67 | +authoritative plan, prefer `.planning/ROADMAP.md` and the gate documents above. |
| 68 | + |
| 69 | +## Suggested reading order |
| 70 | + |
| 71 | +- **Newcomer**: `README.md` → `docs/development.md` → `docs/cluster.md` → `docs/key-encoding.md` |
| 72 | +- **Contributor**: `CLAUDE.md` → `docs/development.md` → `docs/quality/quality-gates.md` |
| 73 | +- **Architecture / compatibility**: `docs/prd.md` → `docs/compatibility/redis-8.8.1.md` → `docs/architecture/redis-8.8.1-system-boundaries.md` |
| 74 | +- **Stability & quality**: `docs/quality/system-stability-gate.md` → `docs/quality/quality-gates.md` → `docs/performance/storage-runtime-baseline.md` |
| 75 | +- **Design history**: `docs/superpowers/plans/` + `docs/superpowers/specs/` (follow by topic and explicit cross-references) |
0 commit comments