bisco/hoopscout-v2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: align top-level guidance with phase 1 baseline

Browse Source
This commit is contained in:
bisco
2026-03-20 20:06:23 +01:00
parent b58dff240c
commit 81834f3254
4 changed files with 64 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/PHASE_1.md
View File

@ -55,3 +55,5 @@ Phase 1 is complete when:
- the architecture overview exists and points to ADRs
- required major technical decisions are recorded as ADRs
- implementation can begin without relying on undocumented assumptions
The current ADR baseline is sufficient to support the next implementation-oriented phase, provided future work follows the accepted decisions or explicitly supersedes them through later ADRs.

12
docs/adr/README.md
View File

@ -27,7 +27,7 @@ Each ADR should include at least:
Minimal example:
```md
# ADR-0001: Example Decision
# 0001-example-decision
- Status: proposed
- Date: YYYY-MM-DD
@ -62,10 +62,16 @@ Use these status values:
Name ADR files using a numeric prefix and a short slug:
```text
ADR-0001-short-decision-name.md
ADR-0002-another-decision.md
0001-short-decision-name.md
0002-another-decision.md
```
The repository currently follows this convention:
- `0001-runtime-and-development-stack.md`
- `0002-initial-project-structure.md`
- `0003-containerized-developer-workflow.md`
- `0004-configuration-and-environment-strategy.md`
## Relationship to Implementation Tasks
Implementation tasks should follow documented ADRs when they depend on architecture decisions. If an implementation task exposes a new major technical decision, evaluate the options first, then record the accepted outcome in an ADR before implementation proceeds.