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:
28
tasks/architecture/w-10-edge-construction-semantics.md
Normal file
28
tasks/architecture/w-10-edge-construction-semantics.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
id: architecture/w-10-edge-construction-semantics
|
||||
name: Document fromTasks/fromRecords edge construction and validation semantics
|
||||
status: completed
|
||||
depends_on:
|
||||
- architecture/c-1-construction-error-policy
|
||||
created: 2026-04-26T09:11:03.412470108Z
|
||||
modified: 2026-04-26T09:11:03.412470586Z
|
||||
scope: narrow
|
||||
risk: medium
|
||||
---
|
||||
|
||||
# Description
|
||||
|
||||
**Review ref**: W-10 (Warning)
|
||||
**Files affected**: `docs/architecture/graph-model.md`, `docs/architecture/api-surface.md`, `docs/architecture/errors-validation.md`
|
||||
|
||||
Missing documentation for `fromTasks`/`fromRecords` edge construction:
|
||||
- Whether `fromRecords` requires edges to reference tasks in the same `tasks` array
|
||||
- What happens with dangling edge references (validation error? silently dropped?)
|
||||
- Whether edge order matters in the `edges` array
|
||||
- Whether `fromTasks`/`fromRecords` throw `DuplicateEdgeError` or silently deduplicate
|
||||
|
||||
Add a "Construction Semantics" section to graph-model.md specifying these behaviors.
|
||||
|
||||
Depends on C-1 (construction error policy) — the resolution of that issue determines whether duplicate edges are errors or idempotent no-ops.
|
||||
|
||||
**Source**: `/docs/reviews/architecture-review-2026-04-26.md` W-10
|
||||
Reference in New Issue
Block a user