Skip to content

feat(docs): Apply new quick start template to React Native quick start guides - #19987

Merged
sfanahata merged 4 commits into
masterfrom
docs/quickstart-template-react-native
Oct 27, 2026
Merged

sfanahata merged 4 commits into
masterfrom
docs/quickstart-template-react-native

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 15, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Applies the quick start template from #19295 (Ember) to the React Native quick start (common/index.mdx) and the Expo guide. Both pages keep their single-column layout.

  • Removes the onboarding option checkboxes and ___PRODUCT_OPTION___ markers. Keeps the wizard install and the manual setup fallback (React Native), and the wizard plus manual install (Expo).
  • Configure names the features the guide sets up (Error Monitoring, Tracing, Profiling, Session Replay, User Feedback, Logs, Application Metrics). The init snippets include all options by default, and a note explains that unwanted options can be removed.
  • Logs need enableLogs: true; Application Metrics need no extra option (SDK 7.8.0+).
  • Adds Send Logs (with Console logging and Consola integration links) and Send Application Metrics as their own steps, and simplifies Verify.
  • Size Analysis isn't an init option, so the React Native guide links to its setup page.

Shared quick start expandables (includes/quick-start-features-expandable.mdx) were left untouched; adding explicit react-native entries there can be a follow-up.

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

  • 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

via shannon.anahata.

--

View Junior Session [Sentry]

…t guides

Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
@vercel

vercel Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
develop-docs Ready Ready Preview Oct 26, 2026 10:45pm UTC
sentry-docs Ready Ready Preview Oct 26, 2026 10:45pm UTC

Request Review

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

cursor Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

The plan watches page loads on the rewritten guides, page loads on a sibling guide that shares the expandable, and client errors. An issue escalates when those loads fall or new client errors appear.

Rollout complete

Services: sentry-docs.

Plan

What changed

Visitors to /platforms/react-native/ and /platforms/react-native/guides/expo/ now see the shared quick-start template. The pages no longer show onboarding option checkboxes. The init snippet always enables tracing, profiling, session replay, logs, and user feedback. The shared expandables now render a React Native FeatureInfo block that includes profiling. The javascript FeatureInfo block now sets notSupported for react-native so those pages do not use the javascript fallback. This change is live after sentry-docs deploys.

Risk

A bad render can blank the two rewritten guides. A PlatformSection mismatch in the shared expandables can hide FeatureInfo on javascript guides that already include them. FeatureInfo and new snippets can throw in the browser. Removed headings can 404 inbound links. Invalid include MDX fails the deploy.

Intended effect

This is a docs copy rewrite. Sentry has no signal that the new headings, always-on snippet, or React Native FeatureInfo are on the live pages. intended_effect stays unknown from telemetry. Absent would mean the live pages still show the old checkbox onboarding UI, or still show the javascript FeatureInfo on React Native pages.

Regression watch

Each risk item maps to one signal below. Watch the rewritten React Native paths and /platforms/javascript/, which shares the edited expandable. The last 24h React Native error count is quiet versus the 7 day total. Treat a return toward that 7 day daily mean as possible seasonality unless new error titles appear.

Known noise titles on this tree include Algolia insights.algolia.io fetch failures, UnhandledRejection Object Not Found Matching Id, TypeError reads of mw or GS, and Event captured as promise rejection.

Signal Baseline Window Source Rule
docs.page.load for path:/platforms/react-native/ 88 loads in 2026-10-26T19:58:00Z to 2026-10-27T19:58:00Z. 99 loads in 2026-10-25T19:58:00Z to 2026-10-26T19:58:00Z. Band 88-99 loads per 24h. 24h slices ending 2026-10-27T19:58:00Z Sentry org sentry project docs. Metric docs.page.load with path:/platforms/react-native/. Hold in 88-99 per 24h. Escalate if the 24h count falls below 40 while /platforms/javascript/ still loads.
docs.page.load for path:/platforms/react-native/guides/expo/ 53 loads in 2026-10-26T19:58:00Z to 2026-10-27T19:58:00Z. 49 loads in 2026-10-25T19:58:00Z to 2026-10-26T19:58:00Z. Band 49-53 loads per 24h. 24h slices ending 2026-10-27T19:58:00Z Sentry org sentry project docs. Metric docs.page.load with path:/platforms/react-native/guides/expo/. Hold in 49-53 per 24h. Escalate if the 24h count falls below 25 while the React Native index still loads.
docs.page.load for path:/platforms/javascript/ 92 loads in 2026-10-26T19:58:00Z to 2026-10-27T19:58:00Z. 95 loads in 2026-10-25T19:58:00Z to 2026-10-26T19:58:00Z. Band 92-95 loads per 24h. 24h slices ending 2026-10-27T19:58:00Z Sentry org sentry project docs. Metric docs.page.load with path:/platforms/javascript/. Hold in 92-95 per 24h. Escalate if the 24h count falls below 45. This is the sibling path for the edited javascript PlatformSection.
Client errors on url:*/platforms/react-native/* 2 events in 2026-10-26T19:58:00Z to 2026-10-27T19:58:00Z. 245 events in 2026-10-20T19:58:00Z to 2026-10-27T19:58:00Z, about 35 per day. 24h and 7d ending 2026-10-27T19:58:00Z Sentry org sentry project docs. Errors query url:"*/platforms/react-native/*". Hold in 2-35 events per 24h. Escalate above 35 only when new titles are not the known noise.
Pageload failure rate on React Native URLs 1.7% on 403 sampled pageload spans in 2026-10-26T19:58:00Z to 2026-10-27T19:58:00Z. 2.1% on the prior 24h implied by 740 spans and 0.95% over 48h. Band 1.7-2.1%. Segment name is /:path*?. 24h slices ending 2026-10-27T19:58:00Z Sentry org sentry project docs. Spans query span.op:pageload AND url.path:"*/platforms/react-native*". Client traces sample at 30%. Hold in 1.7-2.1%. Escalate if the 24h rate rises above 4.2%.

