22 lines
1.1 KiB
Markdown
22 lines
1.1 KiB
Markdown
# Project Bible
|
|
|
|
The Bible is the single source of truth for this project's architecture.
|
|
|
|
## Documentation Rules
|
|
|
|
- All architecture decisions must be recorded in this Bible.
|
|
- The documentation language is English only.
|
|
- If a decision is superseded, update the Bible immediately and remove or mark obsolete content.
|
|
- Do not duplicate architecture documentation in `README.md`, `claude.md`, or other files.
|
|
|
|
## Structure
|
|
|
|
- `governance/documentation-policy.md` - mandatory rules for maintaining architecture docs.
|
|
- `architecture/system-overview.md` - current scope, boundaries, and high-level system composition.
|
|
- `architecture/api-surface.md` - HTTP API and UI route contracts.
|
|
- `architecture/runtime-flows.md` - ingest, timeline, status, and failure invariants.
|
|
- `architecture/ui-information-architecture.md` - required UI structure and semantics.
|
|
- `architecture/data-model.md` - domain language, core tables, and migration boundaries.
|
|
- `docs/` - migrated operational and implementation documentation (formerly `/docs`).
|
|
- `decisions/README.md` - how to capture new and updated architecture decisions.
|