docs: Improve actions documentation with complete parameters and examples #249
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…nd examples - Add comprehensive parameter documentation for all 9 action types (wait, click, write, press, scroll, screenshot, scrape, executeJavascript, pdf) - Add missing screenshot action which was in API spec but not documented in advanced guide - Include parameter descriptions: required vs optional, types, default values, and examples - Update code examples to include screenshot action and demonstrate accessing screenshot results - Add 'Important Notes about Actions' section covering execution order, element waiting, focus requirements, and JavaScript returns - Clarify that scroll selector is optional and defaults to page-level scrolling - Document return values for scrape, executeJavascript, and pdf actions Co-Authored-By: devhims <himanshu@sideguide.dev>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses documentation gaps identified in customer support conversations regarding the v2 scrape endpoint actions parameter.
Changes Made
1. Added Missing Screenshot Action
screenshotaction was documented in the OpenAPI spec but completely missing from the Advanced Scraping GuidefullPage,quality,viewport2. Comprehensive Parameter Documentation
3. Enhanced Code Examples
screenshotaction demonstrationdoc.screenshot)4. Important Notes Section
Problem Solved
Customer support conversation showed confusion about:
The documentation now matches the OpenAPI specification and provides clear, actionable guidance for developers using the actions parameter.