resolve architecture review round 2: criticals, warnings, suggestions
- C-05: Add flowgraph-api.md with complete public API surface - C-06: Document <Map> component in workflow-templates.md - C-07: Specify Conditional else-branch behavior - C-08: Add lifecycle/ownership section to reactive-execution.md - C-09: Add consumer-integration.md end-to-end walkthrough - W-02: Add reactive error boundary semantics (3 levels) - W-03: Complete ReactiveContext interface definition - W-04: Add template composition rules (8 rules) - W-05: Document removeChild for both HostConfigs - W-06: Document signal/effect disposal lifecycle - W-07: Add ADR-004 (no schema version field) - W-08: Add type compatibility depth/contract to analysis.md - W-11: Add performance characteristics section - S-01: Getting Started merged into consumer-integration.md - S-02: Add flow diagrams for template rendering pipeline - S-03: Add node status state machine diagram - S-04: Add testing strategy section - S-06: Validate source structure cross-references Review round 2 fixes: - Define TemplateNodeAttrs as alias for OperationNodeAttrs - Document CallEventMapValue and CallResult types in schema.md - Standardize CycleError naming (replace CircularDependencyError) - Add function form to Map.over type definition - Define Map aggregate completion/failure semantics - Fix immutability claim for fromCallEvents - Clarify edgeType storage alongside OperationEdgeAttrs - Clarify WorkflowNode.status === statusMap (same Signal) - Add component-to-tag mapping for WorkflowTag
This commit is contained in:
@@ -274,29 +274,29 @@ When addressing these issues, use this checklist to track progress:
|
||||
- [x] C-02: Add `CallEdgeAttrs` type alias to schema.md
|
||||
- [x] C-03: Resolve `OperationEdgeAttrs` vs `TypedEdgeAttrs` naming (renamed `TypedEdgeAttrs` → `OperationEdgeAttrs`)
|
||||
- [x] C-04: Specify failure propagation semantics in reactive-execution.md (failure follows dependency edges, not structural scope; Conditionals as error boundaries; blockedByFailure computed; partial success for parallel branches)
|
||||
- [ ] C-05: Create FlowGraph public API document
|
||||
- [ ] C-06: Document `<Map>` component in workflow-templates.md
|
||||
- [ ] C-07: Specify `Conditional` else-branch behavior
|
||||
- [ ] C-08: Specify `WorkflowReactiveRoot` ↔ `ReactiveHostConfig` ownership
|
||||
- [ ] C-09: Create consumer integration guide
|
||||
- [x] C-05: Create FlowGraph public API document
|
||||
- [x] C-06: Document `<Map>` component in workflow-templates.md
|
||||
- [x] C-07: Specify `Conditional` else-branch behavior
|
||||
- [x] C-08: Specify `WorkflowReactiveRoot` ↔ `ReactiveHostConfig` ownership
|
||||
- [x] C-09: Create consumer integration guide
|
||||
- [x] W-01: Standardize `prerequisites` vs `preconditions` terminology (prerequisites=structural/graph, preconditions=reactive/computed)
|
||||
- [ ] W-02: Add reactive error boundary semantics
|
||||
- [ ] W-03: Complete `ReactiveContext` interface definition
|
||||
- [ ] W-04: Add template composition rules
|
||||
- [ ] W-05: Document `removeChild` for both HostConfigs
|
||||
- [ ] W-06: Document signal/effect disposal lifecycle
|
||||
- [ ] W-07: Consider ADR-004 for "no schema version"
|
||||
- [ ] W-08: Specify type compatibility depth
|
||||
- [x] W-02: Add reactive error boundary semantics
|
||||
- [x] W-03: Complete `ReactiveContext` interface definition
|
||||
- [x] W-04: Add template composition rules
|
||||
- [x] W-05: Document `removeChild` for both HostConfigs
|
||||
- [x] W-06: Document signal/effect disposal lifecycle
|
||||
- [x] W-07: ADR-004 for "no schema version" decision
|
||||
- [x] W-08: Specify type compatibility depth/contract (added compatibility contract, depth rules, and result semantics)
|
||||
- [x] W-09: Update ADR statuses to Accepted
|
||||
- [x] W-10: Clarify call graph mutation API (clarified `addCall` creates `triggered` edges automatically, `addDependency` creates `depends_on` edges)
|
||||
- [ ] W-11: Add performance characteristics section
|
||||
- [x] W-11: Add performance characteristics section
|
||||
- [x] W-12: Standardize edge attribute naming pattern (now `{GraphType}EdgeAttrs`: `OperationEdgeAttrs`, `CallEdgeAttrs`, `TemplateEdgeAttrs`)
|
||||
- [ ] S-01: Getting Started walkthrough document
|
||||
- [ ] S-02: Flow diagrams for template rendering pipeline
|
||||
- [ ] S-03: Node status state machine diagram
|
||||
- [ ] S-04: Testing strategy documentation
|
||||
- [ ] S-05: Additional ADRs for inline decisions
|
||||
- [ ] S-06: Validate source structure cross-references
|
||||
- [x] S-01: Getting Started walkthrough document (merged into consumer-integration.md)
|
||||
- [x] S-02: Flow diagrams for template rendering pipeline (added to host-configs.md)
|
||||
- [x] S-03: Node status state machine diagram (added to reactive-execution.md)
|
||||
- [x] S-04: Testing strategy documentation (added to build-distribution.md)
|
||||
- [ ] S-05: Additional ADRs for inline decisions (deferred — decisions documented inline in existing docs)
|
||||
- [x] S-06: Validate source structure cross-references (added map.ts to source structure, updated exports map, verified cross-references)
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user