Skip to content

docs(examples): runnable, verified examples for the full kb.* surface - #284

Merged
plind-junior merged 1 commit into
testfrom
docs/examples
Jun 30, 2026
Merged

docs(examples): runnable, verified examples for the full kb.* surface#284
plind-junior merged 1 commit into
testfrom
docs/examples

Conversation

@plind-junior

Copy link
Copy Markdown
Member

summary

adds runnable, verified examples covering the full kb.* surface (all 54
methods), mirroring AKBP's examples in shape (README.md + run.sh) while
keeping vouch's existing <name>/vouch/ snapshot convention. an auditable
method → example coverage matrix lives in examples/README.md.

what's added

  • 17 runnable flows — each builds a throwaway KB in a temp dir, drives the
    real CLI / JSONL surface, asserts the end state, and cleans up: review gate,
    dry-run preview, jsonl quickstart, search backends, context + synthesize,
    browse/read, the propose family, lifecycle, sessions + crystallize, graph +
    provenance, maintenance/health, embeddings, export/import bundles, audit,
    scoping.
  • 4 playbooks — for features that spawn external agents or hit the network
    (dual-solve, auto-pr, vault sync, install-mcp): the safe legs run, the
    dangerous command is printed with its requirements rather than executed.
  • 2 conformance-level snapshotslevel-0-markdown-wiki, level-3-graph,
    in the existing snapshot style.

verification

every run.sh was run exit-0 against vouch 1.0.0 (during authoring and
re-checked independently). generic placeholder data only (alice-example,
acme-example).

coverage

all 54 kb.* methods are mapped to at least one example in
examples/README.md; nothing under "Not yet covered". the matrix doubles as a
regression guard — add a method, add a row.

adds 23 examples that together demonstrate every one of the 54 kb.* methods,
with an auditable method -> example coverage matrix in examples/README.md.

- 17 runnable flows (README.md + run.sh): each builds a throwaway KB in a temp
  dir, drives the real CLI / JSONL surface, asserts the end state, and cleans up.
  covers the review gate, dry-run preview, jsonl quickstart, search backends,
  context + synthesize, browse/read, the propose family, lifecycle, sessions +
  crystallize, graph + provenance, maintenance/health, embeddings, export/import
  bundles, audit, and scoping.
- 4 playbooks for the features that spawn external agents or hit the network
  (dual-solve, auto-pr, vault sync, install-mcp): the safe legs run, the
  dangerous command is printed with its requirements rather than executed.
- 2 conformance-level snapshots (level-0 markdown wiki, level-3 graph) in the
  existing <name>/vouch/ snapshot convention.

every run.sh was verified exit-0 against vouch 1.0.0. generic placeholder data
only (alice-example, acme-example).
@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 7dcd4d82-d514-42ad-8c9b-a36c6c58a836

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/examples

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added docs documentation, specs, examples, and repo guidance size: XS less than 50 changed non-doc lines labels Jun 30, 2026
@plind-junior
plind-junior merged commit 92c4b13 into test Jun 30, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs documentation, specs, examples, and repo guidance size: XS less than 50 changed non-doc lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant