docs(replay): Bring replay nav item to all apple platforms (#14710)

ryan953 · web-flow · commit 7ffc130d92ee · 2025-08-27T16:08:12.000-07:00
This puts Session Replay in the Nav for the Apple section, and all sub-platforms, just not on iOS anymore. Also, i moved some FAQ items from the bottom of the index page into troubleshooting.mdx. They seemed hard to find on the index page, and really seem more like Basically: - `/platforms/apple/guides/ios/session-replay/` still has all the content as before - `/platforms/apple/guides/tvos/session-replay/` is a page now! but it's mostly empty - (see first screenshots below) - `/platforms/apple/session-replay/` is a page now! it's a copy of the iOS specific page, but with the faq on the top - (see 2nd set of screenshots at end) --- **`/platforms/apple/` Nav Changes:** | Before | After | | --- | --- | <img width="285" height="779" alt="SCR-20250825-mjyo" src="https://github.com/user-attachments/assets/ca7e07bd-b28f-4600-bc60-c9a0fa5a8875" /> | <img width="299" height="819" alt="SCR-20250825-mkbs" src="https://github.com/user-attachments/assets/1e0821bc-e69c-434b-be9d-a7c30f7ea1e6" /> --- Since most of the Apple platforms are not specifically supported I put the two "Does Session Replay work with *" faq questions at the top of the index page whenever you're not looking specifically at iOS docs. Only the main Apple and iOS show the sub-pages in the nav bar, the other platform specific sections only show the FAQ stuff and no sub-pages. | Apple Overall | iOS Specific | The others | | --- | --- | --- | | <img width="1304" height="856" alt="SCR-20250825-mird" src="https://github.com/user-attachments/assets/6d498fac-8dc6-4525-ad37-87da1cd99f8b" /> | <img width="1293" height="837" alt="SCR-20250825-misb" src="https://github.com/user-attachments/assets/e6b5afe1-8de0-4bb7-9a72-3c7d3efab65a" /> | <img width="1131" height="797" alt="SCR-20250825-mlcq" src="https://github.com/user-attachments/assets/e3c839de-7a5b-4988-a3f6-b265226cbce6" />
diff --git a/docs/platforms/apple/common/session-replay/customredact.mdx b/docs/platforms/apple/common/session-replay/customredact.mdx
@@ -1,10 +1,21 @@
 ---
 title: Using Custom Masking for Session Replay
 sidebar_order: 5501
-notSupported:
 description: "Learn how to mask parts of your app's data in Session Replay."
+notSupported:
+  - apple.macos
+  - apple.watchos
+  - apple.tvos
+  - apple.visionos
 ---
 
+<PlatformSection notSupported={["apple.ios"]}>
+
+<Include name="apple-session-replay-support-alert" />
+
+</PlatformSection>
+
+<PlatformSection notSupported={["apple", "apple.macos", "apple.tvos", "apple.watchos", "apple.visionos"]}>
 <Alert>
 
 Before enabling Session Replay in production, verify your masking configuration to ensure no sensitive data is captured. Our default settings aggressively mask potentially sensitive data, but if you modify these settings or update UI frameworks or system SDKs, you must thoroughly test your application. If you find any masking issues or sensitive data that should be masked but isn't, please [create a GitHub issue](https://github.com/getsentry/sentry-cocoa/issues/new/choose) and avoid deploying to production with Session Replay enabled until the issue is resolved.
@@ -112,3 +123,5 @@ struct ContentView_Previews: PreviewProvider {
   }
 }
 ```
+
+</PlatformSection>
diff --git a/docs/platforms/apple/common/session-replay/index.mdx b/docs/platforms/apple/common/session-replay/index.mdx
@@ -2,10 +2,18 @@
 title: Set Up Session Replay
 sidebar_title: Session Replay
 sidebar_order: 5500
-notSupported:
 description: "Learn how to enable Session Replay in your mobile app."
+notSupported:
 ---
 
+<PlatformSection notSupported={["apple.ios"]}>
+
+<Include name="apple-session-replay-support-alert" />
+
+</PlatformSection>
+
+<PlatformSection notSupported={["apple", "apple.macos", "apple.tvos", "apple.watchos", "apple.visionos"]}>
+
 <Alert level="warning">
 
 Before enabling Session Replay in production, verify your masking configuration to ensure no sensitive data is captured. Our default settings aggressively mask potentially sensitive data, but if you modify these settings or update UI frameworks or system SDKs, you must thoroughly test your application. If you find any masking issues or sensitive data that should be masked but isn't, please [create a GitHub issue](https://github.com/getsentry/sentry-cocoa/issues/new/choose) and avoid deploying to production with Session Replay enabled until the issue is resolved.
@@ -105,24 +113,4 @@ Errors that happen while a replay is running will be linked to the replay, makin
 - The replay was deleted by a member of your org.
 - There were network errors and the replay wasn't saved.
 
-## FAQ
-
-Q: **Does Session Replay work with SwiftUI?**
-
-A: Yes. It works with both UIKit and SwiftUI.
-
-Q: **Why are parts of my replay not masked?**
-
-A: Text views, input views, images, video players and webviews are all masked by default. Images with bundled assets aren't masked because the likelihood of these assets containing PII is low. If you encounter a view that should be masked by default, consider opening a [GitHub issue](https://github.com/getsentry/sentry-cocoa/issues).
-
-Q: **What's the lowest version of iOS supported?**
-
-A: Session Replay recording happens even on the lowest version supported by the Sentry SDK, which is aligend with appstore support.
-
-Q: **Why is my issue missing a replay?**
-
-A: An issue may be missing a replay because the user's device was [offline](/product/explore/session-replay/mobile#frequently-asked-questions) while `sessionSampleRate` was specified, your project/organization was rate-limited, or (in rare cases) the device failed to capture the replay video.
-
-Q: **Does Session Replay work on macOS, watchOS, tvOS and visionOS?**
-
-A: We don't actively prevent you from using Session Replay on these platforms, but we only officially support it on iOS. As a consequence, we can't make guarantees about its functionality and performance on other platforms.
+</PlatformSection>
diff --git a/docs/platforms/apple/common/session-replay/performance-overhead.mdx b/docs/platforms/apple/common/session-replay/performance-overhead.mdx
@@ -1,10 +1,22 @@
 ---
 title: Performance Overhead
 sidebar_order: 5502
-notSupported:
 description: "Learn about how enabling Session Replay impacts the performance of your application."
+notSupported:
+  - apple.macos
+  - apple.watchos
+  - apple.tvos
+  - apple.visionos
 ---
 
+<PlatformSection notSupported={["apple.ios"]}>
+
+<Include name="apple-session-replay-support-alert" />
+
+</PlatformSection>
+
+<PlatformSection notSupported={["apple", "apple.macos", "apple.tvos", "apple.watchos", "apple.visionos"]}>
+
 If you're considering enabling Session Replay, it's important to first understand the potential performance impact to your app. While accurate metrics require realistic testing where you apply typical access patterns and correlate the results with your business metrics, to provide a baseline, we measured the overhead using the open-source [Pocket Casts](https://github.com/Automattic/pocket-casts-ios) app.
 
 You can learn more about the various performance overhead optimizations implemented in the iOS Replay SDK in the [Replay Performance Overhead](/product/explore/session-replay/mobile/performance-overhead/) docs.
@@ -78,3 +90,5 @@ SentrySDK.start(configureOptions: { options in
 The old view renderer will be deprecated and removed in a future release.
 
 </Alert>
+
+</PlatformSection>
diff --git a/docs/platforms/apple/common/session-replay/troubleshooting.mdx b/docs/platforms/apple/common/session-replay/troubleshooting.mdx
@@ -1,10 +1,52 @@
 ---
 title: Troubleshooting
 sidebar_order: 5503
-notSupported:
 description: "Troubleshoot and resolve common issues with the iOS Session Replay."
+notSupported:
+  - apple.macos
+  - apple.watchos
+  - apple.tvos
+  - apple.visionos
 ---
 
+<PlatformSection notSupported={["apple.ios"]}>
+
+<Include name="apple-session-replay-support-alert" />
+
+</PlatformSection>
+
+<PlatformSection notSupported={["apple", "apple.macos", "apple.tvos", "apple.watchos", "apple.visionos"]}>
+
+<Expandable title="Does Session Replay work with UIKit, SwiftUI or AppKit?" permalink>
+
+Session Replay works with both UIKit and SwiftUI.
+
+</Expandable>
+
+<Expandable title="Does Session Replay work on macOS, watchOS, tvOS and visionOS?" permalink>
+
+We don't actively prevent you from using Session Replay on these platforms, but we only officially [support it on iOS](/platforms/apple/guides/ios/session-replay/). As a consequence, we can't make guarantees about its functionality and performance on other platforms.
+
+</Expandable>
+
+<Expandable title="Why are parts of my replay not masked?" permalink>
+
+Text views, input views, images, video players and webviews are all masked by default. Images with bundled assets aren't masked because the likelihood of these assets containing PII is low. If you encounter a view that should be masked by default, consider opening a [GitHub issue](https://github.com/getsentry/sentry-cocoa/issues).
+
+</Expandable>
+
+<Expandable title="What's the lowest version of iOS supported?" permalink>
+
+Session Replay recording happens even on the lowest version supported by the Sentry SDK, which is aligend with appstore support.
+
+</Expandable>
+
+<Expandable title="Why is my issue missing a replay?" permalink>
+
+An issue may be missing a replay because the user's device was [offline](/product/explore/session-replay/mobile#frequently-asked-questions) while `sessionSampleRate` was specified, your project/organization was rate-limited, or (in rare cases) the device failed to capture the replay video.
+
+</Expandable>
+
 <Expandable title="AVFoundation views and layers are not rendered" permalink>
 
 Session Replay currently cannot capture content from AVFoundation views and layers. This includes:
@@ -87,3 +129,5 @@ final class SceneDelegate: NSObject, UIWindowSceneDelegate {
 ```
 
 </Expandable>
+
+</PlatformSection>
diff --git a/includes/apple-session-replay-support-alert.mdx b/includes/apple-session-replay-support-alert.mdx
@@ -0,0 +1,5 @@
+<Alert level="info">
+
+Session Replay is currently officially supported on iOS and works with both UIKit and SwiftUI. Go to the <a href="/platforms/apple/guides/ios/session-replay/">iOS specific docs</a>.
+
+</Alert>
