Skip to content

Refactor: Doc(images) VHS tapes with shared snippets#1906

Open
ttw225 wants to merge 3 commits intocommitizen-tools:masterfrom
ttw225:refactor/doc_gif
Open

Refactor: Doc(images) VHS tapes with shared snippets#1906
ttw225 wants to merge 3 commits intocommitizen-tools:masterfrom
ttw225:refactor/doc_gif

Conversation

@ttw225
Copy link
Contributor

@ttw225 ttw225 commented Mar 20, 2026

Description

Refactor CLI documentation GIF tapes to reduce duplication and keep recording settings consistent.

  • Add shared VHS snippets under docs/images/shared/ (base.tape for shell/theme/typing setup, git_init.tape, cleanup.tape).
  • Update bump.tape, commit.tape, init.tape, shortcut_custom.tape, and shortcut_default.tape to Source those snippets instead of repeating the same preamble.
  • Remove unused docs/images/bump.yml and docs/images/commit.yml.

Checklist

Was generative AI tooling used to co-author this PR?

  • Yes (please specify the tool below)

Generated-with: [Cursor] following the guidelines

Code Changes

  • Add test cases to all the changes you introduce
  • Run uv run poe all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Documentation Changes

  • Run uv run poe doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external)

Expected Behavior

  • Regenerating CLI GIFs with VHS continues to work
  • Tapes stay shorter and easier to maintain
  • Removed YAML files are not referenced by the doc build or tape workflow

Steps to Test This Pull Request

uv run poe doc:screenshots

Additional Context

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant