docs(gittensor): swap removed --template for a real session example - #342
Conversation
`vouch init --template gittensor` no longer exists — the flag was dropped from the cli in 1af9521 and `init` takes only --path — but the readme and the miner guide still advertised it, so the documented quickstart failed with "no such option". remove every mention of the template and replace the seeded-baseline section with a walkthrough of a real captured claude code session: actual `vouch` output for init, the pending auto-captured summary, the forbidden_self_approval gate with a second reviewer approving, and the recall digest the next session starts from. transcripts were generated against this tree and are trimmed only where marked.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughREADME.md and docs/gittensor.md are updated to remove the ChangesGittensor Documentation Update
Estimated code review effort: 1 (Trivial) | ~5 minutes Sequence Diagram(s)sequenceDiagram
participant Miner
participant CLI as vouch CLI
participant KB as Knowledge Base
participant Reviewer
Miner->>CLI: vouch pending
CLI-->>Miner: show pending page
Miner->>CLI: vouch show
CLI-->>Miner: git diffs and observations
Miner->>CLI: vouch source add
Miner->>CLI: vouch propose-claim
Miner->>CLI: vouch approve (self)
CLI-->>Miner: forbidden self-approval error
Reviewer->>CLI: vouch approve
CLI->>KB: mark claim approved
Miner->>CLI: vouch recall
CLI-->>Miner: approved claims/pages
Suggested labels: ✨ 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 |
There was a problem hiding this comment.
Pull request overview
This PR updates the Gittensor (SN74) documentation to remove the now-removed vouch init --template gittensor flag and replace the “seeded baseline” flow with a real captured-session walkthrough so the quickstart matches the current CLI surface.
Changes:
- Removes the deprecated
--template gittensorquickstart mentions from the README and adjusts the example loop to use plainvouch init. - Reworks
docs/gittensor.mdto show an end-to-end session capture → pending → approval (includingforbidden_self_approval) → next-sessionvouch recalldigest, using transcript-style output.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| README.md | Removes deprecated init-template wording and updates the SN74 quickstart loop to use vouch init. |
| docs/gittensor.md | Replaces the template-seed section with a real-session, capture/review/recall walkthrough and updated init instructions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| A real run against a whitelisted Go repo, `acme-httpkit`. Every snippet below | ||
| is actual `vouch` output (paths shortened; trimmed where marked `…`). |
|
|
||
| ```console | ||
| $ vouch approve 20260702-065648-dd727615 --reason "accurate session summary" | ||
| Approved → page/session-summary-acme-httpkit-9f4c2d1e-7a53-4b08-b6d2-3c1e5a9 |
|
|
||
| ```console | ||
| $ VOUCH_USER=blake-example vouch approve 20260702-065718-607dc50c --reason "matches CONTRIBUTING.md" | ||
| Approved → claim/acme-httpkit-merges-require-make-test-green-and-a-changelog- |
| # approved KB knowledge for this repo — 2 claim(s), 2 page(s). reviewed, cited, durable. … | ||
|
|
||
| ## claims | ||
| - [acme-httpkit-merges-require-make-test-green-and-a-changelog-] acme-httpkit merges require 'make test' green and a CHANGELOG entry; PRs without a regression test are rejected. |
|
|
||
| ## pages | ||
| … | ||
| - [session-summary-acme-httpkit-9f4c2d1e-7a53-4b08-b6d2-3c1e5a9] session summary: acme-httpkit (9f4c2d1e-7a53-4b08-b6d2-3c1e5a90f7ab) |
| ```bash | ||
| cd acme-httpkit # a whitelisted target repo — Go, healthy allocation | ||
| vouch init --template gittensor # seeds a cited baseline of how SN74 scores today | ||
| vouch init # review-gated KB at .vouch/ |
vouch init --template gittensorno longer exists — the flag was dropped from the cli in 1af9521 andinittakes only --path — but the readme and the miner guide still advertised it, so the documented quickstart failed with "no such option".remove every mention of the template and replace the seeded-baseline section with a walkthrough of a real captured claude code session: actual
vouchoutput for init, the pending auto-captured summary, the forbidden_self_approval gate with a second reviewer approving, and the recall digest the next session starts from. transcripts were generated against this tree and are trimmed only where marked.What changed
Why
What might break
VEP
Tests
make checkpasses locally (lint + mypy + pytest)CHANGELOG.mdupdated under## [Unreleased]Summary by CodeRabbit