Skip to content

fix(apple): Add all undocumented options #15835

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

Jump to bottom
Merged
philprime merged 8 commits into from
Dec 23, 2025
Merged

fix(apple): Add all undocumented options #15835

philprime merged 8 commits into from
Dec 23, 2025
+567 −17

Conversation

@philprime
Copy link
Member

@philprime philprime commented Dec 16, 2025 •
edited
Loading

DESCRIBE YOUR PR

I analyzed the documentation and the codebase of Sentry Cocoa SDK to add documentation for all options.

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

Closes getsentry/sentry-cocoa#7014

@vercel
Copy link

vercel bot commented Dec 16, 2025 •
edited
Loading

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

Project Deployment Review Updated (UTC)
sentry-docs Ready Ready Preview, Comment Dec 23, 2025 7:18am
1 Skipped Deployment
Project Deployment Review Updated (UTC)
develop-docs Ignored Ignored Preview Dec 23, 2025 7:18am

@codeowner-assignment codeowner-assignment bot requested a review from a team December 16, 2025 11:34
@philprime
Copy link
Member Author

philprime commented Dec 16, 2025

@philipphofmann

This PR currently duplicates documentation for options, so they are once on the main options page at https://docs.sentry.io/platforms/apple/guides/ios/configuration/options/ and once on individual pages.

We already have some parts duplicated, e.g. https://docs.sentry.io/platforms/apple/guides/ios/configuration/options/#enableGraphQLOperationTracking and https://docs.sentry.io/platforms/apple/guides/ios/configuration/graphql-operation-tracking/

I think having one page with all the available options is benefical

@philprime philprime self-assigned this Dec 16, 2025
@philipphofmann
Copy link
Member

philipphofmann commented Dec 18, 2025

I think having one page with all the available options is benefical

I agree, yes please.

@philprime philprime marked this pull request as ready for review December 22, 2025 09:42
philipphofmann
philipphofmann approved these changes Dec 22, 2025
View reviewed changes
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.

LGTM. We could remove several mentions to the default is true in text, because the SdkOption also thas the default value already.

@codeowner-assignment codeowner-assignment bot requested a review from a team December 22, 2025 12:09
@philprime philprime requested review from a team and removed request for a team December 22, 2025 12:09
@codeowner-assignment codeowner-assignment bot requested a review from a team December 22, 2025 14:03
coolguyzone
coolguyzone reviewed Dec 22, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Dec 22, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Dec 22, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Dec 22, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Dec 22, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Dec 22, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Dec 22, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Dec 22, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Dec 22, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Dec 22, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Dec 22, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Dec 22, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Dec 22, 2025
View reviewed changes
coolguyzone
coolguyzone reviewed Dec 22, 2025
View reviewed changes
coolguyzone
coolguyzone approved these changes Dec 22, 2025
View reviewed changes
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.

Big update, nice work!

@philprime philprime enabled auto-merge (squash) December 23, 2025 07:15
@philprime philprime merged commit 05c5897 into master Dec 23, 2025
14 checks passed
@philprime philprime deleted the philprime/adding-cocoa-docs branch December 23, 2025 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@philipphofmann philipphofmann philipphofmann approved these changes

@coolguyzone coolguyzone coolguyzone approved these changes

Assignees

@philprime philprime

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

All SDK Options are documented in user facing docs

4 participants

@philprime @philipphofmann @coolguyzone