feat(apple): Add docs for screenshot masking options
DESCRIBE YOUR PR
Adds documentation about configuring masking of screenshots. Based on the already existing session replay masking documentation. As the two options sets are different (options.sessionReplay.* vs options.screenshot.*) we should duplicate the documentation for now in case of drift.
We need to revisit this issue with https://github.com/getsentry/sentry-cocoa/issues/6060
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:
- [X] 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:
- [x] Checked Vercel preview for correctness, including links
- [x] 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
The latest updates on your projects. Learn more about Vercel for GitHub.
| Project | Deployment | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| sentry-docs | Preview | Comment | Dec 5, 2025 10:56am |
1 Skipped Deployment
| Project | Deployment | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| develop-docs | Preview | Dec 5, 2025 10:56am |
Bundle Report
Changes will increase total bundle size by 107.29kB (0.3%) :arrow_up:. This is within the configured threshold :white_check_mark:
Detailed changes
| Bundle name | Size | Change |
|---|---|---|
| sentry-docs-server-cjs | 24.91MB | 107.3kB (0.43%) :arrow_up: |
| sentry-docs-client-array-push | 10.22MB | -6 bytes (-0.0%) :arrow_down: |
Affected Assets, Files, and Routes:
view changes for bundle: sentry-docs-server-cjs
Assets Changed:
| Asset Name | Size Change | Total Size | Change (%) |
|---|---|---|---|
1729.js |
-3 bytes | 5.5MB | -0.0% |
6529.js |
-3 bytes | 4.92MB | -0.0% |
../instrumentation.js |
-3 bytes | 4.82MB | -0.0% |
../app/[[...path]]/page.js.nft.json |
35.77kB | 1.1MB | 3.37% |
../app/platform-redirect/page.js.nft.json |
35.77kB | 1.1MB | 3.37% |
../app/sitemap.xml/route.js.nft.json |
35.77kB | 1.1MB | 3.38% |
view changes for bundle: sentry-docs-client-array-push
Assets Changed:
| Asset Name | Size Change | Total Size | Change (%) |
|---|---|---|---|
static/chunks/pages/_app-*.js |
-3 bytes | 893.1kB | -0.0% |
static/chunks/9366-*.js |
-3 bytes | 436.99kB | -0.0% |
server/middleware-*.js |
-6.46kB | 1.0kB | -86.59% |
server/middleware-*.js |
6.46kB | 7.46kB | 645.5% :warning: |
static/fS5R7jRwMcROvXpkrIs4Z/_buildManifest.js (New) |
684 bytes | 684 bytes | 100.0% :rocket: |
static/fS5R7jRwMcROvXpkrIs4Z/_ssgManifest.js (New) |
77 bytes | 77 bytes | 100.0% :rocket: |
~~static/nqm6A74xPzr4rwqrvKq8e/_buildManifest.js~~ (Deleted) |
-684 bytes | 0 bytes | -100.0% :wastebasket: |
~~static/nqm6A74xPzr4rwqrvKq8e/_ssgManifest.js~~ (Deleted) |
-77 bytes | 0 bytes | -100.0% :wastebasket: |
BLOCKED BY https://github.com/getsentry/sentry-cocoa/pull/6953
As the implementation of a screenshot specific public API is taking longer than expected with https://github.com/getsentry/sentry-cocoa/pull/6953 I'll merge this PR now as-is and iterate the documentation when the new public API is available.