diff --git a/packages/browser-utils/README.md b/packages/browser-utils/README.md index 58b19de5d5a6..0e8f9a34a390 100644 --- a/packages/browser-utils/README.md +++ b/packages/browser-utils/README.md @@ -10,14 +10,17 @@ [![npm dm](https://img.shields.io/npm/dm/@sentry/browser-utils.svg)](https://www.npmjs.com/package/@sentry/browser-utils) [![npm dt](https://img.shields.io/npm/dt/@sentry/browser-utils.svg)](https://www.npmjs.com/package/@sentry/browser-utils) +Shared browser utilities used by Sentry’s JavaScript SDKs. + > [!NOTE] > This package is an internal library published for use by Sentry-owned JavaScript SDK packages. 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 +## Documentation -- [Official SDK Docs](https://docs.sentry.io/quickstart/) +- [JavaScript SDK documentation](https://docs.sentry.io/platforms/javascript/) -## General +## Support -Common utilities used by the Sentry JavaScript SDKs. +- [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/core/README.md b/packages/core/README.md index c4c26b591b3e..8077bea4e165 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -10,13 +10,16 @@ [![npm dm](https://img.shields.io/npm/dm/@sentry/core.svg)](https://www.npmjs.com/package/@sentry/core) [![npm dt](https://img.shields.io/npm/dt/@sentry/core.svg)](https://www.npmjs.com/package/@sentry/core) -## Links +Shared foundations and utilities for Sentry’s JavaScript SDKs. -- [Official SDK Docs](https://docs.sentry.io/quickstart/) +> [!NOTE] +> Please consider all classes and exported functions and interfaces `internal`. -## General +## Documentation -This package contains interface definitions, base classes and utilities for building Sentry JavaScript SDKs, like -`@sentry/node` or `@sentry/browser`. +- [JavaScript SDK documentation](https://docs.sentry.io/platforms/javascript/) -Please consider all classes and exported functions and interfaces `internal`. +## 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/integration-shims/README.md b/packages/integration-shims/README.md index e315b1f61051..55cfd6b6a73c 100644 --- a/packages/integration-shims/README.md +++ b/packages/integration-shims/README.md @@ -6,5 +6,17 @@ # Sentry Integration Shims -This internal package exports shims for Integrations, which are used in order to guarantee a consistent CDN bundle -output. +Internal shims that provide consistent APIs across Sentry’s CDN bundles. + +> [!NOTE] +> This is a private package used internally by Sentry’s JavaScript SDKs. It is not part of the public API contract +> and may change at any time. + +## Documentation + +- [JavaScript SDK documentation](https://docs.sentry.io/platforms/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) diff --git a/packages/replay-worker/README.md b/packages/replay-worker/README.md index 9afc37e85b95..b201205667bc 100644 --- a/packages/replay-worker/README.md +++ b/packages/replay-worker/README.md @@ -6,14 +6,26 @@ # Sentry Session Replay Worker -This is an internal package that is used by @sentry/replay. It generates a web worker and converts it to a -string, so that we can process it easier in replay. +Compression worker for Sentry Session Replay. By extracting this into a dedicated (private, internal) package, we can streamline the build of replay. +> [!NOTE] +> This is a private package used internally by Sentry’s JavaScript SDKs. It is not part of the public API contract +> and may change at any time. + ## Example Worker You can find an example worker for if you want to self-host the compression worker in [/examples](./examples/). This is generated from the actual source via `yarn build:examples`, which should be run manually whenever replay-worker is updated. + +## Documentation + +- [Session Replay documentation](https://docs.sentry.io/platforms/javascript/session-replay/) + +## 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/server-runtime-injection/README.md b/packages/server-runtime-injection/README.md index e7c09f0935f0..6ad8c1d61ac5 100644 --- a/packages/server-runtime-injection/README.md +++ b/packages/server-runtime-injection/README.md @@ -8,15 +8,23 @@ [![npm version](https://img.shields.io/npm/v/@sentry/server-runtime-injection.svg)](https://www.npmjs.com/package/@sentry/server-runtime-injection) -This is an internal package for the Sentry JavaScript SDKs. It is not part of the public API contract -and may change at any time. +Runtime instrumentation for Sentry’s JavaScript server SDKs. -It contains the **runtime** diagnostics-channel injection used by the server SDKs — the module hooks -that transform instrumented dependencies as they load at runtime (`register`, `hook`, `import-hook`), -together with the vendored code transformer they rely on. +> [!NOTE] +> This package is an internal library published for use by Sentry-owned JavaScript SDK packages. 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. > **Important:** this package must be kept **external** (not bundled) when bundling a server. Its > runtime hook loads a transformer that self-references its own on-disk `node_modules` location; > bundling it strips the transformer and breaks that self-reference. When you bundle your server, > either keep `@sentry/server-runtime-injection` external, or rely on the build-time instrumentation > from the Sentry bundler plugins instead. + +## Documentation + +- [JavaScript SDK documentation](https://docs.sentry.io/platforms/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) diff --git a/packages/server-utils/README.md b/packages/server-utils/README.md index 6cad314e2c62..913702972808 100644 --- a/packages/server-utils/README.md +++ b/packages/server-utils/README.md @@ -10,15 +10,17 @@ [![npm dm](https://img.shields.io/npm/dm/@sentry/server-utils.svg)](https://www.npmjs.com/package/@sentry/server-utils) [![npm dt](https://img.shields.io/npm/dt/@sentry/server-utils.svg)](https://www.npmjs.com/package/@sentry/server-utils) +Shared server-side utilities used by Sentry’s JavaScript SDKs. + > [!NOTE] > This package is an internal library published for use by Sentry-owned JavaScript SDK packages. 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 +## Documentation -- [Official SDK Docs](https://docs.sentry.io/quickstart/) +- [JavaScript SDK documentation](https://docs.sentry.io/platforms/javascript/) -## General +## Support -Common server-only utilities used by the Sentry JavaScript server SDKs (node, bun, deno, cloudflare, -aws-serverless, google-cloud-serverless, vercel-edge). +- [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/vercel-edge/README.md b/packages/vercel-edge/README.md index 56a6ca051887..1929209d02d5 100644 --- a/packages/vercel-edge/README.md +++ b/packages/vercel-edge/README.md @@ -6,16 +6,21 @@ # Internal Sentry Utilities for Vercel Edge Runtime +[![npm version](https://img.shields.io/npm/v/@sentry/vercel-edge.svg)](https://www.npmjs.com/package/@sentry/vercel-edge) +[![npm dm](https://img.shields.io/npm/dm/@sentry/vercel-edge.svg)](https://www.npmjs.com/package/@sentry/vercel-edge) +[![npm dt](https://img.shields.io/npm/dt/@sentry/vercel-edge.svg)](https://www.npmjs.com/package/@sentry/vercel-edge) + +Internal Sentry SDK for the Vercel Edge Runtime. + > **NOTICE:** It is discouraged to depend on this package directly. `@sentry/vercel-edge` is used as building block for > higher level Sentry SDKs like `@sentry/nextjs`. The API of this `@sentry/vercel-edge` may break with any major and > non-major version! -[![npm version](https://img.shields.io/npm/v/@sentry/vercel-edge.svg)](https://www.npmjs.com/package/@sentry/vercel-edge) -[![npm dm](https://img.shields.io/npm/dm/@sentry/vercel-edge.svg)](https://www.npmjs.com/package/@sentry/vercel-edge) -[![npm dt](https://img.shields.io/npm/dt/@sentry/vercel-edge.svg)](https://www.npmjs.com/package/@sentry/vercel-edge) +## Documentation + +- [Next.js SDK documentation](https://docs.sentry.io/platforms/javascript/guides/nextjs/) -## Links +## Support -- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_vercel_edge) -- [Sentry Discord Server](https://discord.gg/Ww9hbqr) -- [Stack Overflow](https://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)