Skip to content

Commit 73b4af6

Browse files
authored
doc: Add a tapes/ folder (#873)
We can put VHS tapes for demos here. These will not be rendered at doc build time as that'll change literally every build (git hashes). We can set up infrastructure to render them deterministically (similarly to test scripts) in the future if we really want to, but even then because the VHS tapes run in real time, that will significantly slow down docs (and will likely be flaky in CI). So the tapes folder is just for future reference to recreate any demos if we want to. [skip changelog]: no user facing changes
1 parent 78bf146 commit 73b4af6

File tree

6 files changed

+67
-0
lines changed

6 files changed

+67
-0
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
*.txt text eol=lf
99

1010
*.png filter=lfs diff=lfs merge=lfs -text
11+
*.gif filter=lfs diff=lfs merge=lfs -text
1112

1213
# pgregory.net/rapid should be considered generated code to reduce noise.
1314
**/testdata/rapid/**/*.fail linguist-generated
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Demo of 'branch split' supporting moving the branch name.
2+
3+
Output "20250924-branch-split-reuse-name.gif"
4+
Hide
5+
6+
# Setup
7+
Type "cd $(mktemp -d) && git init && git commit --allow-empty -m 'Initial commit'" Enter
8+
Type "gs repo init && git config spice.experiment.commitFixup true" Enter
9+
Type "mkdir pangolin && touch pangolin/climb && git add pangolin && git comit -m 'Invent pangolins'" Enter
10+
Type "mkdir penguin && touch penguin/{swim,fish} && git add penguin && gs branch create penguin -m 'Invent penguins'" Enter
11+
Type "touch pangolin/roll && git add pangolin/roll && git commit -m 'Refactor pangolin'" Enter
12+
Type "clear" Enter
13+
Show
14+
15+
Sleep 0.5s
16+
Type "git status" Enter Sleep 1s
17+
Type "gs ll" Enter Sleep 1s
18+
19+
Type "gs branch split" Enter Sleep 2s
20+
Enter Sleep 1s Enter Sleep 1s
21+
Type "penguin" Enter Sleep 1s
22+
Type "refac-pangolin" Enter Sleep 1s
23+
24+
Type "gs ll" Enter Sleep 3s
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Demo of 'commit fixup' for the 0.18 release notes.
2+
# Not used for the documentation.
3+
4+
Output "20250924-commit-fixup.gif"
5+
Hide
6+
7+
# Setup
8+
Type "cd $(mktemp -d) && git init && git commit --allow-empty -m 'Initial commit'" Enter
9+
Type "gs repo init && git config spice.experiment.commitFixup true" Enter
10+
Type "mkdir penguin && touch penguin/{flight,fish} && git add penguin && gs branch create penguin -m 'Invent penguins'" Enter
11+
Type "mkdir iguana && touch iguana/{climb,run} && git add iguana && gs branch create iguana -m 'Invent iguanas'" Enter
12+
Type "touch penguin/swim" Enter
13+
Type "clear" Enter
14+
Show
15+
16+
Sleep 0.5s
17+
18+
Type "ls penguin" Enter Sleep 1s
19+
Type "git status" Enter Sleep 1s
20+
Type "gs ll" Enter Sleep 1s
21+
22+
Type "# penguins can swim but they can't fly" Enter Sleep 1s
23+
Type "git add penguin/swim" Enter Sleep 0.5s
24+
Type "git rm penguin/flight" Enter Sleep 0.5s
25+
26+
Type "gs commit fixup" Enter
27+
Sleep 1s
28+
Down Sleep 0.5s Enter Sleep 1s
29+
30+
Type "gs ll" Enter Sleep 1s
31+
Type "git status" Enter Sleep 1s
32+
Type "ls penguin" Enter Sleep 5s

doc/tapes/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[vhs](https://github.com/charmbracelet/vhs) tapes for demos and documentation.
2+
3+
These are _not_ rendered at documentation build time
4+
as they can be slow to render and flaky in reproducibility.

0 commit comments

Comments
 (0)