chore: promote test branch to main (desktop app + examples)#292
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).
docs(examples): runnable, verified examples for the full kb.* surface
brings the vouch-desktop electron app into the repo as a monorepo directory. desktop/ is a self-contained typescript + react + vite + electron app that drives vouch as a child process over the jsonl and review-ui transports, and never writes durable kb state except through the review gate. node_modules/, out/, dist/, and release/ are gitignored via desktop/.gitignore; only source is committed (78 files). the python ci gate is unaffected — ruff, mypy, and pytest target src/ and tests/, not desktop/. note: this softens the repo's "buildless, no npm" guidance to "buildless python package, with the node/vite toolchain fenced under desktop/".
feat(desktop): add the electron desktop app under desktop/ (monorepo)
the example KBs under examples/ were text-only: the READMEs told a reader to copy a fixture and run vouch status / search / show / audit without showing what those commands return. someone evaluating vouch on github had to install it and load a fixture before seeing anything. adds terminal screenshots rendered straight from the shipped fixtures: * docs/img/examples/render.py — a stdlib-only generator. copies a fixture to a throwaway .vouch, runs each documented command with colour off, normalises the one volatile token (the absolute kb path), and renders the output to a self-contained terminal-style svg. svg is text, so it diffs cleanly in prs and re-renders byte-for-byte. * docs/img/examples/*.svg — tiny/: status, search auth, show prop-001, audit. decision-log/: search free-tier and a supersession diff. * examples/README.md, examples/tiny/README.md, examples/decision-log/README.md embed the images. * make examples-screenshots regenerates them. * tests/test_example_screenshots.py asserts the renderer is pure, escapes xml, and the committed svgs match a fresh render. chose deterministic svg over the vhs/.tape path the issue suggested: vhs needs ttyd + ffmpeg, while this needs only python + the vouch cli and produces text-diffable output. the audit-trail shot uses tiny/ (the fixture that ships an audit log) and the supersession shot uses decision-log/; no fixture is modified. web review-ui and desktop gui captures are left as a follow-up since they need a browser/electron runtime to capture deterministically. closes #286
docs(examples): add reproducible screenshots of the sample KBs
|
Important Review skippedToo many files! This PR contains 187 files, which is 37 over the limit of 150. To get a review, narrow the scope: Upgrade to a paid plan to raise the limit. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (11)
📒 Files selected for processing (187)
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 |
github-actions
Bot
added
docs
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
2 participants
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.
promotes the current
testbranch state ontomain. bundles the six commits thattestcarries overmain:feat(desktop): electron desktop app underdesktop/(monorepo layout, feat(desktop): add the electron desktop app under desktop/ (monorepo) #285)docs(examples): runnable, verified examples covering the fullkb.*surface (docs(examples): runnable, verified examples for the full kb.* surface #284)docs(examples): reproducible screenshots of the sample KBs with arender.pygenerator andtest_example_screenshots.py(docs(examples): add reproducible screenshots of the sample KBs #290)no new code paths bypass the review gate — this is documentation, examples, and the desktop companion app.
make checkstate is inherited from the already-merged sub-PRs (#284, #285, #290).