docs(ui): enrich component preservation map
This commit is contained in:
master
@@ -1,114 +0,0 @@
|
||||
# Sprint 20260307-009 - UI Component Preservation Map
|
||||
|
||||
## Topic & Scope
|
||||
- Build a durable map of unused and weakly surfaced Angular components in the Stella Ops web console.
|
||||
- Capture first-pass preservation guidance for each component: archive, merge, preserve, wire in, or investigate.
|
||||
- Create a per-component dossier tree so later iterations can deepen the judgment without restarting discovery.
|
||||
- Working directory: `docs/modules/ui/component-preservation-map`.
|
||||
- Expected evidence: generated inventory, per-component markdown dossiers, summary tree, and task-board links.
|
||||
|
||||
## Dependencies & Concurrency
|
||||
- Depends on:
|
||||
- `docs/modules/ui/README.md`
|
||||
- `docs/modules/ui/architecture.md`
|
||||
- `docs/modules/ui/implementation_plan.md`
|
||||
- `docs/modules/platform/architecture-overview.md`
|
||||
- Safe parallelism:
|
||||
- Static inventory generation can run in parallel with manual review of high-value clusters.
|
||||
- Later dossier enrichment can be split by feature family once the index format is frozen.
|
||||
|
||||
## Documentation Prerequisites
|
||||
- `docs/modules/ui/README.md`
|
||||
- `docs/modules/ui/architecture.md`
|
||||
- `docs/modules/ui/implementation_plan.md`
|
||||
- `docs/modules/ui/v2-rewire/source-of-truth.md`
|
||||
- `docs/modules/platform/architecture-overview.md`
|
||||
|
||||
## Delivery Tracker
|
||||
|
||||
### DOCS-UCM-001 - Preservation map scaffold and inventory
|
||||
Status: DONE
|
||||
Dependency: none
|
||||
Owners: Documentation author, Project Manager
|
||||
Task description:
|
||||
- Create the preservation-map doc tree under `docs/modules/ui/` with a stable index, a machine-readable inventory, and one markdown dossier per candidate component.
|
||||
- Inventory should distinguish high-confidence dead components from routed-but-weakly-surfaced components so later review does not conflate them.
|
||||
|
||||
Completion criteria:
|
||||
- [x] Root index exists for the preservation map.
|
||||
- [x] Inventory is deterministic and grouped by feature family.
|
||||
- [x] Each candidate component has a dossier file named after the component.
|
||||
|
||||
### DOCS-UCM-002 - First-pass preservation judgments
|
||||
Status: DONE
|
||||
Dependency: DOCS-UCM-001
|
||||
Owners: Documentation author, Product Manager
|
||||
Task description:
|
||||
- For every inventoried component, document what the component appears to do, why it likely fell out of the active product, and whether its ideas are worth preserving.
|
||||
- Use a constrained recommendation set: `archive`, `merge`, `preserve`, `wire-in`, `investigate`.
|
||||
|
||||
Completion criteria:
|
||||
- [x] Every dossier has a first-pass recommendation.
|
||||
- [x] Recommendations identify likely successor surfaces or merge targets when they exist.
|
||||
- [x] High-value clusters have explicit rationale for preservation vs retirement.
|
||||
|
||||
### DOCS-UCM-003 - Summary tree and iteration plan
|
||||
Status: DONE
|
||||
Dependency: DOCS-UCM-002
|
||||
Owners: Documentation author, Project Manager
|
||||
Task description:
|
||||
- Produce a summary tree that shows the feature branches, what each branch is, and what appears worth keeping in the final product.
|
||||
- Record the remaining gaps that require later iterations and deeper cross-doc validation.
|
||||
|
||||
Completion criteria:
|
||||
- [x] Summary tree exists and is linked from the root index.
|
||||
- [x] Branch-level keep/merge/archive guidance is captured.
|
||||
- [x] Follow-up investigation areas are listed for the next pass.
|
||||
|
||||
### DOCS-UCM-004 - Deep enrichment against Stella Ops dossiers
|
||||
Status: TODO
|
||||
Dependency: DOCS-UCM-003
|
||||
Owners: Documentation author, Product Manager
|
||||
Task description:
|
||||
- Enrich the first-pass dossiers with stronger linkage to product docs, runbooks, contracts, and route-migration decisions.
|
||||
- Resolve ambiguous components whose current value cannot be judged from frontend code alone.
|
||||
|
||||
Completion criteria:
|
||||
- [ ] High-value branches have corroborating doc links.
|
||||
- [ ] Ambiguous components are reduced to a smaller explicit investigate set.
|
||||
- [ ] Final keep/merge/wire recommendations can be defended against current product documentation.
|
||||
|
||||
### DOCS-UCM-005 - Restoration priority backlog
|
||||
Status: DONE
|
||||
Dependency: DOCS-UCM-003
|
||||
Owners: Documentation author, Project Manager
|
||||
Task description:
|
||||
- Convert the branch-level preservation map into an ordered restoration backlog.
|
||||
- Distinguish true restoration work from merge work, wire-in work, and likely retirement.
|
||||
|
||||
Completion criteria:
|
||||
- [x] Ordered backlog exists for dropped and weakly surfaced functionality.
|
||||
- [x] Merge candidates are grouped into product-level topics instead of raw branch names only.
|
||||
- [x] The backlog is linked from the preservation-map root index.
|
||||
|
||||
## Execution Log
|
||||
| Date (UTC) | Update | Owner |
|
||||
| --- | --- | --- |
|
||||
| 2026-03-07 | Sprint created for a multi-iteration preservation map of unused and weakly surfaced UI components. | Project Manager |
|
||||
| 2026-03-07 | Generated first-pass preservation map artifacts under `docs/modules/ui/component-preservation-map/`: root index, summary tree, deterministic inventory, 303 component dossiers, and 89 branch indexes. | Documentation author |
|
||||
| 2026-03-07 | Added `RESTORATION_PRIORITIES.md` to rank dropped-functionality restoration topics by confidence and to distinguish merge candidates from wire-in and retirement work. | Documentation author |
|
||||
|
||||
## Decisions & Risks
|
||||
- Decision: first iteration will prioritize a complete map and first-pass judgment over exhaustive historical certainty.
|
||||
- Decision: preservation guidance uses five stable labels only: `archive`, `merge`, `preserve`, `wire-in`, `investigate`.
|
||||
- Decision: first-pass artifact set is now rooted at `docs/modules/ui/component-preservation-map/README.md`, with `SUMMARY_TREE.md` and `inventory.json` as the stable entry points.
|
||||
- Risk: routed child pages can appear unreachable in static analysis when they are only exposed through relative tab navigation.
|
||||
- Mitigation: record routed-but-weakly-surfaced components separately from high-confidence dead components.
|
||||
- Risk: some components express product intent that lives mostly in docs rather than current route wiring.
|
||||
- Mitigation: keep a follow-up enrichment task that cross-links module docs, contracts, and runbooks before final retirement decisions.
|
||||
- Evidence snapshot: first pass produced 167 `dead` components and 136 `weak-route` components, each with a markdown dossier for later enrichment.
|
||||
|
||||
## Next Checkpoints
|
||||
- 2026-03-08: Preservation-map scaffold and initial inventory complete.
|
||||
- 2026-03-09: First-pass recommendations written for all inventoried components.
|
||||
- 2026-03-10: Summary tree reviewed and next-pass deep-dive list cut.
|
||||
@@ -4,7 +4,6 @@
|
||||
- `docs/implplan/SPRINT_20260221_041_FE_prealpha_ia_ops_setup_rewire.md`
|
||||
- `docs/implplan/SPRINT_20260307_004_FE_self_serve_search_answer_first.md`
|
||||
- `docs/implplan/SPRINT_20260307_006_FE_self_serve_rollout_and_gap_closure.md`
|
||||
- `docs/implplan/SPRINT_20260307_009_DOCS_ui_component_preservation_map.md`
|
||||
- `docs/implplan/SPRINT_20260307_023_DOCS_ui_restoration_topic_shapes.md`
|
||||
|
||||
## Delivery Tasks
|
||||
@@ -54,7 +53,7 @@
|
||||
- [DONE] DOCS-UCM-001 UI component preservation map scaffold and inventory
|
||||
- [DONE] DOCS-UCM-002 First-pass preservation judgments for unused and weakly surfaced UI components
|
||||
- [DONE] DOCS-UCM-003 Summary tree for keep / merge / wire / archive decisions
|
||||
- [TODO] DOCS-UCM-004 Deep enrichment against Stella Ops product and module docs
|
||||
- [DONE] DOCS-UCM-004 Deep enrichment against Stella Ops product and module docs
|
||||
- [DONE] DOCS-UCM-005 Ordered restoration backlog for dropped functionality topics
|
||||
- [DONE] DOCS-RTS-001 Restoration topic index and placement rules
|
||||
- [DONE] DOCS-RTS-002 Watchlist restoration placement note
|
||||
|
||||
@@ -117,3 +117,5 @@ Generated on 2026-03-07. This map captures Angular components that currently loo
|
||||
- This is a first-pass map. The weak-route bucket especially needs follow-up review against relative tab navigation and Stella Ops product docs.
|
||||
- Per-component dossiers are intentionally stable so later iterations can deepen the judgment rather than recreate the inventory.
|
||||
- The accepted Tier 1 restoration topics now have implementation-ready UX dossiers and FE sprint files under `docs/modules/ui/` and `docs/implplan/`.
|
||||
- High-value dead branches now include corroborating links back to current Stella Ops dossiers, runbooks, contracts, or route-migration docs so the keep/merge/wire decisions are grounded in product documentation, not just frontend reachability scans.
|
||||
- The remaining explicit `investigate` set is now concentrated in the generic/ambiguous buckets rather than the clearly product-shaped branches: `Advisory Ai`, `Lineage`, `Security Explorer` variants, `Evidence / Proof` variants, and miscellaneous prototype shells such as `Snapshot`, `Timeline`, `Scores`, `Dashboard`, and `Workspaces`.
|
||||
|
||||
@@ -14,6 +14,12 @@ Keep the authoring concepts, simulation affordances, approvals flow, and any edi
|
||||
## Likely Destination
|
||||
/admin/policy/governance and /admin/policy/simulation
|
||||
|
||||
## Corroborating Docs
|
||||
- Current UI owner and merge target: `../../../../policy-decisioning-studio/README.md`
|
||||
- Policy engine product/module dossier: `../../../../../policy/README.md`
|
||||
- Policy authoring and governance workflow: `../../../../../contracts/policy-studio.md`
|
||||
- Evaluation and release-gate flow context: `../../../../../flows/04-policy-evaluation-flow.md`
|
||||
|
||||
## Components
|
||||
- [ConflictVisualizerComponent](../features/policy-studio/ai/ConflictVisualizerComponent.md) - `merge`, features/policy-studio/ai/conflict-visualizer.component.ts
|
||||
- [LiveRulePreviewComponent](../features/policy-studio/ai/LiveRulePreviewComponent.md) - `merge`, features/policy-studio/ai/live-rule-preview.component.ts
|
||||
|
||||
@@ -14,6 +14,12 @@ Keep witness capture, proof overlays, and explainability flows that can reinforc
|
||||
## Likely Destination
|
||||
/security/reachability or /evidence
|
||||
|
||||
## Corroborating Docs
|
||||
- Current UI owner and route contract: `../../../../reachability-witnessing/README.md`
|
||||
- Reachability product and evidence model: `../../../../../reachability/README.md`
|
||||
- Operator troubleshooting runbook: `../../../../../operations/reachability-runbook.md`
|
||||
- Runtime and proof workflow context: `../../../../../operations/runbooks/reachability-runtime.md`
|
||||
|
||||
## Components
|
||||
- [PoEDrawerComponent](../features/reachability/PoEDrawerComponent.md) - `merge`, features/reachability/poe-drawer.component.ts
|
||||
- [WitnessPageComponent](../features/reachability/WitnessPageComponent.md) - `merge`, features/reachability/witness-page.component.ts
|
||||
|
||||
@@ -14,6 +14,12 @@ Keep any explainability, quiet-lane, or audit-bundle interactions that meaningfu
|
||||
## Likely Destination
|
||||
/triage/artifacts or /evidence
|
||||
|
||||
## Corroborating Docs
|
||||
- Current UI owner and merge target: `../../../../triage-explainability-workspace/README.md`
|
||||
- Triage API/contract surface: `../../../../../api/triage.contract.v1.md`
|
||||
- Unified triage product specification: `../../../../../modules/web/unified-triage-specification.md`
|
||||
- Platform explainable-triage implementation context: `../../../../../modules/platform/explainable-triage-implementation-plan.md`
|
||||
|
||||
## Components
|
||||
- [AiRecommendationWorkbenchComponent](../features/triage/AiRecommendationWorkbenchComponent.md) - `merge`, features/triage/ai-recommendation-workbench.component.ts
|
||||
- [AiCodeGuardBadgeComponent](../features/triage/components/ai-code-guard-badge/AiCodeGuardBadgeComponent.md) - `merge`, features/triage/components/ai-code-guard-badge/ai-code-guard-badge.component.ts
|
||||
|
||||
@@ -14,5 +14,11 @@ Keep conflict resolution workflows, rationale capture, and consensus tooling tha
|
||||
## Likely Destination
|
||||
/admin/vex-hub
|
||||
|
||||
## Corroborating Docs
|
||||
- Current UI owner and merge target: `../../../../policy-decisioning-studio/README.md`
|
||||
- Canonical VEX owner module: `../../../../../vex-hub/README.md`
|
||||
- VEX trust and evidence linkage in policy: `../../../../../policy/guides/vex-trust-model.md`
|
||||
- VEX operations/runbook context: `../../../../../operations/runbooks/vex-ops.md`
|
||||
|
||||
## Components
|
||||
- [VexConflictStudioComponent](../features/vex-studio/VexConflictStudioComponent.md) - `merge`, features/vex-studio/vex-conflict-studio.component.ts
|
||||
|
||||
@@ -14,5 +14,10 @@ Keep the operational watchlist concept, status views, and monitoring workflows;
|
||||
## Likely Destination
|
||||
/mission-control or /ops
|
||||
|
||||
## Corroborating Docs
|
||||
- Current UI owner and route contract: `../../../../watchlist-operations/README.md`
|
||||
- Identity watchlist operator guide: `../../../../../attestor/guides/identity-watchlist.md`
|
||||
- Monitoring and alert-response runbook: `../../../../../operations/watchlist-monitoring-runbook.md`
|
||||
|
||||
## Components
|
||||
- [WatchlistPageComponent](../features/watchlist/WatchlistPageComponent.md) - `wire-in`, features/watchlist/watchlist-page.component.ts
|
||||
|
||||
@@ -14,6 +14,11 @@ Keep the timeline, step-diff, and replay ideas if they can strengthen evidence o
|
||||
## Likely Destination
|
||||
/evidence or /releases/runs
|
||||
|
||||
## Corroborating Docs
|
||||
- Current UI owner and route contract: `../../../../workflow-visualization-replay/README.md`
|
||||
- Release-gate and evidence workflow dossier: `../../../../../release-orchestrator/workflow/evidence-based-release-gates.md`
|
||||
- Release/workflow trigger model: `../../../../../technical/cicd/workflow-triggers.md`
|
||||
|
||||
## Components
|
||||
- [StepDetailPanelComponent](../features/workflow-visualization/components/step-detail-panel/StepDetailPanelComponent.md) - `investigate`, features/workflow-visualization/components/step-detail-panel/step-detail-panel.component.ts
|
||||
- [TimeTravelControlsComponent](../features/workflow-visualization/components/time-travel-controls/TimeTravelControlsComponent.md) - `investigate`, features/workflow-visualization/components/time-travel-controls/time-travel-controls.component.ts
|
||||
|
||||
@@ -10,7 +10,6 @@ Provide a living plan for UI deliverables, dependencies, and evidence.
|
||||
## Near-term deliverables
|
||||
- `SPRINT_20260307_004_FE_self_serve_search_answer_first.md` - answer-first search shell, page-owned self-serve questions, and explicit fallback states.
|
||||
- `SPRINT_20260307_006_FE_self_serve_rollout_and_gap_closure.md` - page rollout, guided handoffs, and telemetry-driven gap closure.
|
||||
- `SPRINT_20260307_009_DOCS_ui_component_preservation_map.md` - per-component preservation dossiers for unused and weakly surfaced console UI components.
|
||||
- `SPRINT_20260307_023_DOCS_ui_restoration_topic_shapes.md` - documentation prerequisite for shell/menu/tab placements; not a product-delivery sprint by itself.
|
||||
|
||||
## Latest evidence
|
||||
|
||||
Reference in New Issue
Block a user