docs(examples): runnable, verified examples for the full kb.* surface - #284
Merged
Conversation
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).
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
summary
adds runnable, verified examples covering the full
kb.*surface (all 54methods), mirroring AKBP's examples in shape (
README.md+run.sh) whilekeeping vouch's existing
<name>/vouch/snapshot convention. an auditablemethod → example coverage matrix lives in
examples/README.md.what's added
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.
(
dual-solve,auto-pr, vault sync,install-mcp): the safe legs run, thedangerous command is printed with its requirements rather than executed.
level-0-markdown-wiki,level-3-graph,in the existing snapshot style.
verification
every
run.shwas run exit-0 againstvouch1.0.0 (during authoring andre-checked independently). generic placeholder data only (
alice-example,acme-example).coverage
all 54
kb.*methods are mapped to at least one example inexamples/README.md; nothing under "Not yet covered". the matrix doubles as aregression guard — add a method, add a row.