-
Notifications
You must be signed in to change notification settings - Fork 3
Add batch screenshot documentation with configuration guide #84
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: wdconinc <4656391+wdconinc@users.noreply.github.com>
There was a problem hiding this 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>
Adds comprehensive documentation for the
pyrobird screenshotcommand, which previously lacked usage examples and configuration details.Documentation Added
Example Batch Script
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
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.