If error rate rises, inspect FeatureInfo, expandables, and code tabs on the rewritten pages first. Then inspect javascript guides that include the same expandable.

Not observable

Client error counts limited to only the two rewritten URLs. Live HTML that would show the new headings or the React Native FeatureInfo. Missing-heading 404s. docs.page.not_found for requested_path:*react-native* returned no rows in 2026-10-26T19:58:00Z to 2026-10-27T19:58:00Z. Prior-day not_found was not measured. No content crawler is connected.

@antonis
antonis self-requested a review October 16, 2026 10:54

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

Thanks for migrating these to the new template. Reviewing from the React Native SDK side: the init snippet APIs (Sentry.logger, Sentry.metrics, profilesSampleRate, feedbackIntegration(), mobileReplayIntegration()) all match the SDK, and Metrics really does need 7.8.0+.

Requesting changes for three items, marked Blocking inline:

  1. The features expandable has no react-native section. It shows the generic JS content without Profiling on the React Native page, and renders empty on the Expo guide.
  2. Same issue on the Expo guide.
  3. The Sentry.nativeCrash() verify tab and the Playground link were removed.

The rest are suggestions and nits.

A note on removed anchors: on Expo, #automatic-install, #prerequisites, #verify-setup, #notes and #integrate-sentry-with-your-eas-dashboard; on React Native, #features and #verify. Nothing inside the docs links to them, but #integrate-sentry-with-your-eas-dashboard is likely linked from outside, for example from Expo's docs. Consider keeping that heading wording ("Integrate Sentry with your EAS dashboard") so the anchor keeps working.

Comment thread docs/platforms/react-native/common/index.mdx
Comment thread docs/platforms/react-native/guides/expo/index.mdx
Comment thread docs/platforms/react-native/common/index.mdx Outdated
Comment thread docs/platforms/react-native/common/index.mdx
Comment thread docs/platforms/react-native/common/index.mdx Outdated
Comment thread docs/platforms/react-native/guides/expo/index.mdx Outdated
Comment thread docs/platforms/react-native/guides/expo/index.mdx Outdated
Comment thread docs/platforms/react-native/guides/expo/index.mdx
- Add a React Native section (react-native, react-native.expo) to the
  features and locate-data expandables, and exclude react-native from
  the generic JavaScript section it fell back to.
- Restore the Native Crash verify tab and the Playground link.
- Restore the source maps and Apple Privacy Manifest Next Steps links.
- Clarify that the feedback form opens with Sentry.showFeedbackWidget().
- Expo: fix the init lead-in, add the locate-data expandable, and keep
  the #integrate-sentry-with-your-eas-dashboard anchor.
@sentry-junior

sentry-junior Bot commented Oct 20, 2026

Copy link
Copy Markdown
Contributor Author

Screenshots

Rendered from the Vercel preview for this branch (docs/quickstart-template-react-native, commit c19020a). The "before" shots are the same pages on production (docs.sentry.io). Expandables were opened, and highlights were added, for review only.

React Native (/platforms/react-native/)

Before: Features list, onboarding option checkboxes, and option-based init snippet
Before: React Native

After: updated description, new Configure copy, React Native features expandable, and what the snippet enables
After: React Native intro and Configure

After: init snippet with all options enabled, and Wrap Your App always shown
After: React Native init snippet

After: new Send Logs and Send Application Metrics steps, simplified Verify, View Captured Data, and Next Steps
After: React Native send and verify

Expo (/platforms/react-native/guides/expo/)

