Skip to content

fix(docs): Make quick start feature descriptions platform-neutral - #20235

Merged
sfanahata merged 2 commits into
masterfrom
docs/feature-info-neutral-wording
Oct 27, 2026
Merged

sfanahata merged 2 commits into
masterfrom
docs/feature-info-neutral-wording

Conversation

@sfanahata

@sfanahata sfanahata commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Updates three feature descriptions in the shared FeatureInfo component (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

  • Before: "...automatically reports errors, uncaught exceptions, and unhandled rejections."
  • After: "...automatically reports errors, uncaught exceptions, and crashes."
  • "Unhandled rejections" is JavaScript-specific (promise rejections). It shows on every page that lists Issues, including Python, Ruby, and Dart, where it doesn't apply.
  • The old text didn't mention crashes. Native crashes are a core part of error monitoring on React Native, Flutter, Electron, and Capacitor.

Session Replay description

  • Before: "...a video-like reproduction of what was happening in the user's browser..." linking to /product/session-replay/web
  • After: "...a video-like reproduction of what users saw in your app..." linking to /product/session-replay/
  • Session Replay also records mobile app screens (Flutter on master, React Native on its template branch), so "browser" and the web-only link were inaccurate there. The overview page covers both web and mobile replay.

Profiles navigation

  • Before: "Open the Profiles page, select a transaction, and then a profile ID to view its flame graph."
  • After: "Open the Profiles page to see your slowest functions and an aggregate flame graph of your most frequent code paths. If tracing is enabled, select a transaction to see the flame graph for that part of your app."
  • The old steps describe transaction-based profiling. Python and the JavaScript server SDKs now use continuous profiling, and the browser-based guides (Astro, React Router, Remix) use profileSessionSampleRate. Selecting a transaction opens an aggregate flame graph rather than a list of profile IDs, as described in Profiling Page.
  • The new wording works for both profiling types. Ruby still uses transaction-based profiling. Platform-specific details stay on each platform's profiling pages, and the existing Profile Details link is unchanged.

Where to see it (all are in collapsed expandables):

Related: #19982

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

…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.
@vercel

vercel Bot commented Oct 26, 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:27pm UTC
sentry-docs Ready Ready Preview Oct 26, 2026 10:27pm UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 26, 2026
@cursor

cursor Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

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.

Rollout complete

Services: sentry-docs, develop-docs.

Plan

What changed

Platform 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.

Risk

A 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 effect

The 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.

Signal Baseline Window Rule Source
Issues learn-more text Old phrase unhandled rejections is still present Fetch at 2026-10-27T19:57:00Z Must show automatically reports errors, uncaught exceptions, and crashes. The old phrase must be gone GET https://docs.sentry.io/platforms/python/ and https://docs.sentry.io/platforms/javascript/guides/react/
Session Replay learn-more text and title link Old phrase user's browser is still present on the React quick start Fetch at 2026-10-27T19:57:00Z Must show what users saw in your app. The title link must target /product/session-replay/ not /product/session-replay/web GET https://docs.sentry.io/platforms/javascript/guides/react/
Profiles find-in-Sentry text Old steps select a transaction, and then a profile ID are still present Fetch at 2026-10-27T19:57:00Z Must show aggregate flame graph of your most frequent code paths. The old profile ID steps must be gone GET https://docs.sentry.io/platforms/python/

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 watch

A 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 Event captured as promise rejection as this change. Production had 795 error events in the window. Most of that volume is unrelated client noise.

Signal Baseline Window Rule Source
FeatureInfo, hydration, or Minified React errors 0 events 2026-10-26T19:57:00Z to 2026-10-27T19:57:00Z Hold at 0 Sentry org sentry, project docs. Query environment:production with hydration or Minified React error or FeatureInfo
HTTP 5xx pageloads 0 spans 2026-10-26T19:57:00Z to 2026-10-27T19:57:00Z Hold at 0 Sentry spans. Query environment:production span.op:pageload http.response_status_code:>=500
docs.page.load for page_type platforms Hourly 264-792 last 24h. Same hours a day earlier 201-708 2026-10-26T20:00:00Z to 2026-10-27T19:00:00Z. Prior day 2026-10-25T20:00:00Z to 2026-10-26T19:00:00Z Hold hourly 200-800 Sentry metrics docs.page.load with environment:production page_type:platforms
docs.page.not_found for Session Replay 0 events with requested_path matching session-replay 2026-10-26T19:57:00Z to 2026-10-27T19:57:00Z Hold at 0 Sentry metrics docs.page.not_found with environment:production requested_path:*session-replay*

Changed-path slice in the same 24h window: /platforms/javascript/ 92 loads, /platforms/python/ 76 loads, /platforms/javascript/guides/react/ 67 loads, /platforms/dart/guides/flutter/ 44 loads. Escalate if Python, JavaScript, React, or Flutter landing loads fall to zero. The Session Replay overview already has 84 loads at /product/session-replay/. The old web page still has 25 loads at /product/session-replay/web/.

Not observable

LCP for /platforms/ pageloads returned no rows in the first plan, so web vitals stay unknown. Prior-day docs.page.load for the landing paths was not measured as its own window, so a modest drop on those paths cannot be judged. Plausible Open Expandable events are not connected. Pageload spans are sampled at 0.3. develop.sentry.dev does not render FeatureInfo. React Native quick starts do not use FeatureInfo in this merge.

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.
@sfanahata sfanahata changed the title fix(docs): Make quick start Issues and Profiling descriptions platform-neutral fix(docs): Make quick start feature descriptions platform-neutral Oct 26, 2026

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

LGTM

@sfanahata
sfanahata merged commit 00887fa into master Oct 27, 2026
30 checks passed
@sfanahata
sfanahata deleted the docs/feature-info-neutral-wording branch October 27, 2026 19:56
@cursor

cursor Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Verified in production

  • The new Issues, Session Replay, and Profiles copy is live on the platform quick starts.
  • Live platform quick starts still show the new copy, and render errors and 5xx stayed at zero.
  • The new Issues, Session Replay, and Profiles copy is live on the platform quick starts.

This branch was successfully deployed

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

3 participants