Skip to content

docs(snapshots): Add local testing page for download and diff commands#17903

Merged
NicoHinderling merged 2 commits into
masterfrom
NicoHinderling/docs/snapshots-local-testing
May 27, 2026
Merged

docs(snapshots): Add local testing page for download and diff commands#17903
NicoHinderling merged 2 commits into
masterfrom
NicoHinderling/docs/snapshots-local-testing

Conversation

@NicoHinderling
Copy link
Copy Markdown
Contributor

@NicoHinderling NicoHinderling commented May 27, 2026

DESCRIBE YOUR PR

Documents the new sentry-cli snapshots download and sentry-cli snapshots diff commands added in sentry-cli#3306 and sentry-cli#3310.

  • New "Local Testing" product docs page covering the workflow: download baselines → run tests → diff locally
  • CLI reference sections for snapshots download and snapshots diff with flag tables

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

…d/diff

Add new "Local Testing" docs page covering the workflow for downloading
baseline snapshots and diffing images locally with sentry-cli. Add
download and diff command reference sections to the CLI snapshots page.

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 27, 2026

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

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment May 27, 2026 8:23pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview May 27, 2026 8:23pm

Request Review

@codeowner-assignment codeowner-assignment Bot requested a review from a team May 27, 2026 18:31
@NicoHinderling NicoHinderling marked this pull request as ready for review May 27, 2026 18:34
Copy link
Copy Markdown
Contributor

@mtopo27 mtopo27 left a comment

Choose a reason for hiding this comment

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

pre-stamped w some comments

Comment thread docs/product/snapshots/local-testing/index.mdx Outdated

```bash
sentry-cli snapshots download --app-id web-frontend
pnpm run snapshots
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.

maybe worth adding a comment like #your snapshot generation command

and then sentry-cli snapshots diff ./snapshots-base ./path/to/snapshots


Use `--output` to change the destination directory.

## Diffing Locally
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.

also would be nice to have link to ref here as well

Replace "PNGs" with "images" to avoid false positive from typo checker,
and update odiff link to the correct repository URL.

Co-Authored-By: Claude <noreply@anthropic.com>
@NicoHinderling NicoHinderling force-pushed the NicoHinderling/docs/snapshots-local-testing branch from f093535 to ddfd6af Compare May 27, 2026 20:12
@NicoHinderling NicoHinderling merged commit 4b17581 into master May 27, 2026
21 checks passed
@NicoHinderling NicoHinderling deleted the NicoHinderling/docs/snapshots-local-testing branch May 27, 2026 21:22
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.

2 participants