Update browser-rendering.yaml #24101
Merged
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
clarify viewport is for screenshot endpoint
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
add what the default viewport is
Contributor
|
Preview URL: https://b9a55f96.preview.developers.cloudflare.com Files with changes (up to 15) |
ToriLindsay
reviewed
Aug 1, 2025
|
|
||
| For more options to control the final screenshot, like `clip`, `captureBeyondViewport`, `fullPage` and others, check the endpoint [reference](/api/resources/browser_rendering/subresources/screenshot/methods/create/). | ||
|
|
||
| :::note |
Contributor
There was a problem hiding this comment.
A thought on this one...
I tend to assume that one note = one concept. In this case, am I right in understanding that these two pieces of information are unrelated to each other (except for the fact that they are both good things to know for basic usage)? If so, I would suggest either:
- Keep as a note, but put a heading on the note like
Notes for basic usageand then bullet each, to make it obvious that they may be unrelated concepts. - Break into two separate notes and maybe give them both headings. (I'm not partial to this because it's a little too busy. And it's also hard to scale if we end up with more notes).
- Make into a bulleted list of "Additional things to know..." but don't use the note component at all.
ToriLindsay
reviewed
Aug 1, 2025
ToriLindsay
approved these changes
Aug 1, 2025
Co-authored-by: ToriLindsay <[email protected]>
ToriLindsay
reviewed
Aug 4, 2025
src/content/docs/browser-rendering/rest-api/screenshot-endpoint.mdx
Outdated
Show resolved
Hide resolved
ToriLindsay
reviewed
Aug 4, 2025
src/content/docs/browser-rendering/rest-api/screenshot-endpoint.mdx
Outdated
Show resolved
Hide resolved
ToriLindsay
reviewed
Aug 4, 2025
src/content/docs/browser-rendering/rest-api/screenshot-endpoint.mdx
Outdated
Show resolved
Hide resolved
ToriLindsay
reviewed
Aug 4, 2025
src/content/docs/browser-rendering/rest-api/screenshot-endpoint.mdx
Outdated
Show resolved
Hide resolved
ToriLindsay
reviewed
Aug 4, 2025
src/content/docs/browser-rendering/rest-api/screenshot-endpoint.mdx
Outdated
Show resolved
Hide resolved
ToriLindsay
reviewed
Aug 4, 2025
ToriLindsay
approved these changes
Aug 4, 2025
thomasgauvin
pushed a commit
that referenced
this pull request
Aug 15, 2025
* Update browser-rendering.yaml clarify viewport is for screenshot endpoint * Update screenshot-endpoint.mdx add what the default viewport is * Update src/content/release-notes/browser-rendering.yaml Co-authored-by: ToriLindsay <[email protected]> * Apply suggestions from code review --------- Co-authored-by: ToriLindsay <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
clarify viewport is for screenshot endpoint
Summary
Screenshots (optional)
Documentation checklist