docs: VHS demo tape for the README GIF#25
Merged
Merged
Conversation
The README had grown to 488 lines with two quickstarts, a ~100-line Remote section, benchmark detail accidentally INSIDE the install code fence (the fence opened at the cargo block never closed before it), and a How-it-works section duplicating the reference doc. Now 172 lines: tagline -> why -> compact how-it-works -> ONE quickstart (install, setup one-shot, selftest, first memory) -> 4-line benchmark blurb -> 8-line Remote teaser -> what's-in-the-box -> docs index. Operational content moved VERBATIM (numbers are audit-verified) to two new topic pages: - docs/INSTALL.md — install paths (cargo/npm/prebuilt), host wiring matrix, auto-harvest + distiller, config toggles, maintenance & lifecycle. - docs/REMOTE.md — full server setup, client wiring, retrieval quality, server-side ingest + repos.toml. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Four beats: setup+selftest checkmark, record a failure_pattern the way an agent would, retrieve it with a paraphrase (semantic recall is the differentiator), brain insights. Render with vhs to docs/assets/demo.gif, then embed at the top of the README. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
VHS's command is Hide/Show; also split the hidden setup into one command per line so it works under Windows PowerShell 5.1 (no && chaining). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Rendered in the official VHS container (npm cold-install + bge-small via KIMETSU_BRAIN_EMBEDDER for snappy per-command model loads — jina-v2 costs 15-25s per fresh CLI process, which made an honest recording unwatchable). Verified frame-by-frame: setup's "✓ recorded a memory and retrieved it", memory_id from the add, and the paraphrase retrieval scoring 0.970. Tape: Sleep budgets sized to real command latency; setup uses --no-setup so the distiller wizard can't stall the recording. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Set PlaybackSpeed 2.0 + TypingSpeed 30ms: the recording keeps its honest sleep budgets (commands are never outrun) while the rendered timeline plays at double speed. Frame-verified: all four beats intact, the 0.970 paraphrase retrieval still lands on screen. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The npm path is the lowest-friction entry — no Rust required, and it's the cold-install-verified flow (lean install + npm-flavor embeddings switch). cargo and prebuilt archives stay in docs/INSTALL.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
2 participants
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.
Summary
docs/assets/demo.tape— a 60-second VHS script: setup + selftest checkmark → record a failure_pattern → retrieve it with a paraphrase (the semantic-recall beat) →brain insights.vhs docs/assets/demo.tapein a scratch dir with kimetsu on PATH) →docs/assets/demo.gif, then embed at the top of the README — the launch-readiness conversion asset.🤖 Generated with Claude Code