Skip to content

docs(android): Lifecycle support for Android Nav3 integration - #20137

Open
0xadam-brown wants to merge 1 commit into
masterfrom
docs/android-nav3-lifecycle-support
Open

0xadam-brown wants to merge 1 commit into
masterfrom
docs/android-nav3-lifecycle-support

Conversation

@0xadam-brown

@0xadam-brown 0xadam-brown commented Oct 21, 2026 •

Copy link
Copy Markdown
Member

⚠️ Warning

Do not merge before sentry-java #6301 is released. (This PR currently assumes that will be in 8.63.0.)

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.

Update the Android Navigation page to reflect the changes in the PR stack rooted at sentry-java #6301, which introduces support for Nav3 setups involving multiple NavDisplay <> SentryNavEffect pairs.

Supported vs non-supported setups are now listed explicitly.

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

Update the Android Navigation page to reflect the changes in the PR stack rooted at [sentry-java #6301](getsentry/sentry-java#6301), which introduces support for Nav3 setups involving multiple NavDisplay <> SentryNavEffect pairs.

Supported vs non-supported setups are now listed explicitly.
@vercel

vercel Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Oct 21, 2026 2:12pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Oct 21, 2026 2:12pm UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 21, 2026
@codeowner-assignment
codeowner-assignment Bot requested review from a team October 21, 2026 14:08
@cursor

cursor Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

The plan watches the new supported-setups copy and page loads on that route.
It also watches client errors on that URL and Android 404 counts.
An issue escalates when a new client error title appears or that route stops loading.

Services: sentry-docs.

Mention @change-monitor in a comment to update the plan.

Plan

What changed

Requests to the Android Navigation docs page now list supported Nav3 setups and unsupported ones.
The page also states a Compose UI 1.7 or lifecycle-runtime-compose 2.8.3 runtime need.
sentry-docs must deploy before this copy is live.
The live path is /platforms/android/integrations/navigation/.
Catalog id sentry-docs matches the Vercel project named in the deployment workflow.

Risk

A bad MDX render can hydrate-fail this page and raise a client error.
Wrong copy can lead app teams to use an unsupported Nav3 layout.
The catch-all route already throws TypeError xS.
A new error title on this URL is the extra risk.

Intended effect

This change is a docs edit.
Sentry does not record the new heading.
Confirmed means the live page includes the Supported Setups heading.
Absent means the live page still forbids multiple SentryNavEffect instances.
A GET of https://docs.sentry.io/platforms/android/integrations/navigation/ at 2026-10-21T14:08:34Z still used the old intro and still listed multiple active SentryNavEffect instances as unsupported.

Page loads show the route still hydrates.
They do not prove the new copy.
Treat a load count that holds while the heading is missing as intended effect absent.

Signal Baseline Window Rule Source
Live HTML Supported Setups heading Absent 2026-10-21T14:08:34Z Must be present after deploy GET https://docs.sentry.io/platforms/android/integrations/navigation/

Regression watch

This diff can break render of this page or Android docs routes that share the catch-all.
Watch client errors first.
Then watch loads on this path and 404s for platforms/android.

Last 24h is a high-load day for this path.
The prior 24h sat at the low end of the same band.
Do not treat a return to 5 loads as a regression.

The only error title on this URL is TypeError xS from issue DOCS-BE4.
That issue is open on culprit /:path*? and has 160 events over 6 days.
Users stay at 0.
A new title on this URL is a regression even if the count is small.

Signal Baseline Window Rule Source
Client errors on url *platforms/android/integrations/navigation* 3 events per 15 loads. Rate 0.00-0.20 errors per load. Title TypeError xS only. 4 events per 36 loads over 7d 2026-10-20T14:08:34Z to 2026-10-21T14:08:34Z. Prior 24h 2026-10-19T14:08:34Z to 2026-10-20T14:08:34Z had 0 events per 5 loads. 7d 2026-10-14T14:08:34Z to 2026-10-21T14:08:34Z Hold the rate in 0.00-0.20. Hold TypeError xS in 0-3 events per 24h. Detected if a new title appears or the rate rises above 0.20 Sentry org sentry project docs. Query environment:production url:*platforms/android/integrations/navigation*
docs.page.load path /platforms/android/integrations/navigation/ 15 loads per 24h. Share 15/397 of Android loads, 3.8%. Prior 24h 5 loads, share 5/527, 0.9%. 7d 36 loads 2026-10-20T14:08:34Z to 2026-10-21T14:08:34Z Hold the 24h share in 0.9%-3.8% of Android docs.page.load. Detected if this path falls to 0 while Android loads hold near 397-527 Sentry org sentry project docs. Metric docs.page.load with path:"/platforms/android/integrations/navigation/" sentry.environment:production
docs.page.not_found requested_path platforms/android 1 per 24h. 12 per 7d, about 1.7 per day 2026-10-20T14:08:34Z to 2026-10-21T14:08:34Z Hold 1-2 per 24h. Detected if the 24h count rises above 2 Sentry org sentry project docs. Metric docs.page.not_found with requested_path:"platforms/android" environment:production
Client errors on url *platforms/android/integrations* 3 per 24h. 19 per 7d, about 2.7 per day 2026-10-20T14:08:34Z to 2026-10-21T14:08:34Z Hold 3-4 per 24h. Detected if the 24h count rises above 4 or a new title appears on sibling Android integration URLs Sentry org sentry project docs. Query environment:production url:*platforms/android/integrations*

If the error rate rises, open DOCS-BE4 first and look for a new title on this URL.

Not observable

Pageload and navigation span duration for this URL returned 0 spans in 24h and in 2d.
Client traces sample at 0.3.
The catch-all transaction name is /:path*?, so this path has no span baseline.
LCP and INP for this page are unknown for the same reason.
Sentry cannot show whether app teams follow a wrong Nav3 setup after they read the page.

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — a9f7f2b1 Deployed Oct 21, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Do not merge Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant