Ty
b42e3cb8ce
Phase 1 scaffold for the docs consolidation: - docs/STRUCTURE.md: artifact registry, 8 owner-job ID namespaces, routing and change rules - docs/REQUIREMENTS.md, docs/MILESTONES.md: normative schema, empty pending Phase 2 port - docs/_templates/: requirement-row, capability, contract, adr - docs/capabilities/, docs/contracts/: registered homes - tools/check_requirements.py: enforces registry, IDs, and traceability - AGENTS.md: coding paused banner + structure-contract routing rule - README.md: pointers to the structure/requirements/milestones set Additive only: no doc moves, no requirement text, no CI wiring yet.
17 lines
753 B
Markdown
17 lines
753 B
Markdown
# Contract docs
|
|
|
|
Cross-cutting interface detail shared by capabilities.
|
|
|
|
Rules (`docs/STRUCTURE.md`): a contract doc **cites** requirement IDs from `docs/REQUIREMENTS.md`; it never defines or restates them.
|
|
|
|
Expected files (Phase 2 migration):
|
|
|
|
- `API.md` — FastAPI HTTP contract (from tag `OPENAPI.md`)
|
|
- `DATA-MODEL.md` — SQLite schema and status machine (from tag `DATA-MODEL.md`)
|
|
- `UX.md` — screens, field recovery, outcomes (from tag `UX.md`)
|
|
- `PROMPTS.md` — Call 1 / Call 2 prompt text (from tag `PROMPTS.md`)
|
|
- `TEST-SPEC.md` — test pyramid, vectors, dishonest proxies (from tag `TEST-SPEC.md`)
|
|
- `CONTENT-WOO.md` — listing copy and Woo payload detail (migrated from `docs/CONTENT-WOO.md`)
|
|
|
|
Template: `docs/_templates/contract.md`.
|