Skip to content

Add Setup Workspace demo GIF to README #95

@SebTardif

Description

@SebTardif

Goal

Add an animated GIF to the README showing the Setup Workspace flow in action. This is the core first-use experience and the best visual for new users.

Recording approach

Use Playwright CDP + ffmpeg to automate and record the demo:

  • Create a temp demo workspace (package.json, .ts file, no AGENTS.md, no MCP config)
  • Launch VS Code with --remote-debugging-port=9222 and the extension loaded
  • Connect Playwright via CDP to the VS Code Electron window
  • Start ffmpeg screen recording (avfoundation on macOS)
  • Automate the demo flow via Playwright:
    • Open Command Palette (Cmd+Shift+P)
    • Type and run "Patchloom: Setup Workspace"
    • Click "Initialize Project" on AGENTS.md prompt
    • Click "Configure MCP" on MCP config prompt
    • Show updated status bar with plug icon
  • Stop recording, convert to GIF with ffmpeg + gifsicle
  • Add GIF to README under "Get started in 30 seconds"
  • Commit and push

Tools

Tool Purpose
Playwright (Python CDP) Automate VS Code UI interactions
ffmpeg (avfoundation) Screen capture on macOS
gifsicle GIF optimization
VS Code Electron Extension host with remote debugging

Reusable skill

After completing this, create a generic vscode-demo-recording skill under ~/.grok/skills/ so this approach can be reused for other VS Code extensions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions