CONSUMER-ADAPTER-PATTERN.md markdown
91 lines 3.3 KB
Raw
sha256:4671b7f787ddbe63ced31c895b688c77ab495653b65a730b423329f26b3c1439 feat: K1-P1 complete — agent provenance, build-verification… Sonnet 4.6 patch 55 days ago

Consumer adapter pattern

Purpose: How any repo adopts Overseer Kit without forking kit core.
Normative freeze: docs/PHASE-K9A-L1-L2-MODULE-FREEZE.md §K9.0 / §K9.12.


Simple version

Install the kit, point .overseer/config.yaml at your docs, and keep your product-specific checks in your repo. The kit supplies the shared machinery; you supply what “good” means for your domain.

Technical version

Layer Kit owns Consumer owns
L0 init/sync/status/review/governance-sync, templates, adapters Living docs content, docs.lanes, VCS regime
L1 Orchestrator + policy/manifest schemas + verify-step policy/checkpoints.yaml, verify scripts, manifests
L2 Ledger engine + roles + co-requirement hooks Hook call sites, domain DoD, optional roster path (roles_file — v1 warn/ignore)
L3 Regime adapters (realign/mirror) Choosing muse+git-mirror when ready

Install skeleton

KIT=/path/to/overseer-kit
REPO=/path/to/consumer

$KIT/cli/overseer -C $REPO init --migrate \
  --from-config $KIT/tests/fixtures/pilot/config-<consumer>.yaml \
  --non-interactive --dry-run
# then apply without --dry-run
$KIT/cli/overseer -C $REPO status --check-footprint

Customize only .overseer/config.yaml (regime, doc paths, future checkpoints: / honesty:).


L0 — lanes vs rows vs repos

  • Lanes — few durable handover/roadmap pairs (docs.lanes).
  • Rows / L1 manifests — many instances of the same concern (videos, papers, closes).
  • Repos — different trust boundaries or VCS regimes.

See docs/PHASE-K8-MULTI-LANE-DOCS-CONTRACT.md and vision §5.2.


L1 — domain pack checklist

  1. Write policy/checkpoints.yaml (steps + templates + optional overrides).
  2. Ship scripts/verify/* that exit 0/≠0 (no placeholders in verified paths).
  3. Point checkpoints.active_manifest at the active work-unit manifest.
  4. Call overseer verify-step --step … after every step; never hand-set verified: true.
  5. Keep detailed grids in consumer boards/JSON; L0 board stays a summary row if needed.

L2 — honesty wiring checklist

  1. Enable honesty: and set ledger path.
  2. Set require_verdict_on to the hooks you enforce (absent → all three; hook not in list → honesty-status refuses 4).
  3. At every enabled board_done / handoff / register boundary, call
    overseer honesty-status --hook … --artifact … (pass --producer-session when known).
  4. Verifier sessions re-run L1/domain scripts and overseer ledger append --kind verdict (first append auto-writes a genesis line when the ledger is empty — no manual init required).
  5. Do not treat producer self-reports as evidence. Optional roles_file is path-checked only in v1 (enum roles still apply; roster content is not loaded for enforcement).

Reference consumers

Consumer Kit docs
VideoFactory docs/consumers/videofactory/OVERSEER-SETUP.md, CHECKPOINT-BUILD-PROMPT.md
MuseHub / Knowtation / Scooling Add under docs/consumers/<name>/ when piloted

Fixture configs: tests/fixtures/pilot/.


Hard rules

  • Never hardcode another product’s paths into kit core.
  • Never require MuseHub for L0–L2 baseline.
  • Never use an LLM as the pass/fail authority for measurable artifacts.
File History 1 commit
sha256:4671b7f787ddbe63ced31c895b688c77ab495653b65a730b423329f26b3c1439 feat: K1-P1 complete — agent provenance, build-verification… Sonnet 4.6 patch 55 days ago