Skip to content

docs(apple): Fix correctness issues and add missing options#16683

Draft
philprime wants to merge 1 commit intomasterfrom
docs/fix-apple-sdk-docs-correctness
Draft

docs(apple): Fix correctness issues and add missing options#16683
philprime wants to merge 1 commit intomasterfrom
docs/fix-apple-sdk-docs-correctness

Conversation

@philprime
Copy link
Member

DESCRIBE YOUR PR

Cross-reference all Apple/Cocoa SDK docs against the SDK source code to fix incorrect API names, wrong defaults, missing options, broken Swift syntax, and outdated information for v9.

Key fixes:

  • Add missing session replay options (sessionSampleRate, onErrorSampleRate, quality, masking, excludeViewTypeFromSubtreeTraversal)
  • Add missing profiling options (lifecycle, sessionSampleRate) with examples
  • Add profileAppStarts to profiling setup page
  • Add configureUserFeedback option
  • Add experimental options (enableUnhandledCPPExceptionsV2, enableWatchdogTerminationsV2, enableSessionReplayInUnreliableEnvironment)
  • Fix user feedback config: closure assignment syntax (missing =), wrong property names (isRequiredText->isRequiredLabel, title->formTitle, theme->configureTheme), remove non-existent successMessageText
  • Fix maskView/unmaskView Swift syntax across replay, screenshots docs
  • Fix deprecated enableExperimentalViewRenderer -> enableViewRendererV2
  • Fix ObjC syntax errors (missing @ prefixes, semicolons, wrong initializer names, incorrect casing)
  • Fix tracePropagationTarget typo, add enablePropagateTraceparent docs
  • Update enableLogs from experimental to stable for v9
  • Correct beforeCaptureScreenshot/beforeCaptureViewHierarchy/ onCrashedLastRun callback signatures to include event parameter
  • Fix environment default, SentryLog body property name, various typos

Analyzed using Cursor in a workspace with sentry-cocoa

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

Cross-reference all Apple/Cocoa SDK docs against the SDK source code
to fix incorrect API names, wrong defaults, missing options, broken
Swift syntax, and outdated information for v9.

Key fixes:
- Add missing session replay options (sessionSampleRate, onErrorSampleRate,
  quality, masking, excludeViewTypeFromSubtreeTraversal)
- Add missing profiling options (lifecycle, sessionSampleRate) with examples
- Add profileAppStarts to profiling setup page
- Add configureUserFeedback option
- Add experimental options (enableUnhandledCPPExceptionsV2,
  enableWatchdogTerminationsV2, enableSessionReplayInUnreliableEnvironment)
- Fix user feedback config: closure assignment syntax (missing =),
  wrong property names (isRequiredText->isRequiredLabel, title->formTitle,
  theme->configureTheme), remove non-existent successMessageText
- Fix maskView/unmaskView Swift syntax across replay, screenshots docs
- Fix deprecated enableExperimentalViewRenderer -> enableViewRendererV2
- Fix ObjC syntax errors (missing @ prefixes, semicolons, wrong
  initializer names, incorrect casing)
- Fix tracePropagationTarget typo, add enablePropagateTraceparent docs
- Update enableLogs from experimental to stable for v9
- Correct beforeCaptureScreenshot/beforeCaptureViewHierarchy/
  onCrashedLastRun callback signatures to include event parameter
- Fix environment default, SentryLog body property name, various typos
@vercel
Copy link

vercel bot commented Mar 4, 2026

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

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment Mar 4, 2026 3:36pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Mar 4, 2026 3:36pm

Request Review

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