Add architecture review findings and address documentation issues
Review of all ADR documents (001-007) and peripheral architecture docs identified 3 critical, 10 warning, and 7 suggestion issues. Addressed in this commit: - W-1: Add draft qualifier to ADR-002 reference to incremental exploration - W-2: Add Alternatives Considered section to ADR-001 - W-3: Add Document Lifecycle section to README.md (draft/stable/deprecated) - W-4: Clarify includeCompleted semantics (only 'completed' status triggers exclusion) - W-5: Document file I/O runtime constraints in frontmatter.md - W-6: Add ADR reference to architecture.md redirect - W-7: Verify CVE-2025-64718 (confirmed real, improved description) - W-9: Convert workspace-absolute paths to relative/monorepo references - S-7: Add future ADR-008 note to incremental-update-exploration.md Critical issues (C-1, C-2, C-3) and remaining warnings (W-8, W-10, S-4, S-5) were addressed by a parallel agent in a prior commit. All 16 review tasks created and resolved.
This commit is contained in:
19
tasks/architecture/s-5-raw-mutation-safety.md
Normal file
19
tasks/architecture/s-5-raw-mutation-safety.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
id: architecture/s-5-raw-mutation-safety
|
||||
name: Document graph.raw mutation safety contract
|
||||
status: completed
|
||||
depends_on: []
|
||||
created: 2026-04-26T09:11:09.375058745Z
|
||||
modified: 2026-04-26T09:11:09.375059259Z
|
||||
scope: narrow
|
||||
risk: medium
|
||||
---
|
||||
|
||||
# Description
|
||||
|
||||
**Review ref**: S-5 (Suggestion)
|
||||
**Files affected**: `docs/architecture/api-surface.md`, `docs/architecture/graph-model.md`
|
||||
|
||||
Consumers can access the underlying graphology instance via `graph.raw`, but mutations made directly bypass TaskGraph invariants (deterministic edge keys from ADR-006, no-parallel-edges from ADR-007). Add a warning to api-surface.md and graph-model.md documenting that direct mutation of `graph.raw` can break TaskGraph invariants.
|
||||
|
||||
**Source**: `/docs/reviews/architecture-review-2026-04-26.md` S-5
|
||||
Reference in New Issue
Block a user