generated from coulomb/repo-seed
Refresh SCOPE and INTENT gap analysis after WP-0011
Some checks failed
ci / validate-registry (push) Has been cancelled
Some checks failed
ci / validate-registry (push) Has been cancelled
SCOPE reflects 20 capabilities, production hub (A4), and current limits. Gap analysis closes historical MVP gaps and proposes priorities 18–23. Self-assessed product vector: D5 / A4 / C4 / R3.
This commit is contained in:
95
SCOPE.md
95
SCOPE.md
@@ -14,8 +14,8 @@ for reuse within this product boundary.
|
||||
## In Scope
|
||||
|
||||
- Maintain the capability maturity model, standards, schemas, registry formats,
|
||||
sample entries, indexes, validation guidance, CLI tooling, and agent
|
||||
instructions.
|
||||
sample entries, indexes, validation guidance, CLI tooling, hub service, and
|
||||
agent instructions.
|
||||
- Keep `INTENT.md`, `specs/`, registry artifacts, and State Hub workplans
|
||||
aligned on the registry-first reuse boundary.
|
||||
- Support humans and agents as registry consumers through Markdown-first
|
||||
@@ -26,7 +26,8 @@ for reuse within this product boundary.
|
||||
|
||||
## Out of Scope
|
||||
|
||||
- Host or operate the registered capabilities themselves.
|
||||
- Host or operate the registered capabilities themselves (except the federation
|
||||
hub coordinator, which stores repo metadata and index URLs only).
|
||||
- Replace package registries, service catalogs, issue trackers, or project
|
||||
management systems.
|
||||
- Judge internal code quality as capability maturity.
|
||||
@@ -35,15 +36,15 @@ for reuse within this product boundary.
|
||||
|
||||
## What Is Possible Now
|
||||
|
||||
The MVP registry foundation plus CLI tooling (REUSE-WP-0003) is in place. Humans
|
||||
and agents can:
|
||||
The MVP registry foundation, CLI tooling (REUSE-WP-0003), federation stack
|
||||
(WP-0005/0010), and hosted hub (WP-0011) are in place. Humans and agents can:
|
||||
|
||||
- **Discover capabilities** via `registry/indexes/capabilities.yaml` or
|
||||
`reuse-surface query`
|
||||
- **Discover capabilities** via `registry/indexes/capabilities.yaml`,
|
||||
`reuse-surface query`, or `GET https://reuse.coulomb.social/v1/federated`
|
||||
- **Add a new capability** at D0/A0/C0/R0 using
|
||||
`templates/capability-entry.template.md`
|
||||
- **Promote capabilities** with evidence, optional `promotion_history`, and index
|
||||
vector updates
|
||||
- **Promote capabilities** with evidence, `promotion_history`, and index vector
|
||||
updates
|
||||
- **Compare candidates** using maturity vectors, scope, relations, and consumer
|
||||
guidance
|
||||
- **Record expectations** through `external_evidence.completeness` and
|
||||
@@ -52,47 +53,58 @@ and agents can:
|
||||
- **Export a machine-readable bundle** with `reuse-surface export`
|
||||
- **Detect overlap candidates** with `reuse-surface overlaps`
|
||||
- **Generate a human-readable catalog** with `reuse-surface catalog`
|
||||
- **Browse a searchable catalog** at `docs/catalog/search.html` (client-side
|
||||
filter over `registry.json`)
|
||||
- **Browse a searchable catalog** at `docs/catalog/search.html`
|
||||
- **Compose federated indexes** with `reuse-surface federation compose`
|
||||
(local paths and remote HTTP URLs with cache)
|
||||
- **Register federation sources on the hosted hub** with `reuse-surface hub`
|
||||
against `https://reuse.coulomb.social` (`GET /v1/federated` for discovery)
|
||||
against `https://reuse.coulomb.social`
|
||||
- **Run the hub locally or in a container** with `reuse-surface serve`
|
||||
- **Generate relation graphs** with `reuse-surface graph`
|
||||
- **Explore relations interactively** at `docs/graph/index.html`
|
||||
- **Avoid duplicates** by querying the index and checking overlaps before adding entries
|
||||
- **Avoid duplicates** by querying the index and checking overlaps before adding
|
||||
entries
|
||||
|
||||
Registry tooling availability is **A3** (CLI). The registry product itself is
|
||||
still documentation-first for authoring; consumption combines Markdown entries,
|
||||
the index, and CLI automation.
|
||||
Registry **tooling** availability is **A4** (CLI plus hosted hub HTTP API).
|
||||
Registry **authoring** remains Markdown-first; consumption combines entries, the
|
||||
index, CLI automation, and the production hub.
|
||||
|
||||
## What Is Not Possible Yet
|
||||
|
||||
- Automatic polling/webhooks to refresh hub registrations (compose is on-demand)
|
||||
- Packaged releases beyond local `pip install -e .`, container image, and Gitea CI
|
||||
- **`reuse-surface hub sync`** — materialize local `sources.yaml` from hub state
|
||||
- **Automatic hub refresh** — federated compose is on-demand; no polling or
|
||||
webhooks
|
||||
- **Cross-repo federation at scale** — hub has one registered repo; sibling
|
||||
domains must publish capability indexes before registration
|
||||
- **Planning analytics** — no gap reports, roadmap views, or maturity-filter
|
||||
reports beyond manual query/export
|
||||
- **Managed platform posture** — hub runs as a container (A5 artifact) without
|
||||
documented SLO, multi-replica, or Postgres backing
|
||||
- **Formal consumer feedback loop** for registry workflows (reliability evidence
|
||||
is mostly structural: CI/tests, not production telemetry)
|
||||
|
||||
See `tools/README.md` for command reference.
|
||||
|
||||
## Current State
|
||||
|
||||
- Status: active MVP registry with CLI tooling.
|
||||
- Twelve helix_forge capabilities are registered in `registry/capabilities/`.
|
||||
- `reuse-surface` CLI provides `validate`, `query`, and `export` via
|
||||
`pyproject.toml` and `reuse_surface/`.
|
||||
- `docs/CapabilityRegistryConcept.md` and `docs/IntentScopeGapAnalysis.md`
|
||||
document onboarding and intent-scope tracking.
|
||||
- CI validates the registry and composes federation on push/PR.
|
||||
- Federated index: `registry/indexes/federated.yaml`.
|
||||
- Relation graph: `docs/graph/capability-graph.mmd` and explorer at
|
||||
`docs/graph/index.html`.
|
||||
- Searchable catalog: `docs/catalog/search.html`.
|
||||
- Test suite: `tests/` (pytest).
|
||||
- Remote federation: HTTP URL sources with cache in `registry/federation/cache/`.
|
||||
- Hosted federation hub: `https://reuse.coulomb.social` (REUSE-WP-0011, image
|
||||
`gitea.coulomb.social/coulomb/reuse-surface`).
|
||||
- Finished workplans: `REUSE-WP-0001` through `REUSE-WP-0011` (hub archived
|
||||
2026-06-15).
|
||||
- **Self-assessed vector:** `D5 / A3 / C4 / R3` (see gap analysis).
|
||||
- **Status:** active MVP registry with CLI, federation, and production hub.
|
||||
- **Capabilities:** 20 helix_forge entries in `registry/capabilities/`.
|
||||
- **CLI / service:** `reuse_surface/` — validate, query, export, overlaps,
|
||||
catalog, federation, graph, hub client, `serve` (FastAPI hub).
|
||||
- **Production hub:** `https://reuse.coulomb.social` on Railiance01
|
||||
(`92.205.62.239`); image `gitea.coulomb.social/coulomb/reuse-surface:cb7a6e4`;
|
||||
TLS live; dogfood registration for `reuse-surface` (12 capabilities composed
|
||||
on `/v1/federated`).
|
||||
- **Specs:** `specs/FederationHubAPI.md`, `schemas/hub-registration.schema.yaml`.
|
||||
- **Docs:** `docs/CapabilityRegistryConcept.md`, `docs/RegistryFederation.md`,
|
||||
`docs/IntentScopeGapAnalysis.md`, deploy guide `docs/deploy/reuse-kubernetes.md`.
|
||||
- **CI:** `.gitea/workflows/ci.yml` — validate, federation compose, catalog,
|
||||
graph, pytest (20 tests).
|
||||
- **Federated index:** `registry/indexes/federated.yaml` (local compose).
|
||||
- **Relation graph:** `docs/graph/capability-graph.mmd`, `docs/graph/index.html`.
|
||||
- **Searchable catalog:** `docs/catalog/search.html`.
|
||||
- **Workplans:** REUSE-WP-0001 through REUSE-WP-0011 finished; WP-0011 archived
|
||||
`workplans/archived/260615-REUSE-WP-0011-*.md`.
|
||||
- **Self-assessed vector:** `D5 / A4 / C4 / R3` (see `docs/IntentScopeGapAnalysis.md`).
|
||||
|
||||
## Repository Layout
|
||||
|
||||
@@ -102,14 +114,19 @@ reuse-surface/
|
||||
├── SCOPE.md
|
||||
├── AGENTS.md
|
||||
├── pyproject.toml
|
||||
├── reuse_surface/
|
||||
├── Dockerfile
|
||||
├── reuse_surface/ # CLI, hub service, federation, graph, catalog
|
||||
├── specs/
|
||||
├── schemas/
|
||||
├── templates/
|
||||
├── registry/
|
||||
│ ├── capabilities/ # per-entry Markdown
|
||||
│ ├── indexes/ # capabilities.yaml, federated.yaml
|
||||
│ └── federation/ # sources.yaml, cache/
|
||||
├── docs/
|
||||
├── tools/
|
||||
└── workplans/
|
||||
└── archived/
|
||||
```
|
||||
|
||||
## Getting Oriented
|
||||
@@ -120,11 +137,13 @@ reuse-surface/
|
||||
- Product requirements: specs/ProductRequirementsDocument.md
|
||||
- Use cases: specs/UseCaseCatalog.md
|
||||
- Maturity standard: specs/CapabilityMaturityStandard.md
|
||||
- Hub API: specs/FederationHubAPI.md
|
||||
- Registry index: registry/indexes/capabilities.yaml
|
||||
- Registry guidance: registry/README.md
|
||||
- Federation guide: docs/RegistryFederation.md
|
||||
- Hub deployment: docs/deploy/reuse-kubernetes.md
|
||||
- Generated catalog: docs/CapabilityCatalog.md
|
||||
- Searchable catalog: docs/catalog/search.html
|
||||
- Federation guide: docs/RegistryFederation.md
|
||||
- Relation graph: docs/graph/capability-graph.mmd
|
||||
- Graph explorer: docs/graph/index.html
|
||||
- CLI reference: tools/README.md
|
||||
|
||||
Reference in New Issue
Block a user