Before: Prerequisites, Automatic/Manual Install headings, option checkboxes, and option-based init snippet
Before: Expo setup

Before: Button-based Verify, Notes, and the EAS section at the end of the page
Before: Expo verify and EAS

After: updated description, Prerequisites folded into Install, Manual Install as a subsection, and the new Configure section
After: Expo install and Configure

After: EAS integration moved into setup, and Build Notes
After: Expo EAS

After: new Send Logs and Send Application Metrics steps, simplified Verify, View Captured Data, and Next Steps
After: Expo send and verify

Rendering note: in both Next Steps lists, the <PlatformLink> items that Prettier split across lines render their text inside a <p>, so those bullets get extra vertical space (visible in the last screenshot of each page). Keeping each <PlatformLink> on one line should fix it.

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

Thanks for the quick turnaround and the screenshots. All the earlier feedback is addressed, and I've checked it on the preview.

Two more things before I approve:

  1. Consola link (both pages): createConsolaReporter isn't available in @sentry/react-native, so please link only the Console logging integration.
  2. Next Steps spacing (both pages): keep each <PlatformLink> on one line, as noted in your screenshot comment.

Once these are in, I'll approve from the React Native side. (The generic web wording in the shared feature descriptions, such as "the user's browser" for Session Replay, comes from featureInfo.tsx and is out of scope here; we'll follow up separately.)

Comment thread docs/platforms/react-native/common/index.mdx Outdated
Comment thread docs/platforms/react-native/guides/expo/index.mdx Outdated
Comment thread docs/platforms/react-native/common/index.mdx Outdated
Comment thread docs/platforms/react-native/guides/expo/index.mdx Outdated
- createConsolaReporter isn't available in @sentry/react-native, so link
  only the Console logging integration on React Native and Expo.
- Keep each Next Steps PlatformLink on one line so the bullets don't
  render with extra paragraph spacing; add prettier-ignore so the
  formatter doesn't split them again.
@sentry-junior

sentry-junior Bot commented Oct 20, 2026

Copy link
Copy Markdown
Contributor Author

Screenshots (updated)

Re-rendered from the Vercel preview for this branch (docs/quickstart-template-react-native, latest commit 4407061). This replaces the earlier screenshots comment, which was taken at c19020a. The "before" shots are the same pages on production (docs.sentry.io). Expandables were opened, and highlights were added, for review only.

Changes since the last set: the Consola integration link is gone from Send Logs, and the Next Steps links now render with even spacing. The earlier rendering note no longer applies.

React Native (/platforms/react-native/)

Before: Features list, onboarding option checkboxes, and option-based init snippet
Before: React Native

After: updated description, new Configure copy, React Native features expandable, and what the snippet enables
After: React Native intro and Configure

After: init snippet with all options enabled, and Wrap Your App always shown
After: React Native init snippet

After: new Send Logs and Send Application Metrics steps, simplified Verify, View Captured Data, and Next Steps
After: React Native send and verify

Expo (/platforms/react-native/guides/expo/)

Before: Prerequisites, Automatic/Manual Install headings, option checkboxes, and option-based init snippet
Before: Expo setup

Before: Button-based Verify, Notes, and the EAS section at the end of the page
Before: Expo verify and EAS

After: updated description, Prerequisites folded into Install, Manual Install as a subsection, and the new Configure section
After: Expo install and Configure

After: EAS integration moved into setup, and Build Notes
After: Expo EAS

After: new Send Logs and Send Application Metrics steps, simplified Verify, View Captured Data, and Next Steps
After: Expo send and verify

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

@sfanahata I iterated on this with junior and overall LGTM. I think there are two remaining nits:

  • Session Replay says it shows "what was happening in the user's browser". On React Native it replays the mobile app's screens.
  • Issues mentions "uncaught exceptions, and unhandled rejections" but not native crashes, which are a core part of React Native error monitoring.

Both strings are hard-coded for every platform in src/components/featureInfo.tsx

@sfanahata

Copy link
Copy Markdown
Contributor

@antonis I have a PR to fix this section. I missed the session replay update, so I'll add to it. Thanks so much for taking this the rest of the way!

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

Thank you for the changes @sfanahata and iterating on #20235
LGTM

@sfanahata
sfanahata merged commit b7a3f54 into master Oct 27, 2026
28 checks passed
@sfanahata
sfanahata deleted the docs/quickstart-template-react-native branch October 27, 2026 19:57
@cursor

cursor Bot commented Oct 27, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • The React Native quick starts still use the shared template, and error rates stayed in band.

This branch was successfully deployed

2 active deployments
Preview – sentry-docs — fea7714d Deployed Oct 26, 2026 by vercel[bot]
Preview – develop-docs — fea7714d Deployed Oct 26, 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.

2 participants