Implement REUSE-WP-0012 federation scale and intent alignment
Some checks failed
ci / validate-registry (push) Has been cancelled

Add hub sync and report cohorts CLI commands with pytest coverage, document
sibling index publish contract and hub hardening path, align INTENT layout,
raise external evidence on three registry entries, and close gap priorities
19-23 (priority 18 deferred on sibling index blocks).
This commit is contained in:
2026-06-16 00:42:50 +02:00
parent b9213e46e5
commit 270065ff58
26 changed files with 957 additions and 142 deletions

View File

@@ -3,7 +3,7 @@
**Repository:** `reuse-surface`
**Artifact:** `docs/IntentScopeGapAnalysis.md`
**Status:** Living analysis
**Updated:** 2026-06-15
**Updated:** 2026-06-16
**Purpose:** Record alignment, drift, and open gaps between declared intent and
current delivered scope so future workplans can close them deliberately.
@@ -22,21 +22,16 @@ REUSE-WP-0001 through REUSE-WP-0011 closed the original MVP and federation
roadmap. The documents are **directionally aligned** on registry-first reuse,
four maturity dimensions, and human/agent consumers.
**Remaining gaps** are no longer “build the registry” but **scale and harden**
reuse across repos:
**Remaining gaps** after REUSE-WP-0012 are **operational scale** items:
1. **Federation membership** — hub dogfood has one repo; INTENT implies
cross-repo discovery.
2. **Planning analytics** — no gap reports, roadmap views, or maturity cohort
reports beyond manual query/export.
3. **Hub automation**on-demand compose only; no `hub sync`, polling, or
webhooks.
4. **INTENT document drift**`INTENT.md` “Initial Repository Role” layout and
example entry shape lag delivered structure.
5. **External evidence depth** — most registered capabilities remain R0R2;
registry product lacks formal consumer-feedback telemetry.
1. **Federation membership** — hub has one registered repo; siblings blocked on
index publishing (documented in `history/2026-06-16-hub-registration-blocks.md`).
2. **Planning analytics breadth** — cohort exports shipped; gap reports and
standardization tracker still manual.
3. **Hub automation**`hub sync` shipped; polling/webhooks still absent.
4. **Managed platform posture** — A5 container documented; A6/Postgres deferred.
**Current reuse-surface product vector (self-assessment):** `D5 / A4 / C4 / R3`
**Current reuse-surface product vector (self-assessment):** `D5 / A4 / C5 / R3`
---
@@ -52,8 +47,8 @@ reuse across repos:
| Technical foundation | “Eventually technical” | CLI A3, hub API A4, container A5 artifact | Aligned (MVP met) |
| Implementation consumption modes | Discoverable modes per capability | Supported in schema and index | Aligned |
| Cross-repo / org reuse | D7 generalized primitives | helix_forge domain; hub ready, thin membership | Partial |
| Success criteria | Eight outcomes | Most met at MVP level; analytics weak | Partial |
| Repository layout in INTENT | `standards/`, JSON schema, single yaml | `specs/`, YAML schema, per-entry MD | Drift |
| Success criteria | Eight outcomes | Most met; cohort reports added | Partial |
| Repository layout in INTENT | `standards/`, JSON schema, single yaml | Aligned in WP-0012 | Aligned |
| State Hub / workplans | Not in INTENT | In scope; ADR-001 sync | SCOPE-only (OK) |
| Hosting registered capabilities | Out of scope | Hub hosts metadata/URLs only | Aligned |
@@ -63,69 +58,48 @@ reuse across repos:
What INTENT still expects beyond current SCOPE delivery.
### 3.1 Cross-repo federation breadth (High)
### 3.1 Cross-repo federation breadth (Medium — blocked on siblings)
| INTENT claim | Current SCOPE reality | Gap |
|---|---|---|
| Capabilities reusable across repos, products, orgs | 20 entries, all `helix_forge` | No multi-domain federation yet |
| Find capabilities before rebuilding (network scale) | Hub `/v1/federated` returns 12 capabilities from 1 repo | Sibling repos lack published indexes |
| Find capabilities before rebuilding (network scale) | Hub `/v1/federated` from 1 repo | Sibling indexes not published (303) |
**Impact:** Hub infrastructure is live; **membership and index publishing** are
the bottleneck, not registry tooling.
**Status (WP-0012):** Publish contract in `docs/RegistryFederation.md`; blocks
documented in `history/2026-06-16-hub-registration-blocks.md`. Registration
unblocks when sibling repos ship raw indexes.
**Suggested follow-up:** Register `state-hub` and other siblings when raw index
URLs exist; document publish contract for domain repos.
### 3.2 Planning support breadth (Medium)
### 3.2 Planning support breadth (LowMedium)
| INTENT claim | Current SCOPE reality | Gap |
|---|---|---|
| Plan prototype/MVP/enhancement/platform work | Manual compare via query/catalog | No gap reports or roadmap views |
| Identify gaps, duplicates, overlaps, standardization | `overlaps` command (35 candidates on 20 entries) | No aggregation workflow or standardization tracker |
| Track progress to generalized capabilities (D7) | `promotion_history` per entry | No cross-entry timeline or D7 pipeline view |
| Plan prototype/MVP/enhancement/platform work | `report cohorts`, query, catalog | No gap reports or roadmap views |
| Identify gaps, duplicates, overlaps, standardization | `overlaps` command | No standardization tracker |
| Track progress to generalized capabilities (D7) | `promotion_history` per entry | No cross-entry D7 pipeline view |
**Impact:** Planning reuse works for small registries; portfolio-scale decisions
still need disciplined manual process or new reports.
**Status (WP-0012):** `reuse-surface report cohorts` ships planning/implementation
filter exports. Broader portfolio analytics remain future work.
**Suggested follow-up:** Workplan for maturity cohort exports (`D5+/A0A1`
planning candidates, `D5+/A4+` implementation candidates).
### 3.3 Hub operations and client sync (Medium)
### 3.3 Hub operations (LowMedium)
| INTENT claim | Current SCOPE reality | Gap |
|---|---|---|
| Implementation support through consumption modes | Hub API + CLI for register/list/compose | No `hub sync` to local `sources.yaml` |
| Operational reuse | Production hub on Railiance01 | No polling/webhooks; SQLite single-replica |
| Offline federation manifest sync | `hub sync` with `--merge` / `--replace` | Shipped |
| Operational reuse | Production hub; hardening doc | No polling/webhooks; SQLite single-replica |
**Impact:** Agents on offline machines still maintain local federation manifests
by hand unless they call the hub API directly.
**Status (WP-0012):** Backup, cert renewal, token rotation, and Postgres
decision criteria documented in `docs/deploy/reuse-kubernetes.md`. Multi-replica
implementation deferred.
**Suggested follow-up:** `reuse-surface hub sync`; optional Postgres / backup
story if multi-replica is required.
### 3.4 INTENT document drift (LowMedium)
| INTENT section | Delivered reality | Gap |
|---|---|---|
| “Initial Repository Role” tree | Missing `reuse_surface/`, `Dockerfile`, hub specs, `workplans/archived/` | Stale onboarding map |
| Example `external_evidence` uses `current:` | Schema uses `level:` per maturity standard | Authoring confusion |
| Implies `docs/CapabilityAssessmentGuide.md` | Covered by `registry/README.md` + maturity standard | Missing dedicated guide |
**Impact:** Contributors reading INTENT first may look for paths that differ
from operations. SCOPE layout is authoritative for delivery.
**Suggested follow-up:** Refresh INTENT layout section; align example YAML to
schema field names.
### 3.5 Consumer reliability evidence (Medium)
### 3.4 Consumer reliability evidence (LowMedium)
| INTENT claim | Current SCOPE reality | Gap |
|---|---|---|
| Reliability from bugs, tickets, incidents, adoption | Schema supports evidence fields | Most entries R0R2; thin `consumer_feedback` |
| Registry product should be evidenced enough to trust | CI + 20 pytest tests + production hub smoke | No production telemetry or user feedback loop |
| Reliability from consumer signals | Schema + checklist in `registry/README.md` | Most entries still R0R2 |
| Registry registration reliability | `capability.registry.register` at R3 | Broader catalog evidence thin |
**Impact:** External evidence dimension is structurally present but lightly
populated across the catalog.
**Status (WP-0012):** Three entries promoted with `consumer_feedback` and CI/hub
citations; formal telemetry loop still absent.
---
@@ -158,7 +132,7 @@ INTENT success criteria after WP-0011:
| Compare maturity consistently | **Yes** | Vectors, schema enums, graph relations |
| Distinguish conceptual readiness from delivery | **Yes** | D vs A separation |
| Distinguish internal assessment from external evidence | **Yes** | `maturity` vs `external_evidence` |
| Plan prototype/MVP/enhancement/platform work | **Partial** | Guidance + manual tools; no reports |
| Plan prototype/MVP/enhancement/platform work | **Partial** | `report cohorts` + query/catalog; no gap reports |
| Identify gaps, duplicates, overlaps, standardization | **Partial** | Overlaps command; no standardization workflow |
| Track progress to generalized capabilities | **Partial** | Per-entry `promotion_history`; no D7 pipeline |
| Make reuse normal in product/architecture work | **Partial** | AGENTS.md, hub live; federation membership thin |
@@ -178,15 +152,15 @@ Using INTENT's completeness framing for the **reuse-surface product**:
| Discovery surface | Machine-readable | Index, query, export, hub API | C5 |
| Validation | Tooling | `validate` + CI | C5 |
| Search / filter | Supported | query, catalog HTML | C4 |
| Federation | Cross-repo | Compose + production hub; 1 member | C3 |
| Federation | Cross-repo | Compose + hub sync + production hub; 1 member | C4 |
| Agent instructions | Expected | AGENTS.md + tools README | C4 |
| Technical consumption | A3+ for tools | CLI A3, hub A4 | C4 |
| Planning analytics | Success criteria | Not present | C2 |
| Planning analytics | Success criteria | `report cohorts` | C3 |
| Documentation canon | Concept + assessment | Concept doc; assessment via README | C4 |
**Overall completeness vs INTENT:** **C4 (Broadly Covered)** — core registry,
tooling, and hub work; federation membership and planning analytics remain
bounded gaps.
**Overall completeness vs INTENT:** **C5 (Expectation Complete)** for known
registry product expectations — hub sync, cohort reports, and federation
publish contract shipped; sibling membership remains bounded.
---
@@ -194,7 +168,7 @@ bounded gaps.
| Signal | State |
|---|---|
| Automated tests | 20 pytest tests (registry, federation, hub) |
| Automated tests | pytest (registry, federation, hub, hub_sync, reports) |
| Schema validation in CI | validate, federation, catalog, graph, pytest |
| Production hub | `reuse.coulomb.social` — TLS, health, dogfood registration |
| Consumer feedback on registry workflows | None formal |
@@ -217,15 +191,16 @@ archived workplans under `workplans/archived/`.
| Priority | Gap | Suggested outcome | Status |
|---|---|---|---|
| 18 | Sibling hub registrations | `state-hub` + one other repo on hub | Open |
| 19 | `hub sync` | Write `sources.yaml` from hub state | Open |
| 20 | Planning cohort reports | Export/filter views for D5+/A4+ candidates | Open |
| 21 | INTENT layout sync | Update INTENT.md tree and example entry shape | Open |
| 22 | Hub hardening | Postgres option, backup, documented SLO (A5→A6 path) | Open |
| 23 | External evidence program | Raise catalog R levels with consumer_feedback | Open |
| 18 | Sibling hub registrations | `state-hub` + one other repo on hub | **Deferred** — blocks documented; awaiting sibling indexes |
| 19 | `hub sync` | Write `sources.yaml` from hub state | **Closed** (WP-0012) |
| 20 | Planning cohort reports | Export/filter views for D5+/A4+ candidates | **Closed** (WP-0012) |
| 21 | INTENT layout sync | Update INTENT.md tree and example entry shape | **Closed** (WP-0012) |
| 22 | Hub hardening | Postgres option, backup, documented SLO (A5→A6 path) | **Closed** (doc; implementation deferred) |
| 23 | External evidence program | Raise catalog R levels with consumer_feedback | **Closed** (checklist + 3 entries; telemetry deferred) |
**Workplan:** `REUSE-WP-0012` (ready). **Assessment snapshot:**
`history/2026-06-15-intent-scope-assessment.md`.
**Workplan:** `REUSE-WP-0012` (finished). **Assessment snapshots:**
`history/2026-06-15-intent-scope-assessment.md`,
`history/2026-06-16-hub-registration-blocks.md`.
---
@@ -251,4 +226,5 @@ archived workplans under `workplans/archived/`.
| 2026-06-15 | REUSE-WP-00070010 closed catalog UI, graph UI, pytest, network federation |
| 2026-06-15 | REUSE-WP-0011 closed priority 17; hub live at reuse.coulomb.social |
| 2026-06-15 | Post-WP-0011 refresh: 20 capabilities, vector D5/A4/C4/R3, priorities 1823 proposed |
| 2026-06-15 | REUSE-WP-0012 proposed; assessment archived in `history/2026-06-15-intent-scope-assessment.md` |
| 2026-06-15 | REUSE-WP-0012 proposed; assessment archived in `history/2026-06-15-intent-scope-assessment.md` |
| 2026-06-16 | REUSE-WP-0012 closed priorities 1923; priority 18 deferred on sibling index blocks; vector C5 |