Skip to content

docs(dotnet): List Android and Apple native options in the MAUI guide - #20721

Open
mliemm wants to merge 2 commits into
getsentry:masterfrom
mliemm:fix/issue-5368-maui-native-options
Open

mliemm wants to merge 2 commits into
getsentry:masterfrom
mliemm:fix/issue-5368-maui-native-options

Conversation

@mliemm

@mliemm mliemm commented Nov 11, 2026 •

Copy link
Copy Markdown

DESCRIBE YOUR PR

Fixes getsentry/sentry-dotnet#5368

Problem

The Sentry MAUI SDK exposes the embedded Android and Cocoa SDK settings through options.Native. The reference pages, Android Native Options and Apple Native Options, live under the Android and Apple guides. Someone browsing the MAUI guide never sees them in the sidebar. The only pointer is an inline link in the "Options" section of the MAUI index.

Root cause

The MAUI guide has no page of its own for native options. The Android and Apple pages are only registered under their own guides, so they never show up in the MAUI sidebar.

Fix

Add docs/platforms/dotnet/guides/maui/configuration/native-options.mdx. It appears as "Native Options" under Extended Configuration in the MAUI sidebar (sidebar_order: 5). The page:

  • explains that options.Native configures the embedded Android SDK and Cocoa SDK
  • says options.Native isn't available when targeting Windows or Tizen, and shows how to guard native options with conditional compilation
  • links to Android Native Options and Apple Native Options for the full option lists
  • points the Android and Apple native options pages back at this page, so readers can move in both directions

I kept it to one short page that links out rather than copying the two long option lists into the MAUI guide, so there is a single source of truth for each option. If you would rather have two separate sidebar entries for MAUI, I'm happy to rework it.

Behavior change

None beyond the new page, its sidebar entry, and the two cross-links from the Android and Apple native options pages.

Tests

Docs-only change, so there is no unit test to add. I checked it as follows.

  • RED: a temporary probe spec (not committed) called getDocsFrontMatterFromDirectory(docs) and expected the slug platforms/dotnet/guides/maui/configuration/native-options with title Native Options. With the new file removed it fails with expected undefined to be 'Native Options'.
  • GREEN: with the file restored the probe passes. The MAUI guide also lists the page with sidebar_order 5, next to the existing Options (1) and MSBuild Setup (10) entries.
  • pnpm exec vitest run src/docTree.spec.ts src/commonContentInheritance.spec.ts passes (39 tests).
  • pnpm lint:trailing-slash passes: all internal links use trailing slashes.
  • git diff --check is clean, and prettier --check passes on the new file.
  • The options.Native availability claim and the option names in the snippet (Native.AnrEnabled, Native.EnableAppHangTracking) were checked against the sentry-dotnet source and the existing Android and Apple pages.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: 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 supplied a deadline.

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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

The MAUI index already links the Android and Apple native options pages, but they live under the Android and Apple guides and never appear in the MAUI sidebar. Add a Native Options page to the MAUI Configuration section that explains options.Native, the conditional compilation guard, and links to both references.

Closes getsentry/sentry-dotnet#5368
Copilot AI balanced review requested due to automatic review settings November 11, 2026 07:44
@vercel

vercel Bot commented Nov 11, 2026

Copy link
Copy Markdown

@mliem2k is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Nov 11, 2026
@codeowner-assignment
codeowner-assignment Bot requested review from a team November 11, 2026 07:45
@cursor

cursor Bot commented Nov 11, 2026

Copy link
Copy Markdown
Contributor

Getting ready to monitor this change · Rollout details

Status Service Environment
⏳ Getting ready to monitor this change

@ric-oliv ric-oliv left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hi @mliemm, thank you for the contribution!
Only two changes needed are the Tizen wording and the preprocessor symbols.

Optional, and fine as a follow-up: the Android and Apple native options pages each say "These options are also available in MAUI" and link to the MAUI overview page. Pointing those links at this new page would let readers move between the pages in both directions.

Remove the Tizen mention because Sentry.Maui 4.x no longer targets it, and say options.Native only exists on Android, iOS, and Mac Catalyst. Use the ANDROID, IOS, and MACCATALYST preprocessor symbols. Link the Android and Apple native options pages to the new MAUI page.
@vercel

vercel Bot commented Nov 20, 2026

Copy link
Copy Markdown

Deployment failed for project develop-docs with the following error:

The provided GitHub repository does not contain the requested branch or commit reference. Please ensure the repository is not empty.

@vercel

vercel Bot commented Nov 20, 2026

Copy link
Copy Markdown

Deployment failed for project sentry-docs with the following error:

The provided GitHub repository does not contain the requested branch or commit reference. Please ensure the repository is not empty.

@codeowner-assignment
codeowner-assignment Bot requested a review from a team November 20, 2026 15:49
@mliemm

mliemm commented Nov 20, 2026

Copy link
Copy Markdown
Author

Changes are in ec5c239.

  • Removed the Tizen mention and rewrote the availability sentence. options.Native is now described as existing only on Android, iOS, and Mac Catalyst, which also covers a plain net10.0 build.
  • Switched the snippet to ANDROID, IOS, and MACCATALYST.
  • Pointed the Android and Apple native options pages at the new MAUI page, so the links work in both directions.

Verified with pnpm exec vitest run src/docTree.spec.ts src/commonContentInheritance.spec.ts, pnpm lint:trailing-slash, and Prettier.

@ric-oliv ric-oliv left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for the quick update, all changes look great!

I leave it to the @getsentry/docs team now.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: list native Android and Apple options in MAUI platform/guide

3 participants