Skip to content

docs(apple): update Apple SDK features pages#15964

Merged
philprime merged 8 commits intomasterfrom
philprime/cocoa-features
Jan 23, 2026
Merged

docs(apple): update Apple SDK features pages#15964
philprime merged 8 commits intomasterfrom
philprime/cocoa-features

Conversation

@philprime
Copy link
Member

@philprime philprime commented Jan 12, 2026

DESCRIBE YOUR PR

  • Reorganize main features page with logical sections
  • Add platform-specific features pages for iOS, tvOS, visionOS
  • Update macOS and watchOS features pages with missing features
  • Add default enablement status indicators
  • Clarify platform limitations and version requirements
  • Fix Session Replay platform support (works on tvOS but iOS only supported)
  • Update experimental features page with platform details

Addresses getsentry/sentry-cocoa#4055

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

- Reorganize main features page with logical sections
- Add platform-specific features pages for iOS, tvOS, visionOS
- Update macOS and watchOS features pages with missing features
- Add default enablement status indicators
- Clarify platform limitations and version requirements
- Fix Session Replay platform support (works on tvOS but iOS only supported)
- Update experimental features page with platform details

Addresses getsentry/sentry-cocoa#4055
@vercel
Copy link

vercel bot commented Jan 12, 2026

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

Project Deployment Review Updated (UTC)
sentry-docs Ready Ready Preview, Comment Jan 23, 2026 8:36am
1 Skipped Deployment
Project Deployment Review Updated (UTC)
develop-docs Ignored Ignored Preview Jan 23, 2026 8:36am

Request Review

@philprime
Copy link
Member Author

@sentry review

@philprime philprime marked this pull request as ready for review January 13, 2026 12:58
@philprime
Copy link
Member Author

We should discuss if this approach of having a feature page for "Apple" AND for each platform still makes sense.

Copy link
Member

@philipphofmann philipphofmann left a comment

Choose a reason for hiding this comment

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

We should discuss if this approach of having a feature page for "Apple" AND for each platform still makes sense.

I honestly would prefer having one list with all features that also tells me which features are available on which platform. Maybe we should even do a table with checkboxes. Right now it's difficult to know which features are available on which platform.

- Removed the AppHangsV2 details from the experimental features page as it is now included in the main features index with platform-specific information.
- Updated the features index to clarify the functionality of AppHangsV2, including its availability on iOS, tvOS, and visionOS.
@codeowner-assignment codeowner-assignment bot requested a review from a team January 14, 2026 10:54
Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

Thanks for the big update! LGTM

philprime and others added 2 commits January 16, 2026 09:27
@philprime
Copy link
Member Author

@philipphofmann how do you want to proceed here? I would merge this now as it's already done and revisit it if necessary in the future again

Copy link
Member

@philipphofmann philipphofmann left a comment

Choose a reason for hiding this comment

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

Thanks for doing this. I think we need to address a few things before we can merge this.

- Remove Swift Async Stack Traces from experimental (GA since v9)
- Fix AppHangsV2 visionOS support (iOS/tvOS only)
- Clarify iOS crash reports sent on next app launch
- Fix Session Replay requires enableSessionReplay option
- Clarify User Feedback UI requires API call
- Remove iOS 13+ version requirement
- Remove Profiling from Performance section
- Fix Watchdog terminations description
- Reorganize iOS features page to match sidebar order
- Add dedicated Logs section heading
@codeowner-assignment codeowner-assignment bot requested a review from a team January 21, 2026 10:13
Copy link
Member

@philipphofmann philipphofmann left a comment

Choose a reason for hiding this comment

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

Thanks

@philprime philprime enabled auto-merge (squash) January 23, 2026 08:26
@codeowner-assignment codeowner-assignment bot requested a review from a team January 23, 2026 08:27
iOS supports all <PlatformLink to="/tracing/instrumentation">performance monitoring</PlatformLink> features:

- <PlatformLink to="/tracing/instrumentation/automatic-instrumentation/#prewarmed-app-start-tracing">App start tracking</PlatformLink> for cold and warm app start times
- <Link to="/product/insights/mobile/mobile-vitals">Frame rate tracking</Link> for UI rendering performance and slow/frozen frame identification
Copy link

Choose a reason for hiding this comment

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

Bug: The documentation incorrectly states that Session Replay requires an enableSessionReplay option, which does not exist in the SDK configuration.
Severity: MEDIUM

Suggested Fix

Remove the mention of the non-existent enableSessionReplay option from the iOS features documentation. Instead, clarify that Session Replay is enabled by setting sessionReplay.sessionSampleRate or sessionReplay.onErrorSampleRate to a value greater than zero, and link to the correct setup guide.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: docs/platforms/apple/guides/ios/features/index.mdx#L44

Potential issue: The iOS features documentation at
`docs/platforms/apple/guides/ios/features/index.mdx` claims that enabling Session Replay
requires setting an `enableSessionReplay` option. However, this configuration option
does not exist in the SDK. The correct method for enabling Session Replay is by
configuring `sessionReplay.sessionSampleRate` and `sessionReplay.onErrorSampleRate`.
This documentation error will prevent developers from correctly enabling the feature,
leading to confusion and wasted time.

Did we get this right? 👍 / 👎 to inform future reviews.

@philprime philprime merged commit a91a7c8 into master Jan 23, 2026
14 checks passed
@philprime philprime deleted the philprime/cocoa-features branch January 23, 2026 08:39
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.

3 participants