docs(readme): restructure around reproducing the demo video - #375
Merged
Conversation
|
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 |
github-actions
Bot
added
docs
the readme accumulated sections a new user doesn't need on the way to their first working loop — 30-second tour, object model, file layout, cli surface, mcp method list, jsonl envelope shape, bundles, neighbour comparison, openclaw packaging, a stale pre-1.0 status note. all of that lives in SPEC.md, docs/, or --help output already. what remains maps one-to-one onto docs/vouch-how-it-works.mp4: install, wire claude code (init + install-mcp), set compile.llm_cmd, work a session, approve at the gate (review / review-ui), compile the wiki, recall in the next session, commit .vouch/. plus the three invariants underneath and a going-further link list. every command and claim in the new walkthrough was verified against the released 1.2.1 artifacts earlier today; all relative links checked against the tree.
plind-junior
force-pushed
the
docs/readme-video-flow
branch
from
July 6, 2026 05:18
1981a06 to
289b2d9
Compare
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
1 participant
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.
cuts the readme down to the one path that matters: a new user lands, installs, and ends up with exactly the loop docs/vouch-how-it-works.mp4 shows — capture, gate, approve, compile, recall. removed: 30-second tour, object model, file layout, cli surface, mcp method list, jsonl shape, bundles, neighbour table, openclaw packaging section, stale pre-1.0 status (superseded by SPEC.md, docs/, and --help).
the new 7-step walkthrough was verified command-by-command against the released 1.2.1 artifacts (fresh $HOME, latin-1 locale) earlier today; relative links checked against the tree.