diff --git a/packages/bundler-plugins/README.md b/packages/bundler-plugins/README.md index 9d316ee7e99a..e9387aab6f40 100644 --- a/packages/bundler-plugins/README.md +++ b/packages/bundler-plugins/README.md @@ -15,17 +15,11 @@ Check out the individual packages for more information and examples: - [esbuild](https://www.npmjs.com/package/@sentry/esbuild-plugin) - [Webpack](https://www.npmjs.com/package/@sentry/webpack-plugin) -### Features +## Documentation -The Sentry bundler plugin package contains the following functionality: +- [Uploading source maps](https://docs.sentry.io/platforms/javascript/sourcemaps/uploading/) -- Sourcemap upload -- Release creation in Sentry -- Automatic release name discovery (based on CI environment - Vercel, AWS, Heroku, CircleCI, or current Git SHA) -- Automatically associate errors with releases (Release injection) +## Support -### More information - -- [Sentry Documentation](https://docs.sentry.io/quickstart/) -- [Sentry Discord](https://discord.gg/Ww9hbqr) -- [Sentry Stackoverflow](http://stackoverflow.com/questions/tagged/sentry) +- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose) +- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md) diff --git a/packages/eslint-config-sdk/README.md b/packages/eslint-config-sdk/README.md index 0369a1ef1146..0d9abb45b577 100644 --- a/packages/eslint-config-sdk/README.md +++ b/packages/eslint-config-sdk/README.md @@ -10,19 +10,13 @@ [![npm dm](https://img.shields.io/npm/dm/@sentry/eslint-config-sdk.svg)](https://www.npmjs.com/package/@sentry/eslint-config-sdk) [![npm dt](https://img.shields.io/npm/dt/@sentry/eslint-config-sdk.svg)](https://www.npmjs.com/package/@sentry/eslint-config-sdk) +Shared ESLint configuration used at Sentry. + > [!NOTE] > This package is an internal library published for use by Sentry-owned JavaScript SDK packages and repositories. It is > not part of the public API contract and may change in any release. Do not rely on SemVer compatibility if you depend on > it directly. -## Links - -- [Official SDK Docs](https://docs.sentry.io/quickstart/) - -## General - -Install with `yarn add -D @sentry/eslint-config-sdk` - ## Configuration 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 ] } ``` + +## Support + +- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose) +- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md) diff --git a/packages/eslint-plugin-sdk/README.md b/packages/eslint-plugin-sdk/README.md index 1bbf65d64921..745d88bad7f1 100644 --- a/packages/eslint-plugin-sdk/README.md +++ b/packages/eslint-plugin-sdk/README.md @@ -10,7 +10,18 @@ [![npm dm](https://img.shields.io/npm/dm/@sentry/eslint-plugin-sdk.svg)](https://www.npmjs.com/package/@sentry/eslint-plugin-sdk) [![npm dt](https://img.shields.io/npm/dt/@sentry/eslint-plugin-sdk.svg)](https://www.npmjs.com/package/@sentry/eslint-plugin-sdk) +Custom ESLint rules used at Sentry. + > [!NOTE] > This package is an internal library published for use by Sentry-owned JavaScript SDK packages and repositories. It is > not part of the public API contract and may change in any release. Do not rely on SemVer compatibility if you depend on > it directly. + +## Documentation + +- [Available rules](https://github.com/getsentry/sentry-javascript/tree/develop/packages/eslint-plugin-sdk/src/rules) + +## Support + +- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose) +- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md) diff --git a/packages/typescript/README.md b/packages/typescript/README.md index 746cf132c841..860302047ad1 100644 --- a/packages/typescript/README.md +++ b/packages/typescript/README.md @@ -10,19 +10,13 @@ [![npm dm](https://img.shields.io/npm/dm/@sentry/typescript.svg)](https://www.npmjs.com/package/@sentry/typescript) [![npm dt](https://img.shields.io/npm/dt/@sentry/typescript.svg)](https://www.npmjs.com/package/@sentry/typescript) +Shared typescript configuration used at Sentry. + > [!NOTE] > This package is an internal library published for use by Sentry-owned JavaScript SDK packages and repositories. It is > not part of the public API contract and may change in any release. Do not rely on SemVer compatibility if you depend on > it directly. -## Links - -- [Official SDK Docs](https://docs.sentry.io/quickstart/) - -## General - -Shared typescript configuration used at Sentry. - ## Installation ```sh @@ -52,3 +46,8 @@ Add the following config files to your project's root directory: For an example of how to use this package in a monorepo, check out this package's own parent repo, https://github.com/getsentry/sentry-javascript. + +## Support + +- [Report a bug](https://github.com/getsentry/sentry-javascript/issues/new/choose) +- [Contributing](https://github.com/getsentry/sentry-javascript/blob/develop/CONTRIBUTING.md)