core-hub/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

49 lines
2.5 KiB
Markdown

# Core Hub
Core Hub is the 3rd-generation Production Interaction Framework for Coulomb / Helixforge.
## Hub stack glossary
| Name | Role |
| --- | --- |
| **hub-core** | Shared library — `hub_core` utils, models, router factories |
| **state-hub** | Dev coordination — file-first workplans, agent MCP |
| **core-hub** | This repo — production `/api/v2` framework |
Ecosystem architecture: `/home/worsch/the-custodian/docs/hub-ecosystem-architecture.md`
It carries forward the lessons from State Hub and Inter-Hub: workplans and progress need to be durable, domains need typed ways to publish state and evidence, operators need a coherent console, and agents need APIs that are predictable enough to automate against. The rebuild moves that intent onto a lighter production platform.
## Generations
- Gen 1: `state-hub` - file-backed workplans, tasks, progress, messages, and read-model synchronization.
- Gen 2: `inter-hub` - the integrated hub framework idea: manifests, widgets, registries, events, API consumers, and a shared UI, implemented in Haskell/IHP.
- Gen 3: `core-hub` - the same framework ambition rebuilt contract-first on the natural Coulomb stack.
## Initial Stack Direction
- Python 3.12
- FastAPI and Pydantic v2
- SQLAlchemy async, Alembic, asyncpg, Postgres
- pytest and contract fixtures
- OpenAPI and JSON Schema for public contracts
- whynot-design aligned UI components/adapters where operator UI is needed
- Docker/Kubernetes/ArgoCD on the normal Railiance platform path
## Key Documentation
- [INTENT.md](INTENT.md) - purpose, lineage, principles, and platform direction
- [STATE.md](STATE.md) - current production truth, open work, and known conditions
- [SCOPE.md](SCOPE.md) - repo boundary
- [Research artifact](docs/research/2026-06-27-core-hub-lineage-and-platform-reset.md) - what we learned from State Hub, Inter-Hub, Haskell/IHP, and whynot-design
- [Specs index](docs/specs/README.md) - contract and implementation specification map
- [Workplans](workplans/) - staged implementation plan using ADR-001 workplan files
## Current Work
The contract, FastAPI/Postgres foundation, Inter-Hub migration, Haskell/IHP
retirement, and relocation from CoulombCore to railiance01 are complete.
`CORE-WP-0011` is finished. The only open local workplan is runtime absorption
and eventual archive (`CORE-WP-0010`). Its dual-run design is recorded; Slice 0
waits on a published hub-core runtime revision, durable PostgreSQL backend, and
internal candidate deployment before any public traffic changes.