Repository navigation
docs: Use "flame graph" as two words in prose - #19847
coolguyzone wants to merge 1 commit into
Conversation
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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
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: Mention PlanWhat changedReaders 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. RiskA 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 effectThis 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 watchA 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.
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 observableThe 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 |
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 sectiondocs/platforms/react-native/common/configuration/app-hangs.mdx— 1 instance in the Android ANR profiling sectiondocs/product/dashboards/.../mobile-vitals/screen-loads.mdx— 1 instance ("flamegraphs" → "flame graphs")Intentionally left as one word:
docs/product/profiling/index.mdx. That's the literal string rendered in the Sentry UI (t('Aggregate Flamegraph')instatic/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.og_imagepath, and thedifferential-flamegraphspage 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-DDwith the due date. You can update this information later by editing the PR description.SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
🤖 Generated with Claude Code