docs(readme): embed an animated demo preview and cut redundancy#365
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
There was a problem hiding this comment.
Pull request overview
Updates the project README to improve the “watch it work” experience on GitHub (inline animated preview that links to the full MP4) while removing several large, redundant sections in favor of pointing readers to the canonical docs.
Changes:
- Replaces the static demo poster image link with an animated GIF preview that links through to the full MP4.
- Trims substantial duplicated content (tests, Gittensor walkthrough, full CLI dump, trust-metadata deep dive, “what ships today” table) to reduce README length and staleness risk.
- Tightens/reshapes several sections (install blurb, automatic session capture explanation, CLI surface summary, trust-metadata reference).
| vouch status | pending | review | show <id> # inspect the queue | ||
| vouch approve <id> [--reason ...] # the gate | ||
| vouch reject <id> --reason "..." | ||
|
|
||
| vouch propose-claim|propose-page|... # human mirror of the kb.propose_* tools | ||
| vouch search QUERY | context TASK | recall # retrieval | ||
| vouch compile [--dry-run] # llm-wiki ingest: draft topic pages from claims | ||
| vouch export | import-check | import-apply # portable bundles |
github renders no inline player for repo-committed mp4s, so the how-it-works poster becomes a 3x-speed animated gif preview (6.4mb, 720px, 10fps) that plays right in the readme and clicks through to the full video with audio. the unused poster jpg is removed; the committed mp4 stays as-is (already 720p/3.4mb, faststart). trims 145 lines of duplication: the running-the-tests section (contributing.md territory), the long gittensor walkthrough (the top callout + docs/gittensor.md cover it), the full cli dump (vouch --help / vouch capabilities), the trust-metadata deep-dive (spec.md), and the what-ships-today table. also drops the stale "per-runtime adapter templates not yet shipped" line — adapters/ ships them.
plind-junior
force-pushed
the
docs/readme-video-and-cleanup
branch
from
7c06862 to
a2bc8cd
Compare
github renders no inline player for repo-committed mp4s, so the how-it-works poster becomes a 3x-speed animated gif preview (6.4mb, 720px, 10fps) that plays right in the readme and clicks through to the full video with audio. the unused poster jpg is removed; the committed mp4 stays as-is (already 720p/3.4mb, faststart).
trims 145 lines of duplication: the running-the-tests section (contributing.md territory), the long gittensor walkthrough (the top callout + docs/gittensor.md cover it), the full cli dump (vouch --help / vouch capabilities), the trust-metadata deep-dive (spec.md), and the what-ships-today table. also drops the stale "per-runtime adapter templates not yet shipped" line — adapters/ ships them.
What changed
Why
What might break
VEP
Tests
make checkpasses locally (lint + mypy + pytest)CHANGELOG.mdupdated under## [Unreleased]