Skip to content

docs(gittensor): swap removed --template for a real session example - #342

Merged
plind-junior merged 1 commit into
mainfrom
docs/remove-gittensor-template-refs
Jul 2, 2026
Merged

docs(gittensor): swap removed --template for a real session example#342
plind-junior merged 1 commit into
mainfrom
docs/remove-gittensor-template-refs

Conversation

@plind-junior

@plind-junior plind-junior commented Jul 2, 2026

Copy link
Copy Markdown
Member

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.

What changed

Why

What might break

VEP

Tests

  • make check passes locally (lint + mypy + pytest)
  • New / changed behaviour has a test
  • CHANGELOG.md updated under ## [Unreleased]

Summary by CodeRabbit

  • Documentation
    • Updated the Gittensor setup guide and README to match the current onboarding flow.
    • Added a more detailed step-by-step example for reviewing, approving, and recalling mined repository content.
    • Clarified how approved decisions persist across sessions and how superseding works without overwriting prior results.

`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.
Copilot AI review requested due to automatic review settings July 2, 2026 07:47
@plind-junior
plind-junior merged commit 73184a0 into main Jul 2, 2026
12 checks passed
@github-actions github-actions Bot added docs documentation, specs, examples, and repo guidance size: XS less than 50 changed non-doc lines labels Jul 2, 2026
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 35a85b7d-2c19-4fad-9b1d-3dd4ec81ee4b

📥 Commits

Reviewing files that changed from the base of the PR and between b671bf1 and 36601e9.

📒 Files selected for processing (2)
  • README.md
  • docs/gittensor.md

📝 Walkthrough

Walkthrough

README.md and docs/gittensor.md are updated to remove the vouch init --template gittensor seeding instructions in favor of a plain vouch init flow, and the Gittensor mining session example is expanded into a detailed, concrete worked example with additional CLI outputs.

Changes

Gittensor Documentation Update

Layer / File(s) Summary
README blurb and example walkthrough
README.md
Removes inline --template gittensor seeding mention, linking instead to docs/gittensor.md, and rewrites the example session to use plain vouch init followed by vouch install-mcp claude-code.
KB initialization section rewrite
docs/gittensor.md
Replaces the "seed the scoring baseline" template instructions with a vouch init walkthrough, example output, and commit guidance for .vouch.
Detailed mining session example
docs/gittensor.md
Expands the session narrative into a full worked example (vouch pending, vouch show, vouch source add, vouch propose-claim, forbidden self-approval error, approval by another reviewer, vouch recall output) and rewords the supersede section scenario.

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
Loading

Suggested labels: enhancement

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/remove-gittensor-template-refs

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.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 gittensor quickstart mentions from the README and adjusts the example loop to use plain vouch init.
  • Reworks docs/gittensor.md to show an end-to-end session capture → pending → approval (including forbidden_self_approval) → next-session vouch recall digest, 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.

Comment thread docs/gittensor.md
Comment on lines +91 to +92
A real run against a whitelisted Go repo, `acme-httpkit`. Every snippet below
is actual `vouch` output (paths shortened; trimmed where marked `…`).
Comment thread docs/gittensor.md

```console
$ vouch approve 20260702-065648-dd727615 --reason "accurate session summary"
Approved → page/session-summary-acme-httpkit-9f4c2d1e-7a53-4b08-b6d2-3c1e5a9
Comment thread docs/gittensor.md

```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-
Comment thread docs/gittensor.md
# 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.
Comment thread docs/gittensor.md

## pages
- [session-summary-acme-httpkit-9f4c2d1e-7a53-4b08-b6d2-3c1e5a9] session summary: acme-httpkit (9f4c2d1e-7a53-4b08-b6d2-3c1e5a90f7ab)
Comment thread README.md
```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/
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.

2 participants