Skip to content

Br snapshot formats#31364

Open
kathayl wants to merge 11 commits into
productionfrom
br-snapshot-formats
Open

Br snapshot formats#31364
kathayl wants to merge 11 commits into
productionfrom
br-snapshot-formats

Conversation

@kathayl

@kathayl kathayl commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

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.

blackmountainb and others added 6 commits June 8, 2026 11:05
The `/snapshot` endpoint now supports optional formats for response, including Markdown and accessibility tree. Updated documentation to reflect these changes and added usage examples.
- Rewrite snapshot.mdx intro to frame individual endpoints vs /snapshot combining them
- Add 'Choose which formats to return' section with real API response
- Add TypeScript SDK and Workers Bindings tab examples for formats
- Fix pre-existing broken sentence in custom HTML example
- Fix Workers Bindings capitalization across all tab labels
- Link to individual single-format endpoints and Quick Actions overview
- Rename changelog to 2026-06-10, lead with announcement
- Add AI agent workflow context for Markdown and accessibility tree formats
- Add code example to changelog
- Remove em dashes, fix typos, replace marketing language
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Review

⏸️ Automatic reviews for this PR are paused.

This PR has already received 2 automatic reviews. To run another review, a codeowner can comment /review or /full-review.

Tip: Keep PRs in draft mode until they are ready for review — the bot skips draft PRs automatically.


💡 1 suggestion found in commit 6694a48.

Suggestions (1)
File Issue
changelog/browser-run/2026-06-10-br-snapshot-formats.mdx line 13 Short bullet list — Bullet list contains only two items (lines 13–14) Fix: Consider writing the two items as prose instead of a bulleted list.
Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.

@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

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

Pattern Owners
/src/content/changelog/ @cloudflare/pm-changelogs, @cloudflare/product-owners
/src/content/docs/browser-run/ @mchenco, @cloudflare/product-owners, @celso, @kathayl, @dcpena, @meddulla, @simonabadoiu, @jonnyparris, @ruifigueira, @Refaerds, @omarmosid
/src/content/release-notes/browser-run.yaml @mchenco, @cloudflare/product-owners, @celso, @kathayl, @dcpena, @meddulla, @simonabadoiu, @jonnyparris, @ruifigueira, @Refaerds, @omarmosid

@ask-bonk ask-bonk Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

3 inline suggestions for style guide issues.

  • MEDIUM snapshot.mdx:4description exceeds 160 characters.
  • MEDIUM snapshot.mdx:157 and changelog/2026-06-10-br-snapshot-formats.mdx:28 — "coming soon" language triggers Semgrep warnings and violates the time-bound content guideline.

Process notes: PR title should use the full product name ("Browser Run" rather than "Br"). The PR body is empty — please fill in the summary and check the relevant documentation checklist items.

Comment thread src/content/docs/browser-run/quick-actions/snapshot.mdx Outdated
Comment thread src/content/docs/browser-run/quick-actions/snapshot.mdx Outdated
Comment thread src/content/changelog/browser-run/2026-06-10-br-snapshot-formats.mdx Outdated
@ask-bonk

ask-bonk Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Posted the review to PR #31364.

What the PR changes

  • Adds a new changelog entry announcing the formats parameter for the Browser Run /snapshot endpoint
  • Rewrites the /snapshot documentation to frame it as a multi-format endpoint that combines individual single-format endpoints
  • Adds a new "Choose which formats to return" section with curl, TypeScript SDK, and Workers Bindings examples
  • Fixes the broken sentence in the custom HTML example and standardizes "Workers Bindings" capitalization

Labels applied
Already correctly labeled size/m, product:browser-run, and product:changelog — no changes needed.

Issues flagged
3 inline suggestions posted:

  • snapshot.mdx:4description is 179 characters (limit is 160)
  • snapshot.mdx:157 — "coming soon" triggers Semgrep warnings and violates the time-bound content guideline
  • changelog/2026-06-10-br-snapshot-formats.mdx:28 — same "coming soon" issue

Process issues for maintainer attention

  • PR title uses "Br" instead of the full product name "Browser Run"
  • PR body is empty — the summary section and documentation checklist should be filled out (the changelog and style-guide items clearly apply)

github run

- Add entry to browser-run.yaml for the new formats parameter
- Link to /snapshot docs page for usage examples
kathayl and others added 3 commits June 9, 2026 18:12
Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
…ts.mdx

Co-authored-by: ask-bonk[bot] <249159057+ask-bonk[bot]@users.noreply.github.com>
Comment thread src/content/changelog/browser-run/2026-06-10-br-snapshot-formats.mdx Outdated
Comment thread src/content/changelog/browser-run/2026-06-10-br-snapshot-formats.mdx Outdated
- Add Browser Run to changelog title and description
- Update dates to 2026-06-11
- Rename changelog file to match naming convention
- Replace 'coming soon' with 'not yet available' in changelog and snapshot.mdx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants