Skip to content

docs(js): Update JS quick start guides for Cloudflare and wizard+manual setup SDKs - #20170

Open
inventarSarah wants to merge 8 commits into
masterfrom
smi/quick-start/new-template-js
Open

inventarSarah wants to merge 8 commits into
masterfrom
smi/quick-start/new-template-js

Conversation

@inventarSarah

Copy link
Copy Markdown
Collaborator

DESCRIBE YOUR PR

Updates Cloudflare and Wiazrd+manual setup JS quick start guides missed in PR #19983:

Closes: #20163

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

EXTRA RESOURCES

@vercel

vercel Bot commented Oct 22, 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 22, 2026 10:33am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Oct 22, 2026 10:33am UTC

Request Review

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

cursor Bot commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

The change rewrites JavaScript quick start pages onto one template. Readers see Logs and Application Metrics steps. Product option toggles go away. An issue escalates when those page loads drop or client errors on those pages rise.

Services: sentry-docs.

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

Plan

What changed

Visitors to the JavaScript wizard and manual setup guides now see one template. The pages add Send Logs and Send Application Metrics sections. The product option toggle buttons are gone. This change ships when sentry-docs deploys. Deploy config maps the Vercel project sentry-docs to that catalog id. This change addresses issues/20163.

Risk

Broken MDX on these guides can hide setup steps or fail client render. Readers can copy incomplete SDK init code. Leftover OnboardingOption blocks can still wrap tracing sections. Cloudflare framework pages have little traffic. A failure there can hide in the pooled count.

Intended effect

The new template copy is not queryable. Use page loads on the changed paths as the proxy that those pages still render. Absent looks like this. The changed-path page loads fall toward zero. Other JavaScript guide page loads continue.

The expected shift is hold near the pooled rate. Do not treat a copy-only rewrite as a rise in traffic.

Signal Baseline Window Rule Source
docs.page.load on the changed paths 325 loads in 48h, 6.8 loads per hour 2026-10-20T10:33:47Z to 2026-10-22T10:33:47Z Hold near 6.8 per hour. Absent if the rate falls below 3.4 per hour Sentry org sentry, project docs, metric docs.page.load, environment production, path list below
docs.page.load on /platforms/javascript/guides/nextjs/manual-setup/ 101 loads in 48h, 2.1 loads per hour 2026-10-20T10:33:47Z to 2026-10-22T10:33:47Z Hold near 2.1 per hour. Absent if this path goes to zero Sentry org sentry, project docs, metric docs.page.load, environment production
docs.page.load on /platforms/javascript/guides/angular/ 70 loads in 48h, 1.5 loads per hour 2026-10-20T10:33:47Z to 2026-10-22T10:33:47Z Hold near 1.5 per hour. Absent if this path goes to zero Sentry org sentry, project docs, metric docs.page.load, environment production
docs.page.load on /platforms/javascript/guides/nuxt/ 53 loads in 48h, 1.1 loads per hour 2026-10-20T10:33:47Z to 2026-10-22T10:33:47Z Hold near 1.1 per hour. Absent if this path goes to zero Sentry org sentry, project docs, metric docs.page.load, environment production

Changed paths for the pooled row: /platforms/javascript/guides/angular/, /platforms/javascript/guides/angular/manual-setup/, /platforms/javascript/guides/astro/, /platforms/javascript/guides/cloudflare/frameworks/astro/, /platforms/javascript/guides/cloudflare/frameworks/hydrogen-react-router/, /platforms/javascript/guides/cloudflare/frameworks/nuxt/, /platforms/javascript/guides/cloudflare/frameworks/remix/, /platforms/javascript/guides/cloudflare/frameworks/tanstack-start/, /platforms/javascript/guides/nextjs/manual-setup/, /platforms/javascript/guides/nuxt/, /platforms/javascript/guides/nuxt/manual-setup/, /platforms/javascript/guides/remix/, /platforms/javascript/guides/remix/manual-setup/, /platforms/javascript/guides/sveltekit/, /platforms/javascript/guides/sveltekit/manual-setup/, /platforms/javascript/guides/tanstackstart-react/, /platforms/javascript/guides/tanstackstart-react/manual-setup/.

Regression watch

Wrong MDX can throw on these pages during client render. Pageload time can rise if the new sections blow up the page. A missing static path shows up as a page-load drop on that URL. Transaction name is /:path*?. Filter by url.path.

Traces sample at 30 percent. Compare error count to docs.page.load, not to sampled span count. The 48h error sample is 4 events. A few extra events can move the rate.

Signal Baseline Window Rule Source
Client error rate on the changed paths 4 errors in 325 page loads, 1.2% 2026-10-20T10:33:47Z to 2026-10-22T10:33:47Z Hold in 0.0-2.5%. Detected if the rate rises above 2.5% Sentry org sentry, project docs, errors, environment production, url in the changed path list
Pageload p95 on /platforms/javascript/guides/nextjs/manual-setup/ 12.5s p95, 103 pageload or navigation spans 2026-10-20T10:33:47Z to 2026-10-22T10:33:47Z Hold near 12.5s. Detected if p95 rises above 18s Sentry org sentry, project docs, spans, environment production, span.op pageload or navigation, url.path
Pageload p95 on /platforms/javascript/guides/angular/ 13.7s p95, 47 spans 2026-10-20T10:33:47Z to 2026-10-22T10:33:47Z Hold near 13.7s. Detected if p95 rises above 20s Sentry org sentry, project docs, spans, environment production, span.op pageload or navigation, url.path
Pageload p95 on /platforms/javascript/guides/nuxt/ 5.1s p95, 40 spans 2026-10-20T10:33:47Z to 2026-10-22T10:33:47Z Hold near 5.1s. Detected if p95 rises above 10s Sentry org sentry, project docs, spans, environment production, span.op pageload or navigation, url.path

If the error rate rises, inspect errors on those paths for OnboardingOption or MDX render failures.

Not observable

The new headings and code samples are not in telemetry. Page loads only show that the route still renders. docs.page.not_found stores only the first two path segments. It cannot isolate these URLs. Web vitals LCP and INP were not queried. Pageload duration is the latency watch. /platforms/javascript/guides/remix/manual-setup/ and /platforms/javascript/guides/cloudflare/frameworks/remix/ had zero page loads in the window. A regression there has no pre-ship rate.

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 07f2602e Deployed Oct 22, 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.

Apply new quick start template to JS wizard SDKs

1 participant