Repository navigation
Conversation
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
|
@mliem2k is attempting to deploy a commit to the Sentry Team on Vercel. A member of the Team first needs to authorize it. |
|
Getting ready to monitor this change · Rollout details
|
ric-oliv
left a comment
There was a problem hiding this comment.
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.
|
Deployment failed for project develop-docs with the following error: |
|
Deployment failed for project sentry-docs with the following error: |
|
Changes are in
Verified with |
ric-oliv
left a comment
There was a problem hiding this comment.
Thanks for the quick update, all changes look great!
I leave it to the @getsentry/docs team now.
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:options.Nativeconfigures the embedded Android SDK and Cocoa SDKoptions.Nativeisn't available when targeting Windows or Tizen, and shows how to guard native options with conditional compilationI 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.
getDocsFrontMatterFromDirectory(docs)and expected the slugplatforms/dotnet/guides/maui/configuration/native-optionswith titleNative Options. With the new file removed it fails withexpected undefined to be 'Native Options'.sidebar_order5, next to the existing Options (1) and MSBuild Setup (10) entries.pnpm exec vitest run src/docTree.spec.ts src/commonContentInheritance.spec.tspasses (39 tests).pnpm lint:trailing-slashpasses: all internal links use trailing slashes.git diff --checkis clean, andprettier --checkpasses on the new file.options.Nativeavailability 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-DDwith the due date. You can update this information later by editing the PR description.SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
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