core-hub/docs/specs/README.md
tegwick 4a9df801c3
Some checks failed
CI Smoke / host-smoke (push) Successful in 0s
CI Smoke / pytest-smoke (push) Failing after 3s
docs: define hub-core absorption plan
2026-08-21 10:57:13 +02:00

42 lines
2.5 KiB
Markdown

# Core Hub Specs
This directory is the specification map for Core Hub. The specs are intentionally ahead of implementation so the framework contract stays stable while the runtime is rebuilt.
## Spec Set
- [Architecture](core-hub-architecture.md) - component model and boundaries
- [Contract and IR](contract-ir.md) - canonical framework contract, schemas, fixtures, and adapter rules
- [API v2 Compatibility](api-v2-compatibility.md) - Inter-Hub compatibility surface to preserve during transition
- [Inter-Hub Legacy Inventory](interhub-legacy-inventory.md) - initial route/data/consumer inventory for migration
- [Runtime Absorption Inventory](runtime-absorption-inventory.md) - current routes, data, consumers, and ownership that hub-core absorption must preserve
- [Runtime Absorption Plan](runtime-absorption-plan.md) - ordered dual-run route groups, migration gates, traffic control, and rollback
- [Contract Governance](contract-governance.md) - how contract changes are reviewed and recorded
- [Data Model](data-model.md) - initial entity model and migration posture
- [Event and Registry Model](event-and-registry-model.md) - event catalogs, manifests, widgets, and capability registries
- [Ops Evidence Contract](ops-evidence-contract.md) - runtime evidence resources, event vocabulary, read-model gaps, and non-secret mapping rules
- [Auth, Access, and Custody](auth-access-and-custody.md) - API auth semantics and secret routing rules
- [Workplan Coordination](workplan-coordination.md) - file-first workplans, tasks, progress, messages, decisions
- [UI and Operator Console](ui-operator-console.md) - whynot-design aligned UI direction
- [Operator UI Rebuild Backlog](operator-ui-rebuild-backlog.md) - gated first-screen backlog after API/CLI proof
- [whynot UI Adapter](whynot-ui-adapter.md) - design-system consumption and adapter rules
- [Testing, Release, and Migration](testing-release-and-migration.md) - verification, deployment, and cutover gates
- [Pagination adoption](pagination-adoption.md) - hub-core utils deferral and adoption trigger
## Contract Artifacts
Implementation-neutral artifacts live in `contracts/`:
- `contracts/schemas/`
- `contracts/catalogs/`
- `contracts/fixtures/`
- `contracts/openapi/`
## Contract Rule
The implementation may change. The contract changes only through a workplan and a compatibility note.
Any route, schema, event type, or manifest field used by existing consumers must have one of:
- preserved behavior;
- documented replacement and migration path;
- explicit cancellation decision with affected consumers listed.