Repository navigation
docs(demo): re-record the demo with v0.4.0 features and stand-in project names #74
Copy link
Copy link
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationready-for-agentFully specified, ready for an AFK agentFully specified, ready for an AFK agentwayfinder:taskWayfinder ticket: implementation taskWayfinder ticket: implementation task
Description
Part of #61. The last ticket of the map: it records the v0.4.0 features.
What
Rebuild demo/setup.sh and demo/demo.tape, re-record demo/demo.gif, and update the README demo section.
Projects shown
- No real project names: the current setup uses the maintainer's own projects (
kryft.dev,wowaitech.com,grg, …). Remove them. - Use names of well-known open-source repos instead, e.g.
next.js,go,react,kubernetes,rust,deno,vscode,tailwindcss,django,linux. These are emptygit initdirectories with one commit, not clones. - Put them under
~/Codeand~/Workin the real home directory (not/tmp), so paths in the GIF read~/Code/next.jsand~/Work/acme/api. Include a few nested ones and one non-git directory to showcdd add. setup.shmust refuse to run if~/Codeor~/Workalready exists. It must never delete anything it didn't create.- cdd's own state must not touch the real config or History: point
XDG_CONFIG_HOME,XDG_DATA_HOMEandXDG_STATE_HOMEat a demo directory (e.g.~/.cache/cdd-demo). - Add a teardown (
demo/teardown.sh, orsetup.sh --clean) that deletes~/Code,~/Workand the demo state directory, and run it after recording. Verify afterwards that they're gone.
Recording
-
Slower: slower typing speed and longer pauses so a viewer can follow each step.
-
Before each step, type a comment explaining it, then run the command. For example:
# scan these dirs once to find every git repo under them cdd scan ~/Code ~/Work -
Show more of the features, in order:
cdd scan- Opening the Picker and filtering with a multi-word Query
- Enter to Jump, then
pwd - The key-hint footer
- A custom Action from a demo config, e.g.
ctrl+lrunning a fake lazygit stand-in ctrl+ycopy andctrl+gremote, which leave the Picker open with a footer message (stub the browser opener so nothing really opens)cdd addon a non-git dir and seeing it in the Pickerctrl+dforgetcdd config init
Keep the whole GIF to a reasonable length (aim for under about 60s).
-
Use VHS v0.11.0 (v0.12.0 silently writes no GIF). After recording, check that
demo/demo.gifexists and actually changed, and look at a few frames.
Review gate
Do not merge. Open the PR and stop; the maintainer reviews the GIF before merging.
Acceptance
- No real project names appear anywhere in
demo/, the tape or the GIF. -
~/Code,~/Workand the demo state directory are gone after teardown. - The PR is open and unmerged, awaiting review.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationready-for-agentFully specified, ready for an AFK agentFully specified, ready for an AFK agentwayfinder:taskWayfinder ticket: implementation taskWayfinder ticket: implementation task
Activity
docs(demo): stand-in projects in ~/Code and ~/Work, with a teardown (#74
docs(demo): a slower, commented tape showing the v0.4.0 features (#74)
docs(demo): re-record the demo GIF (#74)
docs: README demo comment names setup, record and teardown (#74)
hammadmajid commentedon Oct 2, 2026
Done in PR #86, reviewed and approved by the maintainer.