Skip to content

Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows

Move demos to docs/demos/ and fix gitignore for generated output

Maximilian Roosbd610f219d31
diff --git a/.gitignore b/.gitignore
index 93eaf07a7..5389ffdd9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,6 @@
/target
-dev/wt-demo/out/
+docs/demos/wt/out/
+docs/demos/wt-select/out/
docs/static/assets/
# Lychee link checker cache
@@ -10,4 +11,4 @@ test-concurrent.sh
*.snap.new
*.snap.pending
logo-variant-*.png
-demos/wt-select/vhs-keystrokes/
+docs/demos/wt-select/vhs-keystrokes/
diff --git a/docs/CLAUDE.md b/docs/CLAUDE.md
index f8d6d6fb4..9a18b7574 100644
--- a/docs/CLAUDE.md
+++ b/docs/CLAUDE.md
@@ -197,9 +197,9 @@ Demo GIFs (~2MB each) are stored in a separate `worktrunk-assets` repo to avoid
**To update demos:**
```bash
-./demos/wt-demo/build # Build from VHS tape file
-./demos/wt-select/build # Build select demo
-./scripts/publish-assets # Push to assets repo
+./docs/demos/wt/build # Build from VHS tape file
+./docs/demos/wt-select/build # Build select demo
+./scripts/publish-assets # Push to assets repo
```
Deploy runs `fetch-assets` before building.
diff --git a/demos/lib.py b/docs/demos/lib.py
similarity index 100%
rename from demos/lib.py
rename to docs/demos/lib.py
diff --git a/demos/wt-select/.gitignore b/docs/demos/wt-select/.gitignore
similarity index 100%
rename from demos/wt-select/.gitignore
rename to docs/demos/wt-select/.gitignore
diff --git a/demos/wt-select/CLAUDE.md b/docs/demos/wt-select/CLAUDE.md
similarity index 90%
rename from demos/wt-select/CLAUDE.md
rename to docs/demos/wt-select/CLAUDE.md
index b3b68b0c5..58151515a 100644
--- a/demos/wt-select/CLAUDE.md
+++ b/docs/demos/wt-select/CLAUDE.md
@@ -3,12 +3,12 @@
## Running the Demo
```bash
-./demos/wt-select/build
+./docs/demos/wt-select/build
```
Creates:
-- `demos/wt-select/out/wt-select.gif` - Animated demo
-- Demo repo at `demos/wt-select/out/.demo-select/` (gitignored)
+- `docs/demos/wt-select/out/wt-select.gif` - Animated demo
+- Demo repo at `docs/demos/wt-select/out/.demo-select/` (gitignored)
## Demo Goals
@@ -60,8 +60,8 @@ Without the future timestamp, cache expires during recording → tries to fetch
**Do NOT use `open` on the GIF** - that's for the user to do manually.
Inline viewing options:
-- Quick Look: `qlmanage -p dev/wt-select-demo/out/wt-select-demo.gif`
-- iTerm2: `imgcat dev/wt-select-demo/out/wt-select-demo.gif`
+- Quick Look: `qlmanage -p docs/demos/wt-select/out/wt-select.gif`
+- iTerm2: `imgcat docs/demos/wt-select/out/wt-select.gif`
## Prerequisites
@@ -77,14 +77,14 @@ This demo uses a **custom fork of VHS** with keystroke overlay support:
The fork adds a large keystroke overlay that appears in the center of the screen, showing what keys are being pressed. This is essential for demo GIFs where viewers need to see what's being typed.
-To build (from the `demos/wt-select/` directory):
+To build (from the `docs/demos/wt-select/` directory):
```bash
git clone -b keypress-overlay https://github.com/max-sixty/vhs.git vhs-keystrokes
cd vhs-keystrokes
go build -o vhs-keystrokes .
```
-The build script looks for the binary at `demos/wt-select/vhs-keystrokes/vhs-keystrokes` by default.
+The build script looks for the binary at `docs/demos/wt-select/vhs-keystrokes/vhs-keystrokes` by default.
Override with: `VHS_KEYSTROKES=/path/to/binary ./build`
### Keystroke Timing Calibration
diff --git a/demos/wt-select/build b/docs/demos/wt-select/build
similarity index 99%
rename from demos/wt-select/build
rename to docs/demos/wt-select/build
index 8faf98793..689d47dbe 100755
--- a/demos/wt-select/build
+++ b/docs/demos/wt-select/build
@@ -2,7 +2,7 @@
"""Build script for wt select demo GIF.
Creates a demo environment using cherry-picked commits from this repo,
-records the GIF, and saves output to demos/wt-select/out/.
+records the GIF, and saves output to docs/demos/wt-select/out/.
DEMO GOALS
==========
@@ -57,14 +57,14 @@ import sys
from datetime import datetime, timedelta
from pathlib import Path
-# Add demos/ to path for shared library
+# Add docs/demos/ to path for shared library
SCRIPT_DIR = Path(__file__).parent
DEMOS_DIR = SCRIPT_DIR.parent
sys.path.insert(0, str(DEMOS_DIR))
from lib import DemoEnv, run, git, render_tape, record_vhs, build_wt, REAL_HOME
-REPO_ROOT = DEMOS_DIR.parent
+REPO_ROOT = DEMOS_DIR.parent.parent
FIXTURES_DIR = SCRIPT_DIR / "fixtures"
OUT_DIR = SCRIPT_DIR / "out"
TAPE_TEMPLATE = SCRIPT_DIR / "demo.tape"
diff --git a/demos/wt-select/demo.tape b/docs/demos/wt-select/demo.tape
similarity index 72%
rename from demos/wt-select/demo.tape
rename to docs/demos/wt-select/demo.tape
index 1c2357205..20b3bfd0d 100644
--- a/demos/wt-select/demo.tape
+++ b/docs/demos/wt-select/demo.tape
@@ -8,7 +8,7 @@ Set FontSize 19
Set FontFamily "Geist Mono, Berkeley Mono, Fira Code, JetBrains Mono, Menlo, Apple Color Emoji"
Set Width 1600
Set Height 800
-Set Theme { "name": "GitHub Light Custom", "black": "#8c959f", "red": "#d73a49", "green": "#22863a", "yellow": "#d29922", "blue": "#0969da", "magenta": "#8250df", "cyan": "#1b7c83", "white": "#8c959f", "brightBlack": "#8c959f", "brightRed": "#cb2431", "brightGreen": "#2ea043", "brightYellow": "#f2cc60", "brightBlue": "#218bff", "brightMagenta": "#a475f9", "brightCyan": "#39c5cf", "brightWhite": "#8c959f", "background": "#f0f2f5", "foreground": "#1f2328", "cursor": "#0969da", "selection": "#ddf4ff" }
+Set Theme { "name": "Warm Gold Light", "black": "#8c959f", "red": "#d73a49", "green": "#22863a", "yellow": "#d29922", "blue": "#0969da", "magenta": "#8250df", "cyan": "#1b7c83", "white": "#8c959f", "brightBlack": "#8c959f", "brightRed": "#cb2431", "brightGreen": "#2ea043", "brightYellow": "#f2cc60", "brightBlue": "#218bff", "brightMagenta": "#a475f9", "brightCyan": "#39c5cf", "brightWhite": "#8c959f", "background": "#FFF9E8", "foreground": "#1f2328", "cursor": "#0969da", "selection": "#FFF0C8" }
Set Padding 18
Set LineHeight 1.12
Set TypingSpeed 28ms
@@ -39,7 +39,6 @@ Type "clear"
Enter
Sleep 500ms
Show
-Set KeyStrokes Show
Sleep 500ms
# Launch wt select
diff --git a/demos/wt-demo/fixtures/starship.toml b/docs/demos/wt-select/fixtures/starship.toml
similarity index 100%
rename from demos/wt-demo/fixtures/starship.toml
rename to docs/demos/wt-select/fixtures/starship.toml
diff --git a/demos/wt-demo/build b/docs/demos/wt/build
similarity index 99%
rename from demos/wt-demo/build
rename to docs/demos/wt/build
index 03d28583e..b538b54e4 100755
--- a/demos/wt-demo/build
+++ b/docs/demos/wt/build
@@ -9,14 +9,14 @@ import sys
from datetime import datetime, timedelta
from pathlib import Path
-# Add demos/ to path for shared library
+# Add docs/demos/ to path for shared library
SCRIPT_DIR = Path(__file__).parent
DEMOS_DIR = SCRIPT_DIR.parent
sys.path.insert(0, str(DEMOS_DIR))
from lib import DemoEnv, run, git, render_tape, record_vhs, build_wt, REAL_HOME
-REPO_ROOT = DEMOS_DIR.parent
+REPO_ROOT = DEMOS_DIR.parent.parent
FIXTURES_DIR = SCRIPT_DIR / "fixtures"
OUT_DIR = SCRIPT_DIR / "out"
TAPE_TEMPLATE = SCRIPT_DIR / "demo.tape"
diff --git a/demos/wt-demo/demo.tape b/docs/demos/wt/demo.tape
similarity index 71%
rename from demos/wt-demo/demo.tape
rename to docs/demos/wt/demo.tape
index 87bc2eb58..6b8610ec7 100644
--- a/demos/wt-demo/demo.tape
+++ b/docs/demos/wt/demo.tape
@@ -8,7 +8,7 @@ Set FontSize 19
Set FontFamily "Geist Mono, Berkeley Mono, Fira Code, JetBrains Mono, Menlo, Apple Color Emoji"
Set Width 1600
Set Height 720
-Set Theme { "name": "GitHub Light Custom", "black": "#8c959f", "red": "#d73a49", "green": "#22863a", "yellow": "#d29922", "blue": "#0969da", "magenta": "#8250df", "cyan": "#1b7c83", "white": "#8c959f", "brightBlack": "#8c959f", "brightRed": "#cb2431", "brightGreen": "#2ea043", "brightYellow": "#f2cc60", "brightBlue": "#218bff", "brightMagenta": "#a475f9", "brightCyan": "#39c5cf", "brightWhite": "#8c959f", "background": "#f0f2f5", "foreground": "#1f2328", "cursor": "#0969da", "selection": "#ddf4ff" }
+Set Theme { "name": "Warm Gold Light", "black": "#8c959f", "red": "#d73a49", "green": "#22863a", "yellow": "#d29922", "blue": "#0969da", "magenta": "#8250df", "cyan": "#1b7c83", "white": "#8c959f", "brightBlack": "#8c959f", "brightRed": "#cb2431", "brightGreen": "#2ea043", "brightYellow": "#f2cc60", "brightBlue": "#218bff", "brightMagenta": "#a475f9", "brightCyan": "#39c5cf", "brightWhite": "#8c959f", "background": "#FFF9E8", "foreground": "#1f2328", "cursor": "#0969da", "selection": "#FFF0C8" }
Set Padding 18
Set LineHeight 1.12
Set TypingSpeed 28ms
diff --git a/demos/wt-demo/fixtures/alpha-readme.md b/docs/demos/wt/fixtures/alpha-readme.md
similarity index 100%
rename from demos/wt-demo/fixtures/alpha-readme.md
rename to docs/demos/wt/fixtures/alpha-readme.md
diff --git a/demos/wt-demo/fixtures/gh-mock.sh b/docs/demos/wt/fixtures/gh-mock.sh
similarity index 100%
rename from demos/wt-demo/fixtures/gh-mock.sh
rename to docs/demos/wt/fixtures/gh-mock.sh
diff --git a/demos/wt-demo/fixtures/lib-hooks.rs b/docs/demos/wt/fixtures/lib-hooks.rs
similarity index 100%
rename from demos/wt-demo/fixtures/lib-hooks.rs
rename to docs/demos/wt/fixtures/lib-hooks.rs
diff --git a/demos/wt-demo/fixtures/lib.rs b/docs/demos/wt/fixtures/lib.rs
similarity index 100%
rename from demos/wt-demo/fixtures/lib.rs
rename to docs/demos/wt/fixtures/lib.rs
diff --git a/demos/wt-select/fixtures/starship.toml b/docs/demos/wt/fixtures/starship.toml
similarity index 100%
rename from demos/wt-select/fixtures/starship.toml
rename to docs/demos/wt/fixtures/starship.toml
diff --git a/scripts/publish-assets b/scripts/publish-assets
index 08150df63..28bdf67cc 100755
--- a/scripts/publish-assets
+++ b/scripts/publish-assets
@@ -8,8 +8,8 @@ ASSETS_REPO="$REPO_ROOT/../worktrunk-assets"
# Demo sources: name|source_path
DEMOS=(
- "wt-demo.gif|$REPO_ROOT/demos/wt-demo/out/wt-demo.gif"
- "wt-select.gif|$REPO_ROOT/demos/wt-select/out/wt-select.gif"
+ "wt-demo.gif|$REPO_ROOT/docs/demos/wt/out/wt-demo.gif"
+ "wt-select.gif|$REPO_ROOT/docs/demos/wt-select/out/wt-select.gif"
)
# Clone assets repo if needed
@@ -47,8 +47,8 @@ done
if [[ ${#copied[@]} -eq 0 ]]; then
echo "No demo GIFs found. Build them first:"
- echo " ./dev/wt-demo-build"
- echo " ./demos/wt-select/build"
+ echo " ./docs/demos/wt/build"
+ echo " ./docs/demos/wt-select/build"
exit 1
fi