Skip to content

docs(snapshots): Document @Preview group, name, and tag metadata mapping#18538

Open
runningcode wants to merge 1 commit into
masterfrom
no/docs/eme-1216-document-preview-metadata
Open

docs(snapshots): Document @Preview group, name, and tag metadata mapping#18538
runningcode wants to merge 1 commit into
masterfrom
no/docs/eme-1216-document-preview-metadata

Conversation

@runningcode

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Document how Jetpack Compose @Preview attributes shape the snapshot metadata the Sentry Android Gradle Plugin emits, so customers know how to influence snapshot grouping and display names.

  • Add a "How Preview Annotations Map to Snapshot Metadata" section to the Android snapshots page covering group, name, and the @Preview attributes that become tags, with a worked @Preview → JSON example.
  • Extend the generic snapshot metadata schema (Uploading Snapshots) with the tags and context objects so the documented schema matches what's actually emitted.
  • Fix two stray typos in the existing metadata field table.

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

@linear-code

linear-code Bot commented Jun 24, 2026

Copy link
Copy Markdown

EME-1216

@vercel

vercel Bot commented Jun 24, 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 Jun 24, 2026 3:06pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview Jun 24, 2026 3:06pm

Request Review

@runningcode runningcode force-pushed the no/docs/eme-1216-document-preview-metadata branch from e8f7a36 to 962e188 Compare June 24, 2026 14:18
@codeowner-assignment codeowner-assignment Bot requested a review from a team June 24, 2026 14:18
@runningcode runningcode marked this pull request as ready for review June 24, 2026 14:19
@runningcode runningcode force-pushed the no/docs/eme-1216-document-preview-metadata branch from 962e188 to b31f032 Compare June 24, 2026 14:21
Comment thread docs/platforms/android/snapshots/index.mdx
Explain how the @Preview group and name attributes shape the sidecar
JSON the Android Gradle Plugin emits per Compose preview, and which
@Preview attributes become snapshot tags. Customers previously had no
way to tell how to influence snapshot grouping or display names.

Also extend the generic snapshot metadata schema with the tags and
context objects so the documented schema matches what is emitted.

Refs EME-1216

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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