generated from coulomb/repo-seed
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:
32
AGENTS.md
32
AGENTS.md
@@ -103,29 +103,29 @@ curl -s -X PATCH "http://127.0.0.1:8000/tasks/<task_id>" \
|
||||
|
||||
## Local Developer Workflow
|
||||
|
||||
This repository is currently documentation-only. There is no package manifest,
|
||||
runtime application, build system, executable test suite, or formatter/linter
|
||||
configuration checked in.
|
||||
The repository is primarily documentation-first with a small Python CLI for
|
||||
registry validate, query, and export. There is no long-running service.
|
||||
|
||||
### Install
|
||||
|
||||
No install step is required for normal repository work.
|
||||
```bash
|
||||
python3 -m venv .venv
|
||||
.venv/bin/pip install -e .
|
||||
```
|
||||
|
||||
### Build
|
||||
|
||||
No build step exists. Treat Markdown, YAML, and workplan edits as source
|
||||
No separate build step. Treat Markdown, YAML, and workplan edits as source
|
||||
artifacts.
|
||||
|
||||
### Test / lint
|
||||
|
||||
There is no project test runner or markdown linter configured yet. Use these
|
||||
checks before closing a change:
|
||||
|
||||
```bash
|
||||
# Confirm the repository file inventory still looks intentional
|
||||
rg --files
|
||||
# Registry validation (schema + index drift)
|
||||
.venv/bin/reuse-surface validate
|
||||
|
||||
# Catch whitespace errors in tracked and staged diffs
|
||||
# Repository hygiene
|
||||
rg --files
|
||||
git diff --check
|
||||
```
|
||||
|
||||
@@ -178,6 +178,10 @@ implementation reuse.
|
||||
# Fast discovery surface — read this first
|
||||
cat registry/indexes/capabilities.yaml
|
||||
|
||||
# CLI discovery and export
|
||||
.venv/bin/reuse-surface query --discovery-min D4
|
||||
.venv/bin/reuse-surface export --format yaml
|
||||
|
||||
# Authoring template and schema
|
||||
cat templates/capability-entry.template.md
|
||||
cat schemas/capability.schema.yaml
|
||||
@@ -189,7 +193,7 @@ cat tools/README.md
|
||||
|
||||
### Query workflow
|
||||
|
||||
1. Read `registry/indexes/capabilities.yaml`.
|
||||
1. Run `.venv/bin/reuse-surface query` with filters, or read the index directly.
|
||||
2. Filter by `vector`, `tags`, `consumption_modes`, `domain`, or `summary`.
|
||||
3. Open only matching files under `registry/capabilities/`.
|
||||
4. Compare candidates using `discovery`, `external_evidence`, `availability`,
|
||||
@@ -205,7 +209,7 @@ cat tools/README.md
|
||||
`registry/capabilities/capability.<domain>.<name>.md`.
|
||||
3. Start at `D0 / A0 / C0 / R0` when evidence is minimal; keep gaps explicit.
|
||||
4. Add the entry to `registry/indexes/capabilities.yaml`.
|
||||
5. Run the manual validation checklist in `registry/README.md`.
|
||||
5. Run `.venv/bin/reuse-surface validate`.
|
||||
|
||||
### Promote a capability
|
||||
|
||||
@@ -225,7 +229,7 @@ cat tools/README.md
|
||||
| Identify current consumption mode | `availability` + index `consumption_modes` |
|
||||
| Record expectations and broken expectations | `external_evidence.completeness` |
|
||||
| Record reliability evidence | `external_evidence.reliability` |
|
||||
| Search by maturity and availability | `indexes/capabilities.yaml` filters |
|
||||
| Search by maturity and availability | `reuse-surface query` or index filters |
|
||||
| Compare candidates | entry vectors + relations + README guidance |
|
||||
| Avoid duplicate capabilities | index search before add |
|
||||
|
||||
|
||||
Reference in New Issue
Block a user