ADR housekeeping: category prefixes, lifecycle folders, retroactive 0034-0037
Filename + lifecycle:
- ADR rename to ADR-NNNN-<cat>-title.md with 8 3-letter category prefixes
(dev / mem / lat / prog / algo / par / api / ver). Numbers stay immutable.
- ADR Lifecycle split into 3 folders, documented in CLAUDE.md Part 2:
docs/adr/ (Accepted), docs/adr-proposed/ (Proposed/Stub/Draft),
docs/adr-history/ (Superseded/Merged). Status field gains "Draft" for
retroactive docs pending verification.
Merges (one ADR per topic, no change-history annotations):
- ADR-0017 absorbs ADR-0019 (Cube NOC + per-PE HBM connectivity, 10 D-items)
- ADR-0014 absorbs ADR-0021 (PE pipeline execution model, 8 D-items incl.
TileToken self-routing and multi-op composite epilogue scope)
- ADR-0023 absorbs docs/ipcq-dma-codesign-hw.md as new "HW Realization
Notes (Informative)" section (D16-D23 + Open HW Questions). codesign-hw.md
deleted; ADR-0019/0021 moved to adr-history with one-line stub status
Retroactive documentation (G4 closures, code-verified):
- ADR-0037 forwarding component (TransitComponent: first-flit overhead,
serial worker, path-based routing, single impl/multiple names)
- ADR-0036 IO_CPU component (target_start_ns global barrier stamping,
per-cube fan-out, response aggregation)
- ADR-0035 M_CPU & M_CPU.DMA component (3 fan-out paths, DMA Resources,
target_start_ns passthrough)
- ADR-0034 HBM controller internal design (per-PC state, address-based
selection, flit-aware per-flit commit, async finalize, command-only
fallback path)
Content updates:
- ADR-0010 expanded to full CLI surface (run/probe/web), retitled
"Command Line Interface and Execution Semantics"
- ADR-0007 D2 rewritten to current state; ADR-0015 supersession notes pruned
- ADR-0005 wrapped in Decision header with D1-D5; ADR-0022 metadata
block replaced with standard Status header
- ADR-0024 trimmed to rank=SIP launcher essentials (D1-D4);
ADR-0027 cleaned of supersession history
- ADR-0033 D6 cleanup: address-based PC selection moved out of future-work
(now documented in ADR-0034 D3); related D1/D3 wording realigned
- Cross-references back-filled in 5 ADRs (G3 gaps closed)
Onboarding docs split:
- docs/onboarding/ created
- moved: hw-architecture-overview.md, latency-model.md, di-presentation.md,
ccl-author-guide{,.en}.md
- references updated in README, ADR-0023{,.en}, src/kernbench/ccl/__init__.py
Source / test / yaml: ADR-NNNN cross-references in docstrings and YAML
comments updated after the merges (ADR-0021->0014 D6, ADR-0019->0017 D8).
No behavior change.
Tooling:
- tools/verify_adr_lang_pairs.py + tests/test_verify_adr_lang_pairs.py
(ADR EN/KO pair invariant checker)
- .claude/commands/report.md tracked (/report slash command)
- .gitignore: allow .claude/commands/*.md while keeping settings files ignored
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -218,17 +218,43 @@ General fallbacks. Apply to anything not explicitly covered above.
|
||||
|
||||
### ADR Lifecycle
|
||||
|
||||
- `docs/adr/` contains ADRs reflecting current implementation or
|
||||
work-in-progress designs.
|
||||
- `docs/history/` contains superseded ADRs as historical record.
|
||||
- When an ADR is superseded:
|
||||
1. The superseding ADR includes a "Supersedes ADR-NNNN" line.
|
||||
2. The superseded ADR's Status is set to "Superseded by ADR-MMMM".
|
||||
3. The superseded ADR file is **moved** (git mv) to `docs/history/`.
|
||||
- Cross-references between ADRs use the ADR-NNNN ID and remain
|
||||
valid regardless of file location.
|
||||
- ADR numbers are **immutable**; never renumber. Numbering holes
|
||||
from moved ADRs are expected.
|
||||
ADRs live in one of three folders based on lifecycle state:
|
||||
|
||||
- `docs/adr/` — **Accepted** (current implementation reflected).
|
||||
- `docs/adr-proposed/` — **Proposed**, **Stub**, or **Draft** (design
|
||||
only / future-work exploration / retroactive documentation pending
|
||||
verification).
|
||||
- `docs/adr-history/` — **Superseded** or **Merged** (no longer the
|
||||
authoritative source; kept as historical record).
|
||||
|
||||
Status field values:
|
||||
|
||||
- `Accepted` — design is in current implementation.
|
||||
- `Proposed` — design is concrete but not yet implemented.
|
||||
- `Stub (Future Work)` — design space exploration; no commitment yet.
|
||||
- `Draft` — retroactive documentation drafted but not yet verified
|
||||
against the implementation it describes.
|
||||
- `Superseded by ADR-NNNN` — replaced by another ADR.
|
||||
- `Merged into ADR-NNNN` — content absorbed by another ADR.
|
||||
|
||||
Transitions:
|
||||
|
||||
- **Proposed/Stub → Accepted**: when the ADR's decisions are
|
||||
reflected in production code AND covered by tests. `git mv` from
|
||||
`docs/adr-proposed/` to `docs/adr/`, change Status to `Accepted`.
|
||||
- **Draft → Accepted**: when the ADR's text has been verified to
|
||||
accurately describe the existing implementation. `git mv` from
|
||||
`docs/adr-proposed/` to `docs/adr/`, change Status to `Accepted`.
|
||||
- **Accepted → Superseded**: set Status to `Superseded by ADR-MMMM`
|
||||
and `git mv` to `docs/adr-history/`. The superseding ADR includes
|
||||
a "Supersedes ADR-NNNN" reference (or, for partial supersession of
|
||||
clauses, documents this in its own body).
|
||||
- **Accepted → Merged**: set Status to `Merged into ADR-MMMM`
|
||||
(single-line stub) and `git mv` to `docs/adr-history/`.
|
||||
|
||||
Cross-references between ADRs use the `ADR-NNNN` ID and remain valid
|
||||
regardless of folder location. ADR numbers are **immutable**; never
|
||||
renumber. Numbering holes from moved ADRs are expected.
|
||||
|
||||
## Terminology
|
||||
|
||||
|
||||
Reference in New Issue
Block a user