chore: condense all docs and markdown files
This commit is contained in:
+18
-31
@@ -1,36 +1,23 @@
|
||||
# Documentation Index
|
||||
# Docs Index
|
||||
|
||||
This directory is the source of truth for product, engineering, and ops documentation. Keep it current as features change.
|
||||
Use this file first.
|
||||
|
||||
## Start Here
|
||||
- Repo setup: `README.md`
|
||||
- Agent rules: `AGENTS.md`
|
||||
- Plan rules + active plan: `docs/PLANS.md`
|
||||
- Active ExecPlan: `docs/execplans/auth-phone-first-hardening.md`
|
||||
- Architecture: `docs/architecture.md`
|
||||
- Risks: `docs/risks.md`
|
||||
|
||||
- Project overview and setup: `README.md` (repo root)
|
||||
- Architecture overview: `docs/architecture.md`
|
||||
- Active ExecPlan: `docs/execplans/booking-notifications.md`
|
||||
- Known risks and gaps: `docs/risks.md`
|
||||
## Map
|
||||
- `docs/execplans/`: feature execution plans (living docs)
|
||||
- `docs/adr/`: architecture decisions
|
||||
- `docs/runbooks/`: operational response guides
|
||||
- `docs/templates/`: ADR/runbook templates
|
||||
|
||||
## Documentation Standards
|
||||
|
||||
See `docs/documentation.md` for documentation goals, update triggers, and templates.
|
||||
|
||||
## Docs Map
|
||||
|
||||
- `docs/architecture.md`: System architecture, boundaries, and MVP async/observability decision.
|
||||
- `docs/adr/`: Architecture Decision Records (ADRs). New cross-cutting decisions must land here.
|
||||
- `docs/execplans/`: Execution plans for significant features or refactors.
|
||||
- `docs/runbooks/`: Operational runbooks and production checklists.
|
||||
- `docs/risks.md`: Tracked risks and gaps.
|
||||
- `docs/templates/`: Reusable templates (ADR, runbook).
|
||||
|
||||
## Update Triggers (Quick Reference)
|
||||
|
||||
- New external dependency, provider, or major flow: add an ADR in `docs/adr/`.
|
||||
- Change to booking/payment/auth logic: update `docs/architecture.md` and relevant runbook(s).
|
||||
- New operational procedure: add a runbook in `docs/runbooks/`.
|
||||
- Close or add a significant risk: update `docs/risks.md`.
|
||||
|
||||
## Ownership And Review
|
||||
|
||||
- Authors own freshness: if you touch an area, update the docs in the same PR.
|
||||
- New production flows require at least one runbook.
|
||||
- Avoid duplicating instructions; link to the single source of truth.
|
||||
## Update Rules (short)
|
||||
- Behavior/flow changes: update architecture + affected runbook.
|
||||
- Cross-cutting hard-to-reverse decision: add ADR.
|
||||
- Significant risk added/closed: update `docs/risks.md`.
|
||||
- Significant feature/refactor: update or add ExecPlan.
|
||||
|
||||
Reference in New Issue
Block a user