state-hub/SCOPE.md

63 lines
2.1 KiB
Markdown
Raw Normal View History

2026-05-17 18:54:57 +02:00
# SCOPE
## One-Liner
State Hub is the local-first coordination service for repo-anchored workplans,
tasks, decisions, progress events, repo classification and metadata, MCP
tooling, and dashboard telemetry.
2026-05-17 18:54:57 +02:00
## In Scope
- State Hub FastAPI service
- PostgreSQL schema and Alembic migrations
- FastMCP server and tool reference
- Observable dashboard
- repo registration (classification-driven) and consistency synchronization
- repo classification spine (14 market domains, `.repo-classification.yaml`)
2026-05-17 18:54:57 +02:00
- task-flow engine and flow definitions
- SBOM, contribution, capability, demand-weighted suggestion backlog, TPSC, DoI,
token, and interface-change tracking
2026-05-17 18:54:57 +02:00
- State Hub tests, operational docs, policies, prompts, and local infra
## Ecosystem position
| Repo | Role |
| --- | --- |
| `hub-core` | Shared library — State Hub mounts router factories and MCP from `hub_core` |
| `state-hub` | This repo — dev coordination host, workplan file authority |
| `core-hub` | Production framework — `/api/v2` at `hub.coulomb.social`; does not replace State Hub dev MCP |
Canon: `/home/worsch/the-custodian/docs/hub-ecosystem-architecture.md`
State Hub does **not** implement Inter-Hub `/api/v2` routes; those belong to core-hub.
2026-05-17 18:54:57 +02:00
## Out Of Scope
- Custodian canon and constitution content
- Inter-Hub `/api/v2` framework routes (owned by `core-hub`)
2026-05-17 18:54:57 +02:00
- non-State-Hub domain implementation work
- external publication or legal/financial commitments
- plaintext secrets
- generic hub-core extraction unless a dedicated workplan owns it
- renaming State Hub to Dev Hub unless a dedicated workplan owns it
2026-05-17 21:37:02 +02:00
## Extraction Note
2026-05-17 18:54:57 +02:00
2026-05-17 21:37:02 +02:00
This repo is the standalone State Hub home. It was extracted under
`CUST-WP-0043` from:
2026-05-17 18:54:57 +02:00
```text
/home/worsch/the-custodian/state-hub
```
2026-05-17 21:37:02 +02:00
This repository is authoritative for State Hub implementation work. The
embedded path in `the-custodian` is now a pointer only.
2026-05-17 18:54:57 +02:00
## Workplan Convention
New State Hub-local workplans use `STATE-WP-####`.
2026-05-17 18:54:57 +02:00
Migrated legacy State Hub workplans may temporarily retain `CUST-WP-####`
identifiers when preserving existing State Hub workstream and task IDs is the
least confusing path.