core-hub/README.md

48 lines
2.2 KiB
Markdown
Raw Normal View History

2026-06-27 08:25:08 +00:00
# Core Hub
2026-06-27 11:00:12 +02:00
Core Hub is the 3rd-generation Production Interaction Framework for Coulomb / Helixforge.
2026-06-27 08:25:08 +00:00
## 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`
2026-06-27 11:00:12 +02:00
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.
2026-06-27 08:25:08 +00:00
2026-06-27 11:00:12 +02:00
## Generations
2026-06-27 08:22:42 +00:00
2026-06-27 11:00:12 +02:00
- 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.
2026-06-27 08:22:42 +00:00
2026-06-27 11:00:12 +02:00
## Initial Stack Direction
2026-06-27 08:22:42 +00:00
2026-06-27 11:00:12 +02:00
- 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
2026-06-27 08:22:42 +00:00
2026-06-27 11:00:12 +02:00
## Key Documentation
2026-06-27 08:22:42 +00:00
2026-06-27 11:00:12 +02:00
- [INTENT.md](INTENT.md) - purpose, lineage, principles, and platform direction
- [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
## Immediate Work
1. Freeze the Core Hub contract and IR.
2. Build the FastAPI/Postgres foundation.
3. Preserve critical Inter-Hub `/api/v2` compatibility for current consumers.
4. Migrate data and cut over production traffic.
5. Retire the Haskell/IHP build lane only after replacement evidence exists.