Skip to content

Complete Playwright visual source: add optional dependency and documentation#24

Open
jmjava wants to merge 1 commit intomainfrom
cursor/resolve-issue-16-playwright-96fc
Open

Complete Playwright visual source: add optional dependency and documentation#24
jmjava wants to merge 1 commit intomainfrom
cursor/resolve-issue-16-playwright-96fc

Conversation

@jmjava
Copy link
Copy Markdown
Owner

@jmjava jmjava commented Apr 16, 2026

Summary

Issue #16 requested adding type: playwright as a visual source for browser-based capture. The implementation is already complete across the codebase. This PR closes the remaining gaps: an explicit optional dependency and complete documentation.

What was already implemented

  • PlaywrightRunner class in playwright_runner.py - runs external capture scripts
  • docgen playwright CLI command for standalone capture
  • type: playwright dispatch in compose.py for pipeline integration
  • Configuration block (playwright:) in docgen.yaml schema
  • README section documenting type: playwright visual map entries and script contract
  • Test coverage in test_playwright_runner.py and test_compose.py

What this PR adds

  • playwright optional dependency in pyproject.toml (pip install docgen[playwright])
  • Features section in README now lists Playwright browser capture
  • System dependencies section now includes Playwright with install instructions
  • Formatting fix: missing blank line before VHS safety section

Acceptance criteria from issue #16

Criteria Status
docgen playwright --script my_script.py --url http://localhost:3300 produces an MP4 Done (CLI + runner)
type: playwright segments compose correctly with narration audio Done (compose.py)
Headless mode works on Ubuntu (CI-compatible) Done (uses headless Chromium)
Documentation updated with Playwright visual source examples Done (README)

Closes #16

Open in Web Open in Cursor 

- Add 'playwright' optional dependency group in pyproject.toml
- Add Playwright browser capture to Features section in README
- Add Playwright to system dependencies with install instructions
- Fix missing blank line before VHS safety section in README

The Playwright visual source feature (type: playwright) is fully implemented:
- PlaywrightRunner class for browser capture via external scripts
- CLI: docgen playwright --script ... --url ... --source ...
- Compose integration dispatches type: playwright segments
- Configuration: playwright section in docgen.yaml
- Full test coverage

Closes #16

Co-authored-by: John Menke <jmjava@gmail.com>
@cursor cursor bot force-pushed the cursor/resolve-issue-16-playwright-96fc branch from 24c149f to a34ecfd Compare April 16, 2026 14:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add type:playwright visual source for browser-based capture

2 participants