first commit
This commit is contained in:
12
docs/README.md
Normal file
12
docs/README.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# /docs — cross-cutting docs
|
||||
|
||||
Anything affecting **both** client and api, plus planning and roadmap. Side-specific docs live in [`/api/docs`](../api/docs) and [`/client/docs`](../client/docs).
|
||||
|
||||
Put here:
|
||||
|
||||
- [`roadmap.md`](roadmap.md) — phases, POC scope, what's next
|
||||
- [`adr/`](adr/) — Architecture Decision Records
|
||||
- Shared contracts — canon log schema, tag syntax, retry policy (§11, §12)
|
||||
- Anything spanning the HTTP boundary
|
||||
|
||||
The charter itself — [`CLAUDE.md`](../CLAUDE.md) — stays at the repo root. It is the source of truth; these docs elaborate, they do not override it.
|
||||
Reference in New Issue
Block a user