docs(apple): update Apple SDK features pages#15964
Conversation
- 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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
@sentry review |
|
We should discuss if this approach of having a feature page for "Apple" AND for each platform still makes sense. |
philipphofmann
left a comment
There was a problem hiding this comment.
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.
coolguyzone
left a comment
There was a problem hiding this comment.
Thanks for the big update! LGTM
Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
|
@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 |
philipphofmann
left a comment
There was a problem hiding this comment.
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
| 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 |
There was a problem hiding this comment.
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.
DESCRIBE YOUR PR
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.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: