Repository navigation
feat(docs): Apply new quick start template to React Native quick start guides - #19987
Conversation
…t guides Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
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. Services: PlanWhat changedVisitors to RiskA 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 effectThis 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. Regression watchEach risk item maps to one signal below. Watch the rewritten React Native paths and Known noise titles on this tree include Algolia
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 observableClient 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. |
antonis
left a comment
There was a problem hiding this comment.
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:
- The features expandable has no
react-nativesection. It shows the generic JS content without Profiling on the React Native page, and renders empty on the Expo guide. - Same issue on the Expo guide.
- 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.
- 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.
antonis
left a comment
There was a problem hiding this comment.
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:
- Consola link (both pages):
createConsolaReporterisn't available in@sentry/react-native, so please link only the Console logging integration. - 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.)
- 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.
antonis
left a comment
There was a problem hiding this comment.
@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
|
@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! |
There was a problem hiding this comment.
Thank you for the changes @sfanahata and iterating on #20235
LGTM
|
Verified in
|















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.___PRODUCT_OPTION___markers. Keeps the wizard install and the manual setup fallback (React Native), and the wizard plus manual install (Expo).enableLogs: true; Application Metrics need no extra option (SDK 7.8.0+).Shared quick start expandables (
includes/quick-start-features-expandable.mdx) were left untouched; adding explicitreact-nativeentries there can be a follow-up.IS YOUR CHANGE URGENT?
PRE-MERGE CHECKLIST
via shannon.anahata.
--
View Junior Session [Sentry]