Skip to content

docs(browser-rendering): add waitUntil guidance for JS-heavy pages #26998

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.

Sign up for GitHub

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

Jump to bottom
Open
kathayl wants to merge 2 commits into
base: production
Choose a base branch
from
Open

docs(browser-rendering): add waitUntil guidance for JS-heavy pages #26998

kathayl wants to merge 2 commits into from

Conversation

@kathayl
Copy link
Contributor

@kathayl kathayl commented Dec 9, 2025

  • Add new partial explaining gotoOptions.waitUntil for JavaScript-heavy pages
  • Add partial to all REST API endpoint docs
  • Clean up timeouts reference page with dedicated waitUntil options table
  • Fix default waitUntil value to domcontentloaded per API reference

Summary

Screenshots (optional)

Documentation checklist

  • Is there a changelog entry (guidelines)? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to RSS feeds, the Discord, and X.
  • The change adheres to the documentation style guide.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@kathayl
docs(browser-rendering): add waitUntil guidance for JS-heavy pages
ced10b9 
- Add new partial explaining gotoOptions.waitUntil for JavaScript-heavy pages
- Add partial to all REST API endpoint docs
- Clean up timeouts reference page with dedicated waitUntil options table
- Fix default waitUntil value to domcontentloaded per API reference
@kathayl kathayl requested review from a team, ToriLindsay, celso and mchenco as code owners December 9, 2025 01:50
@github-actions github-actions bot added the size/s label Dec 9, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 9, 2025

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/browser-rendering/ @mchenco, @cloudflare/pcx-technical-writing, @celso, @danielgek, @kathayl, @ToriLindsay
* @cloudflare/pcx-technical-writing

@github-actions
Copy link
Contributor

github-actions bot commented Dec 9, 2025 •
edited
Loading

Preview URL: https://bc6e542e.preview.developers.cloudflare.com
Preview Branch URL: https://docs-browser-rendering-waituntil-guidance.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/browser-rendering/reference/timeouts/ https://docs-browser-rendering-waituntil-guidance.preview.developers.cloudflare.com/browser-rendering/reference/timeouts/
https://developers.cloudflare.com/browser-rendering/rest-api/content-endpoint/ https://docs-browser-rendering-waituntil-guidance.preview.developers.cloudflare.com/browser-rendering/rest-api/content-endpoint/
https://developers.cloudflare.com/browser-rendering/rest-api/markdown-endpoint/ https://docs-browser-rendering-waituntil-guidance.preview.developers.cloudflare.com/browser-rendering/rest-api/markdown-endpoint/
https://developers.cloudflare.com/browser-rendering/rest-api/pdf-endpoint/ https://docs-browser-rendering-waituntil-guidance.preview.developers.cloudflare.com/browser-rendering/rest-api/pdf-endpoint/
https://developers.cloudflare.com/browser-rendering/rest-api/scrape-endpoint/ https://docs-browser-rendering-waituntil-guidance.preview.developers.cloudflare.com/browser-rendering/rest-api/scrape-endpoint/
https://developers.cloudflare.com/browser-rendering/rest-api/screenshot-endpoint/ https://docs-browser-rendering-waituntil-guidance.preview.developers.cloudflare.com/browser-rendering/rest-api/screenshot-endpoint/
https://developers.cloudflare.com/browser-rendering/rest-api/snapshot/ https://docs-browser-rendering-waituntil-guidance.preview.developers.cloudflare.com/browser-rendering/rest-api/snapshot/
https://developers.cloudflare.com/browser-rendering/rest-api/json-endpoint/ https://docs-browser-rendering-waituntil-guidance.preview.developers.cloudflare.com/browser-rendering/rest-api/json-endpoint/
https://developers.cloudflare.com/browser-rendering/rest-api/links-endpoint/ https://docs-browser-rendering-waituntil-guidance.preview.developers.cloudflare.com/browser-rendering/rest-api/links-endpoint/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mchenco mchenco Awaiting requested review from mchenco mchenco is a code owner

@celso celso Awaiting requested review from celso celso is a code owner

@ToriLindsay ToriLindsay Awaiting requested review from ToriLindsay ToriLindsay is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@celso celso

@danielgek danielgek

@mchenco mchenco

@ToriLindsay ToriLindsay

Labels

product:browser-rendering size/s

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@kathayl @celso @danielgek @mchenco @ToriLindsay