prj-state-hub-retirement/workplans/SHR-WP-0001-foundation.md

142 lines
5.1 KiB
Markdown
Raw Normal View History

2026-08-09 16:36:17 +02:00
---
id: SHR-WP-0001
type: workplan
title: "Project foundation and architecture baseline"
domain: infotech
repo: prj-state-hub-retirement
status: active
2026-08-09 16:36:17 +02:00
owner: codex
topic_slug: state-hub-retirement
created: "2026-08-09"
updated: "2026-08-09"
state_hub_workstream_id: "8498db77-cbe1-48ff-b7f0-03b933f0aa8a"
---
# Project foundation and architecture baseline
## Goal
Establish the durable project conventions, evidence inventories, architecture
decisions, and child-repository workplan map required before implementation
migration begins.
## Confirm the project-repository convention
```task
id: SHR-WP-0001-T01
status: done
2026-08-09 16:36:17 +02:00
priority: high
state_hub_task_id: "528ed9c9-57a6-4f44-b1cf-9d2c1a5cbca4"
```
Define the `prj-` repository flavor, lifecycle, required files, authority
boundary, and archive procedure in the Custodian canon. Confirm that project
repositories use `GOAL.md` rather than durable-product `INTENT.md`.
**Result (2026-08-09):** Fleet standard published at
`the-custodian/canon/standards/project-repository-flavor_v0.1.md`. ADR-005
naming section points at the standard; classification standard §5.3 cross-links
it; CUST-WP-0050 open question D1a marked resolved. Reference instance: this
repository (`prj-state-hub-retirement`, `GOAL.md` only — no durable
`INTENT.md`). Residual tooling gap: `statehub register` still scaffolds
`INTENT.md` for ordinary repos — capture under a state-hub child workplan when
T05 maps implementation streams (do not invent `INTENT.md` on `prj-` repos).
2026-08-09 16:36:17 +02:00
## Inventory State Hub
```task
id: SHR-WP-0001-T02
status: done
2026-08-09 16:36:17 +02:00
priority: high
state_hub_task_id: "f19351e4-c922-417c-bcc7-746a2cd7fe52"
```
Produce machine-readable inventories of State Hub routes, models, migrations,
jobs, MCP tools, dashboard views, datasets, callers, and operational
dependencies. Give every item an initial owner and keep/move/replace/retire
disposition.
**Result (2026-08-09):** Initial inventory `SHR-INV-0001` under `inventory/`
(425 items). Master file `inventory/state-hub-disposition.yaml`; rollup
`inventory/capabilities.yaml` (51 capabilities); split views for routes,
datasets, MCP tools, dashboard, jobs/callers/ops. Dispositions initial and
revisable via T03/T04/T05. Baseline orientation counts from live summary
(topics 14, workplans 868, tasks 5138, decisions 89). Open review points in
`inventory/README.md`.
2026-08-09 16:36:17 +02:00
## Define the information architecture
```task
id: SHR-WP-0001-T03
status: done
2026-08-09 16:36:17 +02:00
priority: high
state_hub_task_id: "65e522c7-2550-4187-a308-a23a2bae7615"
```
Define canonical entities and relations plus the distinct semantics of events,
signals, messages, conversations, requests, work, decisions, knowledge, and
telemetry. Specify correlation, authority, provenance, sensitivity, retention,
cost attribution, and transformation rules.
**Result (2026-08-09):** Draft-reviewable model `SHR-ARCH-IA-0001` at
`architecture/information-model_v0.1.md` + YAML companion. Eleven information
kinds; entity/relation catalog with authority vs projection; cross-cutting
rules; map from SHR-INV-0001 capabilities. Residual: human review before fleet
canon/hub-core promotion; open questions listed for T04.
2026-08-09 16:36:17 +02:00
## Define the hub and extension architecture
```task
id: SHR-WP-0001-T04
status: done
2026-08-09 16:36:17 +02:00
priority: high
state_hub_task_id: "90e8350a-8a1c-4f46-a545-69c9cf00e6d1"
```
Revise the Orthogonal Architecture material into an implementable hub-core and
domain-extension contract. Define domain hubs, functional components,
authoritative services, projections, adapters, and conformance requirements.
**Result (2026-08-09):** Draft-reviewable `SHR-ARCH-HUB-0001` at
`architecture/hub-extension-architecture_v0.1.md` + contract outline
`hub-extension-contract_v0.1.yaml` (`helixforge.hub-extension` v0.1). Taxonomy,
ports, extension package, OA binding, conformance tiers 04, migration stack
map, suggested T05 child streams. Residual: automated suite + human review
before fleet-normative; Tier 1 artefacts in hub-core child WP.
2026-08-09 16:36:17 +02:00
## Establish the child-workplan map
```task
id: SHR-WP-0001-T05
status: todo
priority: high
state_hub_task_id: "1fc9da32-14ed-46b6-a965-b2477414df78"
```
Create or identify local implementation workplans in `repo-manager`,
`hub-core`, `core-hub`, `state-hub`, and other affected repositories. Record
dependencies and project gates without duplicating their tasks here.
## Baseline migration and retirement acceptance
```task
id: SHR-WP-0001-T06
status: todo
priority: medium
state_hub_task_id: "d793f242-999c-47ad-86f2-6d972cc20b84"
```
Record baseline row counts, callers, availability expectations, recovery paths,
and historical-evidence requirements. Turn the success and retirement clauses
in `GOAL.md` into executable or evidence-backed gates.
## Acceptance
- [x] The `prj-` flavor has a durable canonical definition.
- [x] State Hub has a complete disposition inventory.
- [x] The information and extension architectures are reviewable.
- [x] Information architecture (T03) draft-reviewable
- [x] Hub/extension architecture (T04) draft-reviewable
2026-08-09 16:36:17 +02:00
- [ ] Each implementation stream has one local owner and workplan.
- [ ] Migration and retirement gates have measurable evidence requirements.