Repository navigation
fix(docs): Make quick start feature descriptions platform-neutral - #20235
Conversation
…m-neutral Remove 'unhandled rejections' from the shared Issues description, since it only applies to JavaScript, and replace the Profiles navigation steps that described transaction-based profiling with wording that fits both transaction-based and continuous/UI profiling.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
The plan checks the new Issues, Session Replay, and Profiles copy on platform quick starts. It also watches render errors, page loads, and HTTP 5xx on those pages. An issue escalates when the old copy remains, render errors appear, those page loads drop, or the new Session Replay link 404s. Services: PlanWhat changedPlatform quick start expandables now describe Issues as errors, uncaught exceptions, and crashes. Session Replay copy now says app instead of browser, and its title link now points to the Session Replay overview. Profiles help now describes aggregate flame graphs for both profiling types. sentry-docs must deploy before this copy is live. develop-docs also builds this shared source file. FeatureInfo only renders on user documentation quick starts. React Native is not on that render path in this merge. The runtime Sentry project tag is docs. RiskA FeatureInfo render failure hides every feature blurb in those expandables. That includes Tracing, Logs, Replay, Metrics, and User Feedback. Those expandables sit on JavaScript, Python, Dart, Flutter, and Ruby quick starts. The Session Replay title link now targets the overview page. A broken overview path would send readers to a 404. A compile error in this file can fail both production deploys. Intended effectThe new copy and the new Session Replay link must appear in the HTML of the platform quick starts. Absence is the old Issues, Session Replay, or Profiles wording still on the page.
Repeat the Issues string test on https://docs.sentry.io/platforms/javascript/ and https://docs.sentry.io/platforms/ruby/. Repeat the Session Replay string test on https://docs.sentry.io/platforms/dart/guides/flutter/. Python does not list Session Replay. Regression watchA throw in FeatureInfo would blank every feature blurb in the same expandable. Watch render errors and that the quick start pages still load. Watch that the new Session Replay overview link does not 404. Do not treat Event: Event
Changed-path slice in the same 24h window: Not observableLCP for Get Slack DMs about this change: cursor.com/automations/rollouts |
…criptions Mention crashes in the Issues description so it covers native crashes on mobile and desktop platforms, and describe Session Replay in terms of the user's app instead of their browser, linking to the replay overview that covers both web and mobile.
|
Verified in
|
DESCRIBE YOUR PR
Updates three feature descriptions in the shared
FeatureInfocomponent (src/components/featureInfo.tsx) so they're accurate on every platform that uses them. The component renders the "Want to learn more about these features?" and "Need help locating captured data in your Sentry project?" expandables on the JavaScript, Python, Dart/Flutter, and Ruby quick starts, plus React Native on its quick start template branch.Issues description
Session Replay description
/product/session-replay/web/product/session-replay/Profiles navigation
profileSessionSampleRate. Selecting a transaction opens an aggregate flame graph rather than a list of profile IDs, as described in Profiling Page.Where to see it (all are in collapsed expandables):
Related: #19982
IS YOUR CHANGE URGENT?
PRE-MERGE CHECKLIST