Skip to content

Commit 0c816dc

Browse files
nicohrubeccodex
andauthored
docs: Point tooling READMEs to documentation (#24641)
similar to #24618 but for @sentry/bundler-plugins, @sentry/typescript, @sentry/eslint-config-sdk, and @sentry/eslint-plugin-sdk --------- Co-authored-by: GPT-6 <codex@openai.com>
1 parent 7824c40 commit 0c816dc

4 files changed

Lines changed: 30 additions & 27 deletions

File tree

‎packages/bundler-plugins/README.md‎

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,11 @@ Check out the individual packages for more information and examples:
1515
- [esbuild](https://www.npmjs.com/package/@sentry/esbuild-plugin)
1616
- [Webpack](https://www.npmjs.com/package/@sentry/webpack-plugin)
1717

18-
### Features
18+
## Documentation
1919

20-
The Sentry bundler plugin package contains the following functionality:
20+
- [Uploading source maps](https://docs.sentry.io/platforms/javascript/sourcemaps/uploading/)
2121

22-
- Sourcemap upload
23-
- Release creation in Sentry
24-
- Automatic release name discovery (based on CI environment - Vercel, AWS, Heroku, CircleCI, or current Git SHA)
25-
- Automatically associate errors with releases (Release injection)
22+
## Support
2623

27-
### More information
28-
29-
- [Sentry Documentation](https://docs.sentry.io/quickstart/)
30-
- [Sentry Discord](https://discord.gg/Ww9hbqr)
31-
- [Sentry Stackoverflow](http://stackoverflow.com/questions/tagged/sentry)
24+
- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
25+
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)

‎packages/eslint-config-sdk/README.md‎

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

13+
Shared ESLint configuration used at Sentry.
14+
1315
> [!NOTE]
1416
> This package is an internal library published for use by Sentry-owned JavaScript SDK packages and repositories. It is
1517
> not part of the public API contract and may change in any release. Do not rely on SemVer compatibility if you depend on
1618
> it directly.
1719
18-
## Links
19-
20-
- [Official SDK Docs](https://docs.sentry.io/quickstart/)
21-
22-
## General
23-
24-
Install with `yarn add -D @sentry/eslint-config-sdk`
25-
2620
## Configuration
2721

2822
Use `@sentry` for base rules. Make sure to specify your tsconfig under `parserOptions.project` so that you can
@@ -41,3 +35,8 @@ correctly use the typescript rules. This configuration comes with
4135
]
4236
}
4337
```
38+
39+
## Support
40+
41+
- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
42+
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)

‎packages/eslint-plugin-sdk/README.md‎

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

13+
Custom ESLint rules used at Sentry.
14+
1315
> [!NOTE]
1416
> This package is an internal library published for use by Sentry-owned JavaScript SDK packages and repositories. It is
1517
> not part of the public API contract and may change in any release. Do not rely on SemVer compatibility if you depend on
1618
> it directly.
19+
20+
## Documentation
21+
22+
- [Available rules](https://github.com/getsentry/sentry-javascript/tree/develop/packages/eslint-plugin-sdk/src/rules)
23+
24+
## Support
25+
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)

‎packages/typescript/README.md‎

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

13+
Shared typescript configuration used at Sentry.
14+
1315
> [!NOTE]
1416
> This package is an internal library published for use by Sentry-owned JavaScript SDK packages and repositories. It is
1517
> not part of the public API contract and may change in any release. Do not rely on SemVer compatibility if you depend on
1618
> it directly.
1719
18-
## Links
19-
20-
- [Official SDK Docs](https://docs.sentry.io/quickstart/)
21-
22-
## General
23-
24-
Shared typescript configuration used at Sentry.
25-
2620
## Installation
2721

2822
```sh
@@ -52,3 +46,8 @@ Add the following config files to your project's root directory:
5246

5347
For an example of how to use this package in a monorepo, check out this package's own parent repo,
5448
https://github.com/getsentry/sentry-javascript.
49+
50+
## Support
51+
52+
- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose)
53+
- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)

0 commit comments

Comments
 (0)