Skip to content

docs: add a throwaway demo environment and VHS tape - #48

Merged
hammadmajid merged 3 commits into
mainfrom
docs/demo-setup
Sep 16, 2026
Merged

hammadmajid merged 3 commits into
mainfrom
docs/demo-setup

Conversation

@hammadmajid

Copy link
Copy Markdown
Contributor

Recording the README demo must never touch the maintainer's real Root, config, or History.

  • demo/setup.sh builds /tmp/cdd-demo (override with DEMO_DIR): a fake Root with five Kinds and eleven Projects in varied git states (clean, modified, untracked, ahead by one, not a repository, hidden), its own XDG_CONFIG_HOME and XDG_DATA_HOME, the binary built from the checkout, a cdd scan, and three backdated Jumps.
  • demo/demo.tape is the VHS script. It sets the XDG variables via Env, sources the fish Wrapper in a hidden block, and records opening the Picker, moving, filtering, and Jumping.
  • README's Demo section now references demo/demo.gif, to be produced with demo/setup.sh && vhs demo/demo.tape.

Verified: the setup script runs clean, the Picker renders all eleven Projects with the expected glyphs against it, and a Jump through the fish Wrapper records into the demo History only.

🤖 Generated with Claude Code

hammadmajid and others added 3 commits September 17, 2026 04:29
…ings

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@hammadmajid
hammadmajid merged commit 9c6a1f4 into main Sep 16, 2026
3 checks passed
@hammadmajid
hammadmajid deleted the docs/demo-setup branch September 16, 2026 23:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant