tegwick
eac38b76ca
Assistant: codex Assistant-Model: gpt-6-astra Assistant-Session: 01a15374-f59f-7a31-86d2-d23b5d2ed181
77 lines
3.2 KiB
Markdown
77 lines
3.2 KiB
Markdown
# SCOPE
|
|
|
|
## One-Liner
|
|
|
|
State Hub is the transitional coordination service for repo-anchored workplans,
|
|
tasks, decisions, progress events, repo classification and metadata, MCP
|
|
tooling, and dashboard telemetry. Its primary runtime is on railiance01; local
|
|
repository files remain authoritative for repository-owned work records.
|
|
|
|
## 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
|
|
- read-model orientation brief rendering without Git operations (`make brief-generate` /
|
|
`brief-check`, explicit repo path and slug); rejects unavailable or malformed reads
|
|
and preserves existing briefs on failure. See `docs/brief-generation.md`.
|
|
- repo classification spine (14 market domains, `.repo-classification.yaml`)
|
|
- task-flow engine and flow definitions
|
|
- SBOM, contribution, capability, demand-weighted suggestion backlog, TPSC, DoI,
|
|
token, and interface-change tracking
|
|
- State Hub tests, operational docs, policies, prompts, and local infra
|
|
|
|
## Ecosystem position
|
|
|
|
| Repo | Role |
|
|
| --- | --- |
|
|
| `hub-core` | Shared library and selected target runtime for capabilities retained after State Hub retirement |
|
|
| `state-hub` | This repo — transitional coordination runtime and read projection; repository files retain work-record authority |
|
|
| `core-hub` | Production `/api/v2` compatibility runtime on railiance01 during consolidation into `hub-core` |
|
|
|
|
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.
|
|
New permanent cross-domain capability should land in its disposition owner, not
|
|
expand State Hub. The retirement program is governed by
|
|
`prj-state-hub-retirement`.
|
|
|
|
## Out Of Scope
|
|
|
|
- Custodian canon and constitution content
|
|
- Inter-Hub `/api/v2` framework routes (owned by `core-hub`)
|
|
- 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
|
|
|
|
## Extraction Note
|
|
|
|
This repo is the standalone State Hub home. It was extracted under
|
|
`CUST-WP-0043` from:
|
|
|
|
```text
|
|
/home/worsch/the-custodian/state-hub
|
|
```
|
|
|
|
This repository is authoritative for State Hub implementation work. The
|
|
embedded path in `the-custodian` is now a pointer only.
|
|
|
|
## Workplan Convention
|
|
|
|
New State Hub-local workplans use `STATE-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.
|
|
|
|
|
|
```capability
|
|
type: tool
|
|
title: Read-model orientation brief rendering
|
|
description: scripts/generate_custodian_brief.py and make brief-generate/brief-check render or check a repository brief from the current State Hub read model with explicit path and slug. They perform no Git or hub writes, reject unavailable or malformed reads, and preserve prior briefs on failure. This is not staged-source or scheduled generation.
|
|
keywords: [orientation, briefs, read-model, generation, validation]
|
|
```
|