Jan De Landtsheer
c8b76a2a3d
- Document defaults-only configuration, kernel topology override, and deprecated CLI flags in README - Mark schema doc as deprecated per ADR-0002 - Warn that --topology/--config are ignored; adjust loader/main/context flow - Refactor orchestrator run() to auto-select mount/apply, reuse state when already provisioned, and serialize topology via Display - Add Callgraph/FUNCTION_LIST/ADR docs tracking the new behavior - Derive Eq for Topology to satisfy updated CLI handling
Architectural Decision Records (ADR) Index
Purpose
- Central place to list and navigate all ADRs.
- Naming scheme:
NNNN-title.md(zero-padded sequence).
Index
Conventions
- Location: docs/adr/
- Create new ADRs incrementally with next number (e.g.,
0002-<short-title>.md). - Each ADR should include:
- Status (Proposed/Accepted/Deprecated)
- Context
- Decision
- Consequences
- Links to related docs (e.g., docs/ARCHITECTURE.md, docs/API-SKELETONS.md)
Workflow
- Propose an ADR when a design decision impacts architecture or module boundaries.
- Add the ADR file under docs/adr/ with the next sequence number.
- Append the ADR to this index under “Index”.
- Optionally add a short “Architectural Decisions” section to docs/ARCHITECTURE.md summarizing the latest ADRs.
Template
# ADR NNNN: Title
Status
- Proposed | Accepted | Deprecated
- Date: YYYY-MM-DD
Context
- Brief background and forces at play.
Decision
- The choice made; bullet any alternatives considered.
Consequences
- Pros/cons, impacts on modules, tests, build, etc.
Links
- [docs/ARCHITECTURE.md](../ARCHITECTURE.md)
- Related ADRs
Validation ideas (optional future work)
- Add a CI step or
cargo xtask adr-checkto verify:- Files match
NNNN-title.md - All ADRs are listed in this README
- Sequence numbers are contiguous
- Files match