Skip to content

chore(claude): add record demo skill#403

Merged
zimeg merged 3 commits intomainfrom
zimeg-chore-maintainers-vhs
Mar 17, 2026
Merged

chore(claude): add record demo skill#403
zimeg merged 3 commits intomainfrom
zimeg-chore-maintainers-vhs

Conversation

@zimeg
Copy link
Copy Markdown
Member

@zimeg zimeg commented Mar 16, 2026

Changelog

N/A - But I am curious if these scripts are useful to docs pages in upcoming builds? 👾 ✨

Summary

This PR adds a claude skill to record demos for PR previews using the vhs package.

Preview

📸 Example of generated "tape" and GIF - the app existed ahead of time which might be useful for intricate setups:

# Demo: slack run + slack app list
Output demos/run-and-app-list.gif

Set Shell "zsh"
Set FontSize 16
Set Width 1200
Set Height 600
Set Theme "Catppuccin Mocha"
Set TypingSpeed 75ms
Set Padding 20

Hide
Type "cd /Users/eden.zimbelman/programming/tools/slack-cli/relaxed-porcupine-80"
Enter
Sleep 500ms
Show

Type "../bin/slack run"
Sleep 500ms
Enter
Sleep 3s
Enter
Sleep 1s
Enter
Sleep 10s
Ctrl+C
Sleep 1s

Type "../bin/slack app list"
Sleep 500ms
Enter
Sleep 3s

run-and-app-list

Requirements

@zimeg zimeg added this to the Next Release milestone Mar 16, 2026
@zimeg zimeg self-assigned this Mar 16, 2026
@zimeg zimeg requested a review from a team as a code owner March 16, 2026 07:04
@zimeg zimeg added code health M-T: Test improvements and anything that improves code health semver:patch Use on pull requests to describe the release version increment labels Mar 16, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 16, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 68.12%. Comparing base (f3767d6) to head (94e9e42).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #403      +/-   ##
==========================================
- Coverage   68.15%   68.12%   -0.03%     
==========================================
  Files         218      218              
  Lines       18020    18020              
==========================================
- Hits        12281    12277       -4     
- Misses       4582     4586       +4     
  Partials     1157     1157

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

mwbrooks
mwbrooks approved these changes Mar 17, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️ Absolutely love this feature! Great idea @zimeg

💬 Asked a question about whether we may want to check these into version control. It can be a future topic though, but would love to hear the discussion.

.gitignore
Comment on lines +40 to +42

# VHS demo recordings
demos/
Copy link
Copy Markdown
Member

@mwbrooks mwbrooks Mar 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question(non-blocking): Curious if you considered having our VHS demos checked into version control? Just curious if we'd ever want to re-generate older recordings to show an updated UI.

Copy link
Copy Markdown
Member Author

@zimeg zimeg Mar 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📸 Such an interesting idea! Without knowing good practices to this I left it for later thinking to be honest-

I'd be so curious to versioning .tape files with the docs 📚

Our hidden docgen command might be extended to require vhs to regenerate all recordings with the latest release perhaps? Would love to learn recommendations to this and thoughts from @lukegalbraithrussell!

Copy link
Copy Markdown
Member

@mwbrooks mwbrooks Mar 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our hidden docgen command might be extended to require vhs to regenerate all recordings with the latest release perhaps?

You nailed it. This is where my mind was going as well. Since the docs are part of the CLI repo and updated on each release, we have an opportunity to add rich, interactive gifs to the docs website.

@zimeg
Copy link
Copy Markdown
Member Author

zimeg commented Mar 17, 2026

@mwbrooks Exciting times to find perhaps more polish to PRs! 🍀 ✨

Let's merge this with background thinking to how we might surface these demos in documentation. I'm excited to experiment with workflows related to this 🚢 💨

@zimeg zimeg enabled auto-merge (squash) March 17, 2026 20:35
@zimeg zimeg merged commit 857a59a into main Mar 17, 2026
7 checks passed
@zimeg zimeg deleted the zimeg-chore-maintainers-vhs branch March 17, 2026 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mwbrooks mwbrooks mwbrooks approved these changes

Assignees

@zimeg zimeg

Labels

code health M-T: Test improvements and anything that improves code health semver:patch Use on pull requests to describe the release version increment

Projects

None yet

Milestone

Next Release

Development

Successfully merging this pull request may close these issues.

2 participants

@zimeg @mwbrooks