Complete REUSE-WP-0003: registry CLI, docs alignment, and coverage

Align INTENT.md with delivered layout, add CapabilityRegistryConcept guide,
extend schema with promotion_history, ship reuse-surface validate/query/export
CLI, register three more helix_forge capabilities, and refresh SCOPE and gap
analysis to reflect A3 tooling and D5/A3/C4/R2 self-assessment.
This commit is contained in:
2026-06-15 01:12:09 +02:00
parent 80bccc4bbb
commit 0dbef6d1a3
20 changed files with 1051 additions and 165 deletions

View File

@@ -14,13 +14,14 @@ for reuse within this product boundary.
## In Scope
- Maintain the capability maturity model, standards, schemas, registry formats,
sample entries, indexes, validation guidance, and agent instructions.
sample entries, indexes, validation guidance, CLI tooling, 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
authoring and machine-readable metadata.
- Record decisions, progress, and workplan status through State Hub.
- Verify changes with documentation review, `git diff --check`, and ADR-001
- Verify changes with `reuse-surface validate`, `git diff --check`, and ADR-001
consistency checks.
## Out of Scope
@@ -34,53 +35,47 @@ for reuse within this product boundary.
## What Is Possible Now
The MVP registry foundation is in place. Humans and agents can:
The MVP registry foundation plus CLI tooling (REUSE-WP-0003) is in place. Humans
and agents can:
- **Discover capabilities** via `registry/indexes/capabilities.yaml`
- **Discover capabilities** via `registry/indexes/capabilities.yaml` or
`reuse-surface query`
- **Add a new capability** at D0/A0/C0/R0 using
`templates/capability-entry.template.md`
- **Promote capabilities** by updating front matter with evidence-backed
discovery, availability, completeness, and reliability levels
- **Promote capabilities** with evidence, optional `promotion_history`, and index
vector updates
- **Compare candidates** using maturity vectors, scope, relations, and consumer
guidance in entry files
guidance
- **Record expectations** through `external_evidence.completeness` and
`external_evidence.reliability` fields
- **Validate entries manually** using the checklist in `registry/README.md`
against `schemas/capability.schema.yaml`
- **Avoid duplicates** by searching the index before creating new entries
`external_evidence.reliability`
- **Validate entries automatically** with `reuse-surface validate`
- **Export a machine-readable bundle** with `reuse-surface export`
- **Avoid duplicates** by querying the index before creating new entries
These workflows satisfy the MVP acceptance criteria in
`specs/ProductRequirementsDocument.md` section 16 through manual, Git-friendly
authoring. There is no CLI, API, or automated validator yet.
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.
## What Is Not Possible Yet
- Automated schema validation or registry export
- CLI query/filter commands
- Generated human-readable catalog site
- Capability graph visualization
- Promotion history tracking or review workflows in tooling
- Automated duplicate/overlap detection
- Federation across repositories or organizations
- CI integration or packaged releases beyond local `pip install -e .`
See `tools/README.md` for planned tooling that remains out of scope for the
current MVP.
See `tools/README.md` for command reference.
## Current State
- Status: active MVP registry (documentation-only, A0 availability).
- The repository has no package manifest, build system, runtime app, or
executable test suite. Registry consumption is informational: read, author,
compare, and plan.
- Three sample capabilities are registered in `registry/capabilities/`:
- `capability.registry.register` — D3 / A0 / C1 / R0
- `capability.feature-control.evaluate` — D5 / A4 / C3 / R3
- `capability.identity.vocabulary-canonicalize` — D4 / A0 / C2 / R0
- `specs/` holds the product requirements, use case catalog, and maturity
standard. `schemas/`, `templates/`, `registry/`, and `tools/` hold the
registry authoring and validation surfaces.
- Bootstrap work (`REUSE-WP-0001`) and MVP registry foundation
(`REUSE-WP-0002`) are finished. The next work should expand registry coverage,
tighten validation, or add CLI tooling through new workplans.
- Status: active MVP registry with CLI tooling.
- Six 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.
- Finished workplans: `REUSE-WP-0001`, `REUSE-WP-0002`, `REUSE-WP-0003`.
- **Self-assessed vector:** `D5 / A3 / C4 / R2` (see gap analysis).
## Repository Layout
@@ -89,32 +84,27 @@ reuse-surface/
├── INTENT.md
├── SCOPE.md
├── AGENTS.md
├── pyproject.toml
├── reuse_surface/
├── specs/
│ ├── ProductRequirementsDocument.md
│ ├── UseCaseCatalog.md
│ └── CapabilityMaturityStandard.md
├── schemas/
│ └── capability.schema.yaml
├── templates/
│ └── capability-entry.template.md
├── registry/
│ ├── README.md
│ ├── capabilities/
│ └── indexes/
│ └── capabilities.yaml
├── docs/
├── tools/
│ └── README.md
└── workplans/
```
## Getting Oriented
- Start with: INTENT.md
- Registry concept: docs/CapabilityRegistryConcept.md
- Intent vs scope gaps: docs/IntentScopeGapAnalysis.md
- Product requirements: specs/ProductRequirementsDocument.md
- Use cases: specs/UseCaseCatalog.md
- Maturity standard: specs/CapabilityMaturityStandard.md
- Registry index: registry/indexes/capabilities.yaml
- Registry guidance: registry/README.md
- CLI reference: tools/README.md
- Agent instructions: AGENTS.md
- Workplans: workplans/