Skip to content

Commit 1a2e1ef

Browse files
JPeer264claudesentry-junior[bot]
authored
docs(js): Move the Cloudflare quick starts into the framework guides (#19977)
## DESCRIBE YOUR PR This moves the pages under Cloudflare → Frameworks into their framework guides as "Quick Start (Cloudflare)", right below the default quick start, for example `/guides/nextjs/cloudflare/`. This applies to Astro, Hono, Next.js, Nuxt, Remix, SvelteKit and TanStack Start. The pages keep their content, and the old URLs redirect. - Next.js on Cloudflare is now a full quick start (wizard, Wrangler configuration, `withSentry` Worker entry for OpenNext and vinext, verification). - The Hydrogen guides move into the React Router guide (Hydrogen 2025.5.0 and later) and the Remix guide (older versions, as "Hydrogen (Legacy)"). - Cloudflare → Frameworks redirects to the Cloudflare quick start, which links to every framework page. - The TanStack Start page now installs `@sentry/tanstackstart-react`, which its code imports, and its Wrangler and source maps sections render again. Each framework with quick starts for more than one runtime also gets [a runtime selector](https://sentry-docs-git-jp-poc-c-runtime-quick-starts.sentry.dev/platforms/javascript/guides/nextjs/cloudflare/). It is static HTML, so the Markdown export for agents has the same links as a "Runtime" list: <img width="1288" height="483" alt="Image" src="https://github.com/user-attachments/assets/ebe5e40a-9b92-4b63-93fd-197032a552fc" /> ## Hono decision The Hono page moves as it is: it shows the Cloudflare install and configure steps, and links to the Hono quick start for the rest. The Hono quick start already covers Cloudflare in its runtime tabs, so the alternative is to redirect the old page there. A full Cloudflare quick start and the runtime selector for Hono will come in a follow up, because the Hono guide needs some rework. ## Known issues - No Bun or Deno quick starts for Next.js and Nuxt, because the SDK repo has no tests for them on these runtimes. - The Next.js verify step builds with `opennextjs-cloudflare`, so it does not apply to vinext apps. ## 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 - [x] 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](https://github.com/orgs/getsentry/teams/docs) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: sentry-junior[bot] <264270552+sentry-junior[bot]@users.noreply.github.com>
1 parent ebcdb4c commit 1a2e1ef

48 files changed

Lines changed: 2260 additions & 1116 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎AGENTS.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ When writing requirements in `develop-docs/`:
9898
- **ALWAYS** run `/brand-guidelines` to audit any user-facing content before committing. See `.agents/skills/brand-guidelines/SKILL.md`
9999
- Use `docs-review` skill for Sentry style and voice review. See `.claude/skills/docs-review/SKILL.md`
100100
- Use `technical-docs` skill when writing or reviewing SDK documentation. See `.claude/skills/technical-docs/SKILL.md`
101+
- Quick starts set `runtime` (for example `node` or `cloudflare`) in their frontmatter. The page then shows a runtime selector at the top that links the quick starts of the same guide for the other runtimes
101102

102103
## LLM-Friendly MD Exports
103104

‎docs/platforms/javascript/common/troubleshooting/index.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -636,7 +636,7 @@ Learn more about fixing these caching issues in the <PlatformLink to="/sourcemap
636636
- The `sentry.server.config.ts` file is in the root of your project, next to `nuxt.config.ts`.
637637
- Enable `debug` in the `sentry` options of your `nuxt.config.ts`. The SDK then prints a message during the build when it bundles the server config.
638638
- Remove the deprecated `autoInjectServerSentry` option, so that the SDK uses the bundled initialization.
639-
- If you're using a Cloudflare Nitro preset, the SDK doesn't use `sentry.server.config.ts`. Use the [Cloudflare Nitro plugin](/platforms/javascript/guides/cloudflare/frameworks/nuxt/) instead.
639+
- If you're using a Cloudflare Nitro preset, the SDK doesn't use `sentry.server.config.ts`. Use the [Cloudflare Nitro plugin](/platforms/javascript/guides/nuxt/cloudflare/) instead.
640640
- The SDK doesn't initialize while Nitro prerenders pages at build time, so builds don't send events.
641641
642642
---

docs/platforms/javascript/guides/cloudflare/frameworks/astro.mdx renamed to docs/platforms/javascript/guides/astro/cloudflare.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
title: Astro on Cloudflare
3+
sidebar_title: Quick Start (Cloudflare)
4+
sidebar_order: 0.5
35
description: "Learn how to instrument your Astro app on Cloudflare Workers and capture your first errors."
6+
runtime: cloudflare
47
---
58

69
## Prerequisites
@@ -99,9 +102,6 @@ export const onRequest = [
99102

100103
<Include name="quick-start-features-expandable-cloudflare-frameworks" />
101104

102-
<PlatformContent
103-
includePath="getting-started-complete"
104-
platform="javascript.astro"
105-
/>
105+
<PlatformContent includePath="getting-started-cloudflare" />
106106

107107
</StepConnector>

‎docs/platforms/javascript/guides/astro/index.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ sdk: sentry.javascript.astro
55
categories:
66
- browser
77
- server
8+
runtime: node
89
---
910

1011
## Prerequisites
@@ -18,7 +19,7 @@ You need:
1819

1920
<Alert level="warning" title="What runtime do you use?">
2021

21-
This SDK currently only works on Node runtimes, such as Node adapter or Vercel with Lambda functions. If you use Cloudflare Workers or Cloudflare Pages, refer to our [Astro on Cloudflare guide](/platforms/javascript/guides/cloudflare/frameworks/astro/). Other non-Node runtimes, like Vercel's Edge runtime, are currently **not supported**.
22+
This SDK currently only works on Node runtimes, such as Node adapter or Vercel with Lambda functions. If you use Cloudflare Workers or Cloudflare Pages, refer to our [Astro on Cloudflare guide](/platforms/javascript/guides/astro/cloudflare/). Other non-Node runtimes, like Vercel's Edge runtime, are currently **not supported**.
2223

2324
</Alert>
2425

‎docs/platforms/javascript/guides/cloudflare/frameworks/index.mdx‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎docs/platforms/javascript/guides/cloudflare/frameworks/nextjs.mdx‎

Lines changed: 0 additions & 127 deletions
This file was deleted.

‎docs/platforms/javascript/guides/cloudflare/frameworks/nuxt.mdx‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎docs/platforms/javascript/guides/cloudflare/index.mdx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ This guide covers Cloudflare Workers. If you're deploying a Cloudflare Pages app
1414

1515
If you're using any of the listed frameworks, follow their specific setup instructions:
1616

17-
- **[Astro](/platforms/javascript/guides/cloudflare/frameworks/astro/)**
18-
- **[Hono](/platforms/javascript/guides/hono/)** (with @sentry/hono)
19-
- **[Hydrogen](/platforms/javascript/guides/cloudflare/frameworks/hydrogen-react-router/)**
20-
- **[Next.js](/platforms/javascript/guides/cloudflare/frameworks/nextjs/)**
21-
- **[Nuxt](/platforms/javascript/guides/cloudflare/frameworks/nuxt/)**
22-
- **[Remix](/platforms/javascript/guides/cloudflare/frameworks/remix/)**
23-
- **[SvelteKit](/platforms/javascript/guides/cloudflare/frameworks/sveltekit/)**
24-
- **[TanStack Start](/platforms/javascript/guides/cloudflare/frameworks/tanstack-start/)**
17+
- **[Astro](/platforms/javascript/guides/astro/cloudflare/)**
18+
- **[Hono](/platforms/javascript/guides/hono/cloudflare/)** (with @sentry/hono)
19+
- **[Hydrogen](/platforms/javascript/guides/react-router/hydrogen/)**
20+
- **[Next.js](/platforms/javascript/guides/nextjs/cloudflare/)**
21+
- **[Nuxt](/platforms/javascript/guides/nuxt/cloudflare/)**
22+
- **[Remix](/platforms/javascript/guides/remix/cloudflare/)**
23+
- **[SvelteKit](/platforms/javascript/guides/sveltekit/cloudflare/)**
24+
- **[TanStack Start](/platforms/javascript/guides/tanstackstart-react/cloudflare/)**
2525

2626
<Alert level="warning" title="Cloudflare Workers limitations">
2727
The Cloudflare Workers runtime has some platform-specific limitations that
@@ -178,7 +178,7 @@ At this point, you should have integrated Sentry into your Cloudflare Worker. He
178178

179179
<Expandable permalink={false} title="Are you having problems setting up the SDK?">
180180

181-
- Check out setup instructions for popular [frameworks on Cloudflare](/platforms/javascript/guides/cloudflare/frameworks/)
181+
- Using a framework? Follow its setup instructions, linked at the top of this page
182182
- Find various support topics in <PlatformLink to="/troubleshooting/">troubleshooting</PlatformLink>
183183
- [Get support](https://www.sentry.help/en/)
184184

docs/platforms/javascript/guides/cloudflare/frameworks/hono.mdx renamed to docs/platforms/javascript/guides/hono/cloudflare.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
title: Hono on Cloudflare
33
description: "Learn how to instrument your Hono app on Cloudflare Workers with Sentry."
4+
sidebar_title: Quick Start (Cloudflare)
5+
sidebar_order: 0.5
6+
runtime: cloudflare
47
---
58

69
Hono has its own dedicated SDK (`@sentry/hono`) with first-class support for Cloudflare Workers, Node.js, Bun, and Deno. It works as Hono middleware, so you can drop it into an existing app.

‎docs/platforms/javascript/guides/nextjs/best-practices/deploying-on-cloudflare.mdx‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)