Skip to content

docs(android): Add Navigation 3 integration docs - #19804

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

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

Conversation

@0xadam-brown

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

Copy link
Copy Markdown
Member

Warning

do not merge before sentry-jave 8.60.0 release

DESCRIBE YOUR PR

Documents Android Navigation 3 (aka, "Nav3") support and clarifies how it differs from the existing Navigation 2 integration.

Also updates the Android features page so our Nav3 docs are easier to discover from high-level SDK feature docs.

Nav3 support was implemented by the PR stack rooted at sentry-java #6128, and later modified by sentry-java #6197 and sentry-java #6201.

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.): 2026-10-07
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

We have a soft release coming up on October 7. Not extremely urgent, but all the better if we're able to get these docs published as soon as we can after that date. Thanks in advance! 🙌

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

@vercel

vercel Bot commented Oct 5, 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 5, 2026 1:16pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 5, 2026 1:16pm UTC

Request Review

@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Oct 5, 2026
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 5, 2026 12:48
@github-actions

This comment was marked as resolved.

@github-actions github-actions Bot added Priority: Urgent Docs review is needed immediately for an urgent deadline and removed Priority: Needs Triage The PR description is missing valid priority information labels Oct 5, 2026
@0xadam-brown
0xadam-brown force-pushed the feat/android-nav3-support branch from 5a63904 to cab4b4f Compare October 5, 2026 12:59
Document Navigation 3 support on the Android navigation integration page and clarify how it differs from the existing Navigation 2 integration. Align the examples with the current SDK API shape, including route name extraction, optional argument extraction, back stack capture options, and route data scrubbing.
@0xadam-brown
0xadam-brown force-pushed the feat/android-nav3-support branch from cab4b4f to 53c392e Compare October 5, 2026 13:10
@0xadam-brown
0xadam-brown marked this pull request as ready for review October 5, 2026 13:40
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 5, 2026 13:40
@cursor

cursor Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks request volume on the updated Navigation docs page, client errors on that page, and Android not-found counts. An issue escalates when those errors rise or not-found counts for Android docs rise.

Services: sentry-docs.

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

Plan

What changed

Requests to /platforms/android/integrations/navigation/ now include Navigation 3 setup steps. Navigation 2 setup stays on the same page under a new heading. Four new screenshots ship with the Navigation 3 verify steps.

sentry-docs must deploy before this page is live. The site prebuilds pages, so a production deploy ships the page.

Risk

A broken MDX file can drop this page from the static set. Readers then get a not-found page. New headings, code tabs, and images can throw in the page renderer. The new Compose Navigation link can point at a missing page.

Intended effect

The new Navigation 3 copy is not queryable. Span volume on this URL shows that the rebuilt page is served. Absent looks like that span count at zero after deploy.

Signal Baseline Window Source Compare
Sampled spans whose transaction or http.url contains /platforms/android/integrations/navigation 907 spans in 7d, about 130 spans per day 2026-09-28T13:41:13Z to 2026-10-05T13:41:13Z Sentry traces, org sentry, project docs. Query: transaction:*platforms/android/integrations/navigation* OR http.url:*platforms/android/integrations/navigation*. Field: count(). Client traces sample at 30%. Hold near this 7d volume. Confirmed if a later 7d count stays well above zero. Absent if the count is 0 after deploy.

Regression watch

This change can 404 the Navigation page or throw in its renderer. It can also break the linked Compose Navigation page.

Signal Baseline Window Source Compare
Error events whose transaction or url contains /platforms/android/integrations/navigation 4 events in 7d. Titles: TypeError: Cannot read properties of undefined (reading 'h6') 2, SecurityError cross-origin frame 1, promise Event rejection 1 2026-09-28T13:41:13Z to 2026-10-05T13:41:13Z Sentry errors, org sentry, project docs. Query: transaction:*platforms/android/integrations/navigation* OR url:*platforms/android/integrations/navigation*. Field: count(). Hold 0-4 events per 7d. Detected if a later 7d count rises above 4, or if h6 TypeError rises above 2.
docs.page.not_found with requested_path:platforms/android 3 counts 2026-10-04T13:41:13Z to 2026-10-05T13:41:13Z Sentry metrics, org sentry, project docs. Query: metric.name:docs.page.not_found AND requested_path:platforms/android. Field: sum(value). This path stores only the first two segments, so other Android 404s share it. Hold 0-3 per 24h. Detected if a later 24h sum rises above 3.
Logs with message MDX file not found at runtime 0 2026-10-04T13:41:13Z to 2026-10-05T13:41:13Z Sentry logs, org sentry, project docs. Query: message:"*MDX file not found at runtime*". Field: count(). Hold at 0. Detected if the count rises above 0.
docs.page.load for path containing /platforms/android/integrations/jetpack-compose 2 counts 2026-10-04T13:41:13Z to 2026-10-05T13:41:13Z Sentry metrics, org sentry, project docs. Query: metric.name:docs.page.load AND path:*platforms/android/integrations/jetpack-compose*. Field: sum(value). Hold near 2 per 24h. The sample is small. Treat a single zero 24h as weak unless Android not-found also rises.

Not observable

The Navigation 3 heading text and screenshot pixels are not queryable. Page-level LCP and CLS for this URL are not queryable. The metrics API rejected a URL filter. Whether package sentry-android-navigation3 version 8.60.0 exists is not a docs-site signal.

@coolguyzone coolguyzone 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.

LGTM

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 53c392ea Deployed Oct 5, 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: Urgent Docs review is needed immediately for an urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants