Skip to content

docs(cloudflare): Restructure the guide around the Vite setup - #19362

Open
JPeer264 wants to merge 1 commit into
masterfrom
janpeer/sdk-1426-cloudflare-getting-started-manual-setup-v10
Open

docs(cloudflare): Restructure the guide around the Vite setup#19362
JPeer264 wants to merge 1 commit into
masterfrom
janpeer/sdk-1426-cloudflare-getting-started-manual-setup-v10

Conversation

@JPeer264

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

Fixes what a new user hits between install and the first event, from the runtime docs audit (SDK-1426), and reorganizes the guide so the recommended Vite path leads.

This can be merged already now as this just moves things around promoting the Vite plugin to ensure people have the best experience with the SDK

  • Add the missing SDK import to the tracing verify snippets, which threw ReferenceError: Sentry is not defined when copied verbatim
  • Lead the quick start with the Vite plugin and an instrument.server.ts file, turning on the experimental autoInstrumentation and useDiagnosticsChannelInjection options
  • Add an Installation Methods section holding the Vite Plugin page, moved out of Features, and a new Wrangler page for the withSentry setup
  • Move the Cloudflare Pages setup to its own page, with a note recommending Workers with static assets
  • Move release detection and post-response spans to troubleshooting
  • Give the Hono framework page the real install and app.use(sentry()) steps instead of a bare redirect
  • List the packages the plugin instruments at build time
  • Render compatibility_date from the build date with Cloudflare's "Set this to today's date" comment, instead of pinning the SDK minimum

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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@JPeer264
JPeer264 requested review from msonnb, mydea and s1gr1d September 11, 2026 08:44
@JPeer264 JPeer264 self-assigned this Sep 11, 2026
@vercel

vercel Bot commented Sep 11, 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 Sep 11, 2026 9:07am UTC
sentry-docs Ready Ready Preview Sep 11, 2026 9:07am UTC

Request Review

@linear-code

linear-code Bot commented Sep 11, 2026

Copy link
Copy Markdown

SDK-1426

@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Sep 11, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Please update the IS YOUR CHANGE URGENT? section of the PR description:

  • Select exactly one option.
  • If you selected an urgent or other deadline, provide the date as YYYY-MM-DD.

This information helps the Docs team prioritize your review.

@codeowner-assignment
codeowner-assignment Bot requested a review from a team September 11, 2026 08:45
@JPeer264
JPeer264 added this pull request to stack #19363 September 11, 2026 08:46
Comment thread redirects.js
@JPeer264
JPeer264 force-pushed the janpeer/sdk-1426-cloudflare-getting-started-manual-setup-v10 branch from 416a998 to 2bd9dce Compare September 11, 2026 08:50
Comment thread docs/platforms/javascript/guides/cloudflare/install/wrangler.mdx
Fixes what a new user hits between install and the first event, from the
runtime docs audit (SDK-1426), and reorganizes the guide so the recommended
Vite path leads.

- Add the missing SDK import to the tracing verify snippets, which threw
  `ReferenceError: Sentry is not defined` when copied verbatim
- Lead the quick start with the Vite plugin and an `instrument.server.ts`
  file, turning on the experimental `autoInstrumentation` and
  `useDiagnosticsChannelInjection` options
- Add an Installation Methods section holding the Vite Plugin page, moved out
  of Features, and a new Wrangler page for the `withSentry` setup
- Move the Cloudflare Pages setup to its own page, with a note recommending
  Workers with static assets
- Move release detection and post-response spans to troubleshooting
- Give the Hono framework page the real install and `app.use(sentry())` steps
  instead of a bare redirect
- List the packages the plugin instruments at build time
- Render `compatibility_date` from the build date with Cloudflare's
  "Set this to today's date" comment, instead of pinning the SDK minimum

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Needs Triage The PR description is missing valid priority information

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant