Skip to content

docs(snapshots): Document canvas_theme sidecar metadata#18664

Open
jamieQ wants to merge 1 commit into
masterfrom
jq/snapshot-canvas-theme
Open

docs(snapshots): Document canvas_theme sidecar metadata#18664
jamieQ wants to merge 1 commit into
masterfrom
jq/snapshot-canvas-theme

Conversation

@jamieQ

@jamieQ jamieQ commented Jul 7, 2026

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

Documents the new canvas_theme snapshot metadata introduced in SnapshotPreviews#273. The field sets the light or dark canvas Sentry renders behind a snapshot image in the web UI — it's display metadata only and doesn't change the rendered image.

  • Add canvas_theme to the platform-agnostic sidecar schema (JSON example + field table) in uploading-snapshots
  • Add the .snapshotCanvasTheme(...) modifier and canvas_theme sidecar field to the Apple SnapshotPreviews metadata doc (example, modifier table, sidecar JSON)

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

Add the new canvas_theme sidecar field and .snapshotCanvasTheme(...)
modifier introduced in SnapshotPreviews. The field sets the light or
dark canvas Sentry renders behind a snapshot image in the web UI; it's
display metadata only and doesn't change the rendered image.

Refs: EME-1056
Co-Authored-By: Claude <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Jul 7, 2026 7:24pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Jul 7, 2026 7:24pm

Request Review

@codeowner-assignment codeowner-assignment Bot requested a review from a team July 7, 2026 19:13
@jamieQ jamieQ marked this pull request as ready for review July 7, 2026 20:41
@jamieQ jamieQ requested a review from mtopo27 July 7, 2026 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant