Skip to content

docs(android): Harmonize Android Navigation and Jetpack Compose docs - #19850

Open
0xadam-brown wants to merge 2 commits into
masterfrom
docs/update-android-nav3-docs
Open

0xadam-brown wants to merge 2 commits into
masterfrom
docs/update-android-nav3-docs

Conversation

@0xadam-brown

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

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

PR moves navigation-specific content from the Android Jetpack Compose page to the corresponding Navigation page. It also refines the Navigation page for consistency and correctness.

Work is a follow-up to the Nav3 docs recently introduced in #19804.

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

@vercel

vercel Bot commented Oct 8, 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 8, 2026 9:20am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 8, 2026 9:20am UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 8, 2026
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 8, 2026 08:30
@0xadam-brown
0xadam-brown force-pushed the docs/update-android-nav3-docs branch from 942d73e to 62f147e Compare October 8, 2026 08:58
Commit moves navigation-specific content from the Android Jetpack Compose page to the corresponding Navigation page. It also refines the Navigation page for consistency and correctness.
@0xadam-brown
0xadam-brown force-pushed the docs/update-android-nav3-docs branch from 62f147e to f8f5b04 Compare October 8, 2026 09:04
@0xadam-brown
0xadam-brown marked this pull request as ready for review October 8, 2026 09:06
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 8, 2026 09:06
@cursor

cursor Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks full page loads and in-app navigations on the two rewritten Android pages. It also checks client errors on those pages and on sibling Android integration pages. An issue escalates when those pages stop loading or client errors rise.

Services: sentry-docs.

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

Plan

What changed

Readers of the Jetpack Compose page no longer see Navigation install steps. That page now links to the Navigation page for that setup. Readers of the Navigation page now see Jetpack Compose Navigation 2 install, configure, and verify steps. Navigation 3 now records five back-stack entries instead of ten.

The change is live after sentry-docs deploys. These MDX files are product docs. They do not ship on develop-docs.

Risk

Broken MDX can fail static generation or page render. Readers then miss the page. The old Compose heading jetpack-compose-navigation is gone. Hash links to that heading will not find a section. The Navigation page grew a lot. A slow first load is more likely.

Intended effect

Both pages keep serving after deploy. Sampled page load and navigation spans on those URLs stay above zero.

absent looks like this: either URL has zero sampled page load and navigation spans while other docs pages still load. Telemetry cannot prove the moved prose is correct.

Traces use a 30% sample rate. Counts below are sampled spans, not full traffic.

Signal Baseline Rule Source
Compose page load spans 20 spans. Duration p75-p95 3069-6268ms. Window 2026-10-01T09:07:19Z to 2026-10-08T09:07:19Z Volume must stay above zero. Duration should stay in 3069-6268ms Sentry sentry/docs, production, span.op:pageload, http.url:*platforms/android/integrations/jetpack-compose*
Compose navigation spans 43 spans. Duration p75-p95 1001-6977ms. Same window Volume must stay above zero. Duration should stay in 1001-6977ms Sentry sentry/docs, production, span.op:navigation, http.url:*platforms/android/integrations/jetpack-compose*
Navigation page load spans 17 spans. Duration p75-p95 9990-14429ms. Same window Volume must stay above zero. This duration band is from a small sample and may be noisy Sentry sentry/docs, production, span.op:pageload, http.url:*platforms/android/integrations/navigation*
Navigation navigation spans 13 spans. Duration p75-p95 521-638ms. Same window Volume must stay above zero. Duration should stay in 521-638ms Sentry sentry/docs, production, span.op:navigation, http.url:*platforms/android/integrations/navigation*

Regression watch

This diff can break render of these two pages or sibling Android integration pages. Watch client errors on those URLs. Watch page load duration on the larger Navigation page.

Signal Baseline Rule Source
Client errors on the two pages 3 events in 7d. Titles: 2 Event: Event \Event` (type=error) captured as promise rejection, 1 TypeError: Cannot read properties of undefined (reading 'h6')`. Window 2026-10-01T09:07:19Z to 2026-10-08T09:07:19Z A matching 7d window should stay in 0-3 events. Rise above 3 is a regression. New titles also count Sentry sentry/docs, production, url:*platforms/android/integrations/jetpack-compose* OR url:*platforms/android/integrations/navigation*
Client errors on sibling Android integration pages 16 events in 7d. Same window A matching 7d window should stay in 0-16 events. Rise above 16 is a regression Sentry sentry/docs, production, url:*platforms/android/integrations/*
Navigation page load duration p75-p95 9990-14429ms from 17 sampled spans. Same window p95 should not rise above 14429ms. If it does, inspect render of the longer Navigation page Sentry sentry/docs, production, span.op:pageload, http.url:*platforms/android/integrations/navigation*

Not observable

Whether the moved install snippets are correct. Whether old hash links to jetpack-compose-navigation still help readers. LCP for these URLs. A 7d measurements.lcp query returned no points. Out-of-repo inbound links to the old Compose Navigation section.

Comment thread docs/platforms/android/integrations/navigation/index.mdx

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 686aeab3 Deployed Oct 8, 2026 by vercel[bot]
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.

1 participant