Skip to content

docs: Use "flame graph" as two words in prose - #19847

Open
coolguyzone wants to merge 1 commit into
masterfrom
Coolguyzone/fix/flame-graph-two-words
Open

coolguyzone wants to merge 1 commit into
masterfrom
Coolguyzone/fix/flame-graph-two-words

Conversation

@coolguyzone

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

The docs were inconsistent between "flamegraph" and "flame graph". This standardizes body copy on the two-word spelling, which is the grammatically correct form and already the dominant usage across the profiling docs.

  • docs/platforms/android/configuration/app-not-respond.mdx — 3 instances in the ANR profiling section
  • docs/platforms/react-native/common/configuration/app-hangs.mdx — 1 instance in the Android ANR profiling section
  • docs/product/dashboards/.../mobile-vitals/screen-loads.mdx — 1 instance ("flamegraphs" → "flame graphs")

Intentionally left as one word:

  • The Aggregate Flamegraph tab references in docs/product/profiling/index.mdx. That's the literal string rendered in the Sentry UI (t('Aggregate Flamegraph') in static/app/views/explore/profiling/content.tsx), so the docs should match the product. If we want this to read "Aggregate Flame Graph", the product string has to change first.
  • Image filenames, the og_image path, and the differential-flamegraphs page slug — changing those means moving files and adding redirects for no reader-visible benefit.

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

🤖 Generated with Claude Code

Standardizes on the two-word spelling in body copy. Leaves the
**Aggregate Flamegraph** tab references in the profiling docs alone,
since that's the literal label rendered in the Sentry UI, and leaves
image filenames, og_image paths, and the differential-flamegraphs slug
untouched.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

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

Request Review

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

cursor Bot commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks client errors on the edited pages and whether those pages still load. It also watches site-wide client errors on the documentation site. An issue escalates when the edited pages start to report errors.

Services: sentry-docs.

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

Plan

What changed

Readers of three documentation pages now see the two-word spelling flame graph in body copy. The pages are the Android ANR guide, the React Native app hangs guide, and the mobile screen loads guide. sentry-docs must deploy before this wording is live.

Risk

A broken MDX file can fail the static build or render a broken page. The blast radius is those three pages. The change does not touch shared app code.

Intended effect

This docs edit has no queryable effect. The new wording does not emit a metric or a log. Telemetry cannot mark the intended effect confirmed or absent.

Regression watch

A bad MDX render would first show as client errors on the edited pages. Users would see a broken page. Site-wide client errors are a same-ship watch if the page shell fails.

Known noise in site-wide errors includes failed fetches to insights.algolia.io and proxy.kapa.ai. Do not treat those third-party fetch failures as this change.

Signal Baseline Comparison Window Source
Client errors on the three page URLs 0 Hold at zero. Escalate if any error appears. 2026-10-06T20:36:54Z to 2026-10-07T20:36:54Z Sentry org sentry, project docs. Query: environment:production AND (url:*app-not-respond* OR url:*app-hangs* OR url:*screen-loads*)
Pageloads on the Android ANR page 7 pageloads, p95 5273ms Hold above zero pageloads. Latency is too thin for a band. 2026-10-06T20:36:54Z to 2026-10-07T20:36:54Z Sentry org sentry, project docs. Query: span.op:pageload environment:production url:*app-not-respond*
Site-wide client error rate 140 errors / 18336 pageload and navigation spans = 0.76% Hold near 0.76%. Escalate if the rate rises well above this level. 2026-10-06T20:36:54Z to 2026-10-07T20:36:54Z Sentry org sentry, project docs. Errors: environment:production with count(). Traffic: (span.op:pageload OR span.op:navigation) environment:production

The React Native app hangs page and the screen loads page had no sampled pageloads in this window. Use the error row for those pages.

Not observable

The published spelling of flame graph on the three pages is not in connected telemetry. The React Native and screen loads page-load volume was not measurable in the sampled traces.

Get Slack DMs about this change: cursor.com/automations/rollouts

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 2f604f56 Deployed Oct 7, 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