docs: establish state hub baseline

This commit is contained in:
2026-05-17 18:54:57 +02:00
parent 6b71c8835e
commit 66df41c48c
5 changed files with 238 additions and 171 deletions

48
SCOPE.md Normal file
View File

@@ -0,0 +1,48 @@
# SCOPE
## One-Liner
State Hub is the local-first coordination service for Custodian workstreams,
tasks, decisions, progress events, repo metadata, MCP tooling, and dashboard
telemetry.
## In Scope
- State Hub FastAPI service
- PostgreSQL schema and Alembic migrations
- FastMCP server and tool reference
- Observable dashboard
- repo registration and consistency synchronization
- task-flow engine and flow definitions
- SBOM, contribution, capability, TPSC, DoI, token, and interface-change tracking
- State Hub tests, operational docs, policies, prompts, and local infra
## Out Of Scope
- Custodian canon and constitution content
- 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
## Current Extraction Note
This repo is being established as the standalone State Hub home under
`CUST-WP-0043`. Until the extraction verification gate passes, the prior live
implementation remains at:
```text
/home/worsch/the-custodian/state-hub
```
After verification, this repository becomes the authoritative implementation
tree and the embedded copy should be removed or replaced with a pointer.
## Workplan Convention
New State Hub-local workplans use `SHUB-WP-####`.
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.