From 3fc6a096f184601bfec1a20c1a0fbfe7431bf66f Mon Sep 17 00:00:00 2001
From: Nicolas Hrubec
Date: Wed, 23 Sep 2026 11:20:01 +0200
Subject: [PATCH 1/2] docs(nitro): Point README to SDK documentation
Co-Authored-By: GPT-6
---
packages/nitro/README.md | 120 +++------------------------------------
1 file changed, 7 insertions(+), 113 deletions(-)
diff --git a/packages/nitro/README.md b/packages/nitro/README.md
index 459d8087ce0a..c25d2c23a3f0 100644
--- a/packages/nitro/README.md
+++ b/packages/nitro/README.md
@@ -4,126 +4,20 @@
-> NOTICE: This package is in beta state and may be subject to breaking changes.
-
# Official Sentry SDK for Nitro
[](https://www.npmjs.com/package/@sentry/nitro)
[](https://www.npmjs.com/package/@sentry/nitro)
[](https://www.npmjs.com/package/@sentry/nitro)
-## Links
-
-- [Official Nitro SDK Docs](https://docs.sentry.io/platforms/javascript/guides/nitro/)
-- [Example Nitro app](https://github.com/getsentry/sentry-javascript/tree/develop/dev-packages/e2e-tests/test-applications/nitro-3)
-
-## Compatibility
-
-The minimum supported version of Nitro is `3.0.260415-beta`.
-
-## General
-
-This package is a wrapper around `@sentry/node` with added instrumentation for Nitro's features like:
-
-- HTTP handlers and error capturing.
-- [Middleware instrumentation](https://nitro.build/guide/routing#middleware).
-
-
-
-## Manual Setup
-
-### 1. Prerequisites & Installation
-
-1. Install the Sentry Nitro SDK:
-
- ```bash
- # Using npm
- npm install @sentry/nitro
-
- # Using yarn
- yarn add @sentry/nitro
-
- # Using pnpm
- pnpm add @sentry/nitro
- ```
-
-### 2. Build-Time Nitro Config Setup
-
-1. Import `withSentryConfig` from `@sentry/nitro` and call it with your Nitro config.
-
-#### In `nitro.config.ts`
-
-If you are using a dedicated `nitro.config.ts` file, you can import `withSentryConfig` from `@sentry/nitro` and call it with your Nitro config.
-
-```javascript
-import { defineNitroConfig } from 'nitro/config';
-import { withSentryConfig } from '@sentry/nitro';
-
-const config = defineNitroConfig({
- // ...
-});
-
-export default withSentryConfig(config, {
- // Sentry Build Options
-});
-```
-
-#### In `vite.config.ts`
-
-If you are using Nitro as a Vite plugin, you can import `withSentryConfig` from `@sentry/nitro` and call it with your Nitro config.
-
-```ts
-import { defineConfig } from 'vite';
-import { nitro } from 'nitro/vite';
-import { withSentryConfig } from '@sentry/nitro';
-
-export default defineConfig({
- plugins: [nitro()],
- nitro: withSentryConfig(
- {
- // Nitro options
- },
- {
- // Sentry Build Options
- },
- ),
-});
-```
-
-### 3. Sentry Config Setup
-
-Create an `instrument.mjs` file in your project root to initialize the Sentry SDK:
-
-```javascript
-import * as Sentry from '@sentry/nitro';
-
-Sentry.init({
- dsn: '__YOUR_DSN__',
- tracesSampleRate: 1.0,
-});
-```
-
-Then use `--import` in `NODE_OPTIONS` to load the instrumentation before your app code:
-
-```bash
-NODE_OPTIONS='--import ./instrument.mjs' npx nitro dev
-```
-
-This works with any Nitro command (`nitro dev`, `nitro preview`, or a production start script).
-
-## Uploading Source Maps
+The official Sentry SDK for monitoring Nitro applications.
-The `withSentryConfig` function automatically configures source map uploading when the `authToken`, `org`, and `project`
-options are provided:
+## Documentation
-```javascript
-export default withSentryConfig(config, {
- org: 'your-sentry-org',
- project: 'your-sentry-project',
- authToken: process.env.SENTRY_AUTH_TOKEN,
-});
-```
+- [Getting started](https://docs.sentry.io/platforms/javascript/guides/nitro/)
+- [Configuration](https://docs.sentry.io/platforms/javascript/guides/nitro/configuration/)
-## Troubleshoot
+## Support
-If you encounter any issues with error tracking or integrations, refer to the official [Sentry Nitro SDK documentation](https://docs.sentry.io/platforms/javascript/guides/nitro/). If the documentation does not provide the necessary information, consider opening an issue on GitHub.
+- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
+- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)
From 044812df106c7fd024c5e31ddfed3947866c589c Mon Sep 17 00:00:00 2001
From: Nicolas Hrubec
Date: Wed, 23 Sep 2026 12:32:40 +0200
Subject: [PATCH 2/2] docs: Preserve SDK alpha and beta notices
Co-Authored-By: GPT-6
---
packages/nitro/README.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/packages/nitro/README.md b/packages/nitro/README.md
index c25d2c23a3f0..125877a1abfe 100644
--- a/packages/nitro/README.md
+++ b/packages/nitro/README.md
@@ -12,6 +12,8 @@
The official Sentry SDK for monitoring Nitro applications.
+> NOTICE: This package is in beta state and may be subject to breaking changes.
+
## Documentation
- [Getting started](https://docs.sentry.io/platforms/javascript/guides/nitro/)