Skip to content

docs(apple): Add missing experimental options and remove experimental-features page #17987

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
philprime wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(apple): Add missing experimental options and remove experimental-features page #17987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e63335
docs(apple): Add missing experimental options and remove experimental…
philprime Jun 2, 2026
f0e0ba7
fix(apple): Remove stale experimental features section from legacy io…
philprime Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions docs/platforms/apple/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1096,8 +1096,6 @@ This feature is only available from Xcode 13 and from macOS 12.0, iOS 15.0, tvOS

This is an experimental feature and may still have bugs. When enabled, the SDK stitches the call to Swift Async functions in one consecutive stack trace.

Learn more in the <PlatformLink to="/features/experimental-features/">Experimental Features</PlatformLink> documentation.

</SdkOption>

<SdkOption name="cacheDirectoryPath" type="string">
Expand Down Expand Up @@ -1190,6 +1188,21 @@ Learn more in the <PlatformLink to="/tracing/instrumentation/automatic-instrumen

</SdkOption>

<SdkOption name="experimental.enableUnhandledCPPExceptionsV2" type="bool" defaultValue="false">

When enabled, the SDK captures fatal C++ exceptions using a more reliable mechanism that hooks into all `__cxa_throw` calls. This provides more comprehensive and consistent exception handling across your app's runtime, regardless of the number of C++ modules or how they're linked.

**Note:** The mechanism of hooking into `__cxa_throw` could cause issues with symbolication on iOS due to caching of symbol references.


</SdkOption>

<SdkOption name="experimental.enableWatchdogTerminationsV2" type="bool" defaultValue="false">

When enabled, the SDK uses a more efficient mechanism for detecting watchdog terminations.


</SdkOption>

<SdkOption name="experimental.enableMetrics" type="bool" defaultValue="true" availableSince="9.4.0" removedSince="9.12.0">

Expand Down
55 changes: 0 additions & 55 deletions docs/platforms/apple/common/features/experimental-features.mdx
View file
Open in desktop

This file was deleted.

4 changes: 0 additions & 4 deletions docs/platforms/apple/common/features/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,6 @@ All features listed below are **enabled by default** unless otherwise noted. Som
- Offline caching when a device is unable to connect; we send a report once we receive another event
- Event persistence: crash reports persist to disk and are sent upon application start if not sent immediately after a crash

Copy link
Copy Markdown
Contributor

@sentry sentry Bot Jun 2, 2026

Choose a reason for hiding this comment

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

Bug: The static file public/_platforms/apple/ios.json is not regenerated and contains stale references to the deleted experimental-features page, which may cause issues for consuming systems.
Severity: LOW

Suggested Fix

Manually update the public/_platforms/apple/ios.json file to remove all references to the deleted experimental-features page. Alternatively, confirm with the relevant team whether this file is still in use. If it is deprecated, consider removing it entirely.

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/common/features/index.mdx#L85

Potential issue: The build process does not automatically regenerate the
`public/_platforms/apple/ios.json` file. This static, checked-in file contains stale
references and HTML content related to a now-deleted `experimental-features` page.
According to documentation, this file may be consumed by an external utility in the main
Sentry repository. If that utility is still in use and attempts to process the stale
links from this JSON, it could lead to broken links or other failures in the integration
documentation system.

Also affects:

  • docs/platforms/apple/guides/macos/features/index.mdx:92~92
  • docs/platforms/apple/guides/visionos/features/index.mdx:71~71

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

## Experimental Features

For information about experimental features, see the <PlatformLink to="/features/experimental-features">Experimental Features</PlatformLink> page.

## Platform-Specific Documentation

For platform-specific feature details and limitations, see:
Expand Down
4 changes: 0 additions & 4 deletions docs/platforms/apple/guides/macos/features/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,6 @@ For macOS apps using UIKit (Mac Catalyst), the following features are also avail
- <PlatformLink to="/logs">Logs capturing</PlatformLink> available (requires `enableLogs` option)
- Offline caching when a device is unable to connect; we send a report once we receive another event

## Experimental Features

For information about experimental features available on macOS, see the <PlatformLink to="/features/experimental-features">Experimental Features</PlatformLink> page.

## macOS Limitations

macOS has some limitations compared to iOS:
Expand Down
4 changes: 0 additions & 4 deletions docs/platforms/apple/guides/visionos/features/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,4 @@ visionOS supports comprehensive error detection:
- <PlatformLink to="/logs">Logs capturing</PlatformLink> available (requires `enableLogs` option)
- <PlatformLink to="/user-feedback">User Feedback</PlatformLink> via programmatic API (no UI available)

## Experimental Features

For information about experimental features that may be available on visionOS, see the <PlatformLink to="/features/experimental-features">Experimental Features</PlatformLink> page.

For configuration options and detailed documentation, see the <PlatformLink to="/configuration">Configuration</PlatformLink> section.
2 changes: 1 addition & 1 deletion public/_platforms/apple/ios.json
View file
Open in desktop

Large diffs are not rendered by default.

Loading