Skip to content

Commit 2d6076b

Browse files
nicohrubeccodex
nicohrubec
and
codex
authored
docs: Point framework SDK READMEs to documentation (#24631)
similar to #24618 but for @sentry/nextjs, @sentry/nuxt, @sentry/sveltekit, and @sentry/tanstackstart-react --------- Co-authored-by: GPT-6 <codex@openai.com>
1 parent 886f02a commit 2d6076b

4 files changed

Lines changed: 31 additions & 121 deletions

File tree

‎packages/nextjs/README.md‎

Lines changed: 7 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -10,50 +10,14 @@
1010
[![npm dm](https://img.shields.io/npm/dm/@sentry/nextjs.svg)](https://www.npmjs.com/package/@sentry/nextjs)
1111
[![npm dt](https://img.shields.io/npm/dt/@sentry/nextjs.svg)](https://www.npmjs.com/package/@sentry/nextjs)
1212

13-
> See the [Official Sentry Next.js SDK Docs](https://docs.sentry.io/platforms/javascript/guides/nextjs/) to get started.
13+
The official Sentry SDK for monitoring Next.js applications.
1414

15-
## Compatibility
15+
## Documentation
1616

17-
Currently, the minimum supported version of Next.js is `14.0.0`.
17+
- [Getting started](https://docs.sentry.io/platforms/javascript/guides/nextjs/)
18+
- [Configuration](https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/)
1819

19-
## Installation
20+
## Support
2021

21-
To get started installing the SDK, use the Sentry Next.js Wizard by running the following command in your terminal or
22-
read the [Getting Started Docs](https://docs.sentry.io/platforms/javascript/guides/nextjs/):
23-
24-
```sh
25-
npx @sentry/wizard@latest -i nextjs
26-
```
27-
28-
The wizard will prompt you to log in to Sentry. After the wizard setup is completed, the SDK will automatically capture
29-
unhandled errors, and monitor performance.
30-
31-
## Custom Usage
32-
33-
To set context information or to send manual events, you can use `@sentry/nextjs` as follows:
34-
35-
```ts
36-
import * as Sentry from '@sentry/nextjs';
37-
38-
// Set user information, as well as tags and further extras
39-
Sentry.setTag('user_mode', 'admin');
40-
Sentry.setUser({ id: '4711' });
41-
Sentry.setContext('application_area', { location: 'checkout' });
42-
43-
// Add a breadcrumb for future events
44-
Sentry.addBreadcrumb({
45-
message: '"Add to cart" clicked',
46-
// ...
47-
});
48-
49-
// Capture exceptions or messages
50-
Sentry.captureException(new Error('Oh no.'));
51-
Sentry.captureMessage('Hello, world!');
52-
```
53-
54-
## Links
55-
56-
- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/nextjs/)
57-
- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_nextjs)
58-
- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
59-
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
22+
- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
23+
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)

‎packages/nuxt/README.md‎

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,15 @@
1010
[![npm dm](https://img.shields.io/npm/dm/@sentry/nuxt.svg)](https://www.npmjs.com/package/@sentry/nuxt)
1111
[![npm dt](https://img.shields.io/npm/dt/@sentry/nuxt.svg)](https://www.npmjs.com/package/@sentry/nuxt)
1212

13-
This SDK is for [Nuxt](https://nuxt.com/). If you're using [Vue](https://vuejs.org/) see our
14-
[Vue SDK here](https://github.com/getsentry/sentry-javascript/tree/develop/packages/vue).
13+
The official Sentry SDK for monitoring Nuxt applications.
1514

16-
## Setup Instructions and Documentation
15+
## Documentation
1716

18-
Check out the [Official Nuxt SDK Docs](https://docs.sentry.io/platforms/javascript/guides/nuxt/) for further information on configuration and usage.
17+
- [Getting started](https://docs.sentry.io/platforms/javascript/guides/nuxt/)
18+
- [Configuration](https://docs.sentry.io/platforms/javascript/guides/nuxt/configuration/)
19+
- [Nuxt-specific features](https://docs.sentry.io/platforms/javascript/guides/nuxt/features/)
1920

20-
## Compatibility
21+
## Support
2122

22-
The minimum supported version of Nuxt is `3.7.0` (`3.14.0+` recommended).
23-
24-
## General
25-
26-
This package is a wrapper around `@sentry/node` for the server and `@sentry/vue` for the client side, with added
27-
functionality related to Nuxt.
28-
29-
## Troubleshoot
30-
31-
If your server-side auto-instrumentation stops recording spans after bundling (e.g. certain Nitro
32-
presets), make sure `@sentry/server-runtime-injection` is kept **external** in the Nitro/server build rather than
33-
inlined, as its runtime module hook must resolve from `node_modules`. `@sentry/node` logs a warning
34-
the first time an instrumented dependency loads uninstrumented.
35-
36-
If you encounter any issues with error tracking or integrations, refer to the official [Sentry Nuxt SDK documentation](https://docs.sentry.io/platforms/javascript/guides/nuxt/). If the documentation does not provide the necessary information, consider opening an issue on GitHub.
23+
- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
24+
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)

‎packages/sveltekit/README.md‎

Lines changed: 7 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -10,33 +10,14 @@
1010
[![npm dm](https://img.shields.io/npm/dm/@sentry/sveltekit.svg)](https://www.npmjs.com/package/@sentry/sveltekit)
1111
[![npm dt](https://img.shields.io/npm/dt/@sentry/sveltekit.svg)](https://www.npmjs.com/package/@sentry/sveltekit)
1212

13-
## Compatibility
13+
The official Sentry SDK for monitoring SvelteKit applications.
1414

15-
The minimum supported version of SvelteKit is `2.0.0`. The SDK works best with Vite 4.2 and newer. Older Vite versions
16-
might not generate source maps correctly.
15+
## Documentation
1716

18-
Check our docs for [SvelteKit adapter](https://docs.sentry.io/platforms/javascript/guides/sveltekit/#prerequisites) compatibility.
17+
- [Getting started](https://docs.sentry.io/platforms/javascript/guides/sveltekit/)
18+
- [Configuration](https://docs.sentry.io/platforms/javascript/guides/sveltekit/configuration/)
1919

20-
## General
20+
## Support
2121

22-
This package is a wrapper around `@sentry/node` for the server and `@sentry/svelte` for the client side, with added
23-
functionality related to SvelteKit.
24-
25-
## Installation
26-
27-
To get started installing the SDK, use the Sentry Next.js Wizard by running the following command in your terminal or
28-
read the [Getting Started Docs](https://docs.sentry.io/platforms/javascript/guides/sveltekit/):
29-
30-
```sh
31-
npx @sentry/wizard@latest -i sveltekit
32-
```
33-
34-
The wizard will guide you throuhg logging in to Sentry and setting up the SDK. After the wizard setup is completed, the SDK will automatically capture
35-
unhandled errors, and optionally, traces and replays.
36-
37-
## Links
38-
39-
- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/sveltekit/)
40-
- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_sveltekit)
41-
- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
42-
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
22+
- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
23+
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)

‎packages/tanstackstart-react/README.md‎

Lines changed: 9 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -10,41 +10,18 @@
1010
[![npm dm](https://img.shields.io/npm/dm/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
1111
[![npm dt](https://img.shields.io/npm/dt/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
1212

13+
The official Sentry SDK for monitoring TanStack Start React applications.
14+
1315
> This SDK is currently in **BETA**. Beta features are still in progress and may have bugs. Please reach out on
1416
> [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns.
1517
16-
> See the [Official Sentry TanStack Start SDK Docs](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/) to get started.
17-
18-
## Compatibility
19-
20-
The minimum supported version of TanStack Start is `1.111.12`.
21-
22-
## Custom Usage
23-
24-
To set context information or to send manual events, you can use `@sentry/tanstackstart-react` as follows:
25-
26-
```ts
27-
import * as Sentry from '@sentry/tanstackstart-react';
28-
29-
// Set user information, as well as tags and further extras
30-
Sentry.setTag('user_mode', 'admin');
31-
Sentry.setUser({ id: '4711' });
32-
Sentry.setContext('application_area', { location: 'checkout' });
33-
34-
// Add a breadcrumb for future events
35-
Sentry.addBreadcrumb({
36-
message: '"Add to cart" clicked',
37-
// ...
38-
});
18+
## Documentation
3919

40-
// Capture exceptions or messages
41-
Sentry.captureException(new Error('Oh no.'));
42-
Sentry.captureMessage('Hello, world!');
43-
```
20+
- [Getting started](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/)
21+
- [Configuration](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/configuration/)
22+
- [TanStack Start React-specific features](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/features/)
4423

45-
## Links
24+
## Support
4625

47-
- [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/)
48-
- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_tanstackstartreact)
49-
- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
50-
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
26+
- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
27+
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)

0 commit comments

Comments
 (0)