Refactor: Doc(images) VHS tapes with shared snippets#1906
Merged
bearomorphism merged 3 commits intocommitizen-tools:masterfrom Apr 15, 2026
Merged
Refactor: Doc(images) VHS tapes with shared snippets#1906bearomorphism merged 3 commits intocommitizen-tools:masterfrom
bearomorphism merged 3 commits intocommitizen-tools:masterfrom
Conversation
bearomorphism
approved these changes
Apr 15, 2026
Collaborator
bearomorphism
left a comment
There was a problem hiding this comment.
LGTM. Sorry for the delayed review
There was a problem hiding this comment.
Pull request overview
Refactors the VHS “tape” scripts used to generate CLI documentation GIFs by extracting common setup/teardown into shared snippets, reducing duplication and keeping recording settings consistent.
Changes:
- Introduces shared VHS snippets under
docs/images/shared/for common terminal setup, git initialization, and cleanup. - Updates existing
.tapefiles toSourcethe shared snippets instead of duplicating preambles. - Removes legacy/unused YAML recording artifacts (
bump.yml,commit.yml).
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/images/shared/base.tape | New shared snippet for consistent shell/theme/terminal + temp dir setup. |
| docs/images/shared/git_init.tape | New shared snippet for git repo initialization and user config. |
| docs/images/shared/cleanup.tape | New shared snippet to hide and clean the temp working directory. |
| docs/images/bump.tape | Refactored to source shared setup/git init/cleanup snippets. |
| docs/images/commit.tape | Refactored to source shared setup/git init/cleanup snippets. |
| docs/images/init.tape | Refactored to source shared setup + cleanup snippets. |
| docs/images/shortcut_default.tape | Refactored to source shared setup/git init/cleanup snippets. |
| docs/images/shortcut_custom.tape | Refactored to source shared setup/git init/cleanup snippets. |
| docs/images/bump.yml | Removed unused legacy recording config/artifact. |
| docs/images/commit.yml | Removed unused legacy recording config/artifact. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Description
Refactor CLI documentation GIF tapes to reduce duplication and keep recording settings consistent.
docs/images/shared/(base.tapefor shell/theme/typing setup,git_init.tape,cleanup.tape).bump.tape,commit.tape,init.tape,shortcut_custom.tape, andshortcut_default.tapetoSourcethose snippets instead of repeating the same preamble.docs/images/bump.ymlanddocs/images/commit.yml.Checklist
Was generative AI tooling used to co-author this PR?
Generated-with: [Cursor] following the guidelines
Code Changes
uv run poe alllocally to ensure this change passes linter check and testsDocumentation Changes
uv run poe doclocally to ensure the documentation pages renders correctlyExpected Behavior
Steps to Test This Pull Request
uv run poe doc:screenshotsAdditional Context