feat(init): seed starter KB for first-run onboarding#55
Conversation
|
Caution Review failedPull request was closed or merged during review 📝 WalkthroughWalkthroughThis PR adds a deterministic, idempotent starter KB seeder and integrates it into ChangesOnboarding First-Run Experience
Sequence Diagram(s)sequenceDiagram
participant User
participant CLI as "vouch init"
participant Seeder as seed_starter_kb
participant Store as KBStore
participant Index as "search index"
User->>CLI: run `vouch init`
CLI->>Seeder: seed_starter_kb(store, approved_by)
Seeder->>Store: check/create starter source (sha256 id)
Seeder->>Store: get_claim / put_claim if missing (with evidence)
Seeder->>CLI: return StarterSeedResult
CLI->>Index: rebuild index
CLI->>User: print Next steps and created-claim id (if any)
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 121: Replace the ambiguous fragment "claims/vouch-starter-..." with an
explicit claim file pattern (for example "claims/vouch-starter-*.claim") so it
reads like the other entries in README.md; update the line that currently
contains that fragment to include the file extension and wildcard to indicate
it’s a claim filename pattern.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: df302aa3-5548-41d7-8c74-5bba08775536
📒 Files selected for processing (6)
CHANGELOG.mdREADME.mdsrc/vouch/cli.pysrc/vouch/onboarding.pysrc/vouch/storage.pytests/test_onboarding.py
|
Fix MR conflict |
9389133 to
4cab53e
Compare
4cab53e to
125c054
Compare
|
@plind-junior Pls review again |
|
It's really needed, thanks for your contribution @bittoby |
…a256-verification Brings in vouchdev#60 (FTS5 indexing of crystallize summary page) and vouchdev#55 onboarding seed from main. CHANGELOG conflict resolved by keeping both the incoming vouchdev#60 entry and the local vouchdev#74 sha256-verification entry.
What changed
vouch initnow seeds a starter source and cited starter claim, rebuilds the search index, and prints concrete next steps. The README also includes a 30-second tour that works against the seeded starter KB.Why
This makes first-run onboarding smoother for new users and agents by giving them an immediately searchable, cited example KB instead of an empty
.vouch/directory. Part of #54.What might break
No files move. No object model, bundle format, audit-log shape, or
kb.*method changes.Newly initialized KBs will contain one starter source and one starter claim by default. Existing KBs can also receive that starter content if
vouch initis run again and the starter claim is not already present.VEP
Not required. This does not change the object model,
kb.*methods, on-disk schema/layout, bundle format, or audit-log shape.Tests
make checkpasses locally (lint + mypy + pytest)CHANGELOG.mdupdated under## [Unreleased]Summary by CodeRabbit
vouch initnow seeds a starter knowledge base (starter source + reviewed claim) and prints clearer multi-step "Next steps" guidance.