Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 2, 2025

Adds comprehensive documentation for the pyrobird screenshot command, which previously lacked usage examples and configuration details.

Documentation Added

  • Installation: Playwright setup with chromium binaries
  • Command options table: All 6 CLI flags with defaults and descriptions
  • Configuration details: Viewport (1920x1080), full-page mode, timeouts, headless Chromium
  • Examples:
    • Custom output paths with auto-numbering
    • Specific event URLs
    • Batch processing script template for multiple events
    • Programmatic Python usage
  • Troubleshooting: Playwright installation, server startup, incomplete renders, permissions

Example Batch Script

for event in {0..9}; do
    pyrobird screenshot \
        --work-path="$DATA_PATH" \
        --url "http://localhost:5454/#/event?file=local://$DATA_FILE&event=$event" \
        --output-path "event_${event}.png"
done

Screenshots auto-save to screenshots/ directory with numbering to prevent overwrites (event_001.png, event_001_001.png, etc.).

Files Modified

  • doc/pyrobird.md: Added batch screenshot section (+217 lines)
  • pyrobird/README.md: Added batch screenshot section (+217 lines)
Original prompt

This section details on the original issue you should resolve

<issue_title>Add documentation of how to make batch screenshots</issue_title>
<issue_description>And control their config
</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: wdconinc <4656391+wdconinc@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for batch screenshots and configuration Add batch screenshot documentation with configuration guide Dec 2, 2025
Copilot AI requested a review from wdconinc December 2, 2025 02:24
@wdconinc wdconinc marked this pull request as ready for review December 8, 2025 18:08
Copilot AI review requested due to automatic review settings December 8, 2025 18:08
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive documentation for the pyrobird screenshot command, addressing the lack of usage examples and configuration details. The documentation covers installation requirements, command-line options, practical examples including batch processing workflows, configuration defaults, troubleshooting guidance, and programmatic Python usage.

Key Changes

  • Added complete documentation section (+217 lines each) covering all aspects of the screenshot command
  • Includes practical batch processing examples with shell scripts for automating event visualization
  • Documents screenshot configuration (viewport, timeouts, browser settings) and auto-numbering system

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.

File Description
pyrobird/README.md Added "Batch Screenshots" section with complete usage documentation for the screenshot command
doc/pyrobird.md Added identical "Batch Screenshots" section to maintain documentation consistency across locations

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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 documentation of how to make batch screenshots

2 participants