diff --git a/develop-docs/sdk/expected-features/index.mdx b/develop-docs/sdk/expected-features/index.mdx index b15050d9591629..9b88e052a951e5 100644 --- a/develop-docs/sdk/expected-features/index.mdx +++ b/develop-docs/sdk/expected-features/index.mdx @@ -1,11 +1,13 @@ --- -title: Expected Features +title: Features +description: The following is a description of features that are commonly expected in Sentry SDKs. sidebar_order: 4 --- -The following is a description of features that are commonly expected in Sentry SDKs. Make sure to also -have read the unified API design documentation -which explains the common API design. + + Make sure to also have read the unified API documentation + which explains the common API design. + ## Background Sending diff --git a/develop-docs/sdk/index.mdx b/develop-docs/sdk/index.mdx index ca0e378a5761d2..93b3d77e6e6a24 100644 --- a/develop-docs/sdk/index.mdx +++ b/develop-docs/sdk/index.mdx @@ -3,17 +3,4 @@ title: SDK Development sidebar_order: 60 --- -The following is a guide for implementing a Sentry SDK. - -It covers the protocol for event submission as well as guidelines for how clients should -typically look and behave. - -- Overview -- Philosophy and Design Principles -- Development Process -- Expected Features -- Telemetry -- Data Model -- Javascript SDKs -- Native SDKs -- Serverless SDKs + diff --git a/develop-docs/sdk/miscellaneous/index.mdx b/develop-docs/sdk/miscellaneous/index.mdx index ab3e7d57d45c7d..8cee6e7fdfb6e9 100644 --- a/develop-docs/sdk/miscellaneous/index.mdx +++ b/develop-docs/sdk/miscellaneous/index.mdx @@ -1,6 +1,6 @@ --- title: Miscellaneous -sidebar_order: 10 +sidebar_order: 100 --- diff --git a/develop-docs/sdk/overview.mdx b/develop-docs/sdk/overview.mdx index 6a1f1a8aff52de..e9c015acbf5b90 100644 --- a/develop-docs/sdk/overview.mdx +++ b/develop-docs/sdk/overview.mdx @@ -1,10 +1,9 @@ --- title: Overview +description: The following is a guide for implementing a new Sentry SDK. It covers the protocol for event submission as well as guidelines for how clients should typically look and behave. sidebar_order: 1 --- -The following is a guide for implementing a new Sentry SDK. It covers the protocol for event submission as well as guidelines for how clients should typically look and behave. - ## Writing an SDK At its core an SDK is a set of utilities for capturing data about an exceptional state in an application. Given this data, it then builds and sends a JSON payload to the Sentry server. diff --git a/develop-docs/sdk/philosophy.mdx b/develop-docs/sdk/philosophy.mdx index c5ea0f9c84471c..3f195ffb9ef601 100644 --- a/develop-docs/sdk/philosophy.mdx +++ b/develop-docs/sdk/philosophy.mdx @@ -1,9 +1,9 @@ --- title: Philosophy +description: This document provides general guidance for SDK development at Sentry. It aims to help both internal and external developers understand the motivations behind SDK design decisions and our decision-making process. sidebar_order: 2 --- -This document sets some general guidance for how to approach SDK development at Sentry. It should aid both internal and external developers to understand what motivations go into the design of the SDKs and why we're deciding in certain ways. ## Trust is #1 diff --git a/develop-docs/sdk/platform-specifics/index.mdx b/develop-docs/sdk/platform-specifics/index.mdx new file mode 100644 index 00000000000000..09d30eace879e3 --- /dev/null +++ b/develop-docs/sdk/platform-specifics/index.mdx @@ -0,0 +1,7 @@ +--- +title: Platform Specifics +description: Read more about the specifics when it comes to certain SDKs. +sidebar_order: 99 +--- + + diff --git a/develop-docs/sdk/javascript-sdks/browser-tracing.mdx b/develop-docs/sdk/platform-specifics/javascript-sdks/browser-tracing.mdx similarity index 100% rename from develop-docs/sdk/javascript-sdks/browser-tracing.mdx rename to develop-docs/sdk/platform-specifics/javascript-sdks/browser-tracing.mdx diff --git a/develop-docs/sdk/javascript-sdks/bundle-size.mdx b/develop-docs/sdk/platform-specifics/javascript-sdks/bundle-size.mdx similarity index 100% rename from develop-docs/sdk/javascript-sdks/bundle-size.mdx rename to develop-docs/sdk/platform-specifics/javascript-sdks/bundle-size.mdx diff --git a/develop-docs/sdk/javascript-sdks/debug-ids.mdx b/develop-docs/sdk/platform-specifics/javascript-sdks/debug-ids.mdx similarity index 100% rename from develop-docs/sdk/javascript-sdks/debug-ids.mdx rename to develop-docs/sdk/platform-specifics/javascript-sdks/debug-ids.mdx diff --git a/develop-docs/sdk/javascript-sdks/index.mdx b/develop-docs/sdk/platform-specifics/javascript-sdks/index.mdx similarity index 100% rename from develop-docs/sdk/javascript-sdks/index.mdx rename to develop-docs/sdk/platform-specifics/javascript-sdks/index.mdx diff --git a/develop-docs/sdk/javascript-sdks/page-based-traces.png b/develop-docs/sdk/platform-specifics/javascript-sdks/page-based-traces.png similarity index 100% rename from develop-docs/sdk/javascript-sdks/page-based-traces.png rename to develop-docs/sdk/platform-specifics/javascript-sdks/page-based-traces.png diff --git a/develop-docs/sdk/javascript-sdks/pageload-span.png b/develop-docs/sdk/platform-specifics/javascript-sdks/pageload-span.png similarity index 100% rename from develop-docs/sdk/javascript-sdks/pageload-span.png rename to develop-docs/sdk/platform-specifics/javascript-sdks/pageload-span.png diff --git a/develop-docs/sdk/native-sdks/index.mdx b/develop-docs/sdk/platform-specifics/native-sdks/index.mdx similarity index 100% rename from develop-docs/sdk/native-sdks/index.mdx rename to develop-docs/sdk/platform-specifics/native-sdks/index.mdx diff --git a/develop-docs/sdk/native-sdks/signal-handlers.mdx b/develop-docs/sdk/platform-specifics/native-sdks/signal-handlers.mdx similarity index 100% rename from develop-docs/sdk/native-sdks/signal-handlers.mdx rename to develop-docs/sdk/platform-specifics/native-sdks/signal-handlers.mdx diff --git a/develop-docs/sdk/serverless-sdks/aws-lambda-lifecycle.png b/develop-docs/sdk/platform-specifics/serverless-sdks/aws-lambda-lifecycle.png similarity index 100% rename from develop-docs/sdk/serverless-sdks/aws-lambda-lifecycle.png rename to develop-docs/sdk/platform-specifics/serverless-sdks/aws-lambda-lifecycle.png diff --git a/develop-docs/sdk/serverless-sdks/aws-lambda.mdx b/develop-docs/sdk/platform-specifics/serverless-sdks/aws-lambda.mdx similarity index 97% rename from develop-docs/sdk/serverless-sdks/aws-lambda.mdx rename to develop-docs/sdk/platform-specifics/serverless-sdks/aws-lambda.mdx index 14f63e4609566b..8ddb7a925a6f4b 100644 --- a/develop-docs/sdk/serverless-sdks/aws-lambda.mdx +++ b/develop-docs/sdk/platform-specifics/serverless-sdks/aws-lambda.mdx @@ -6,8 +6,8 @@ sidebar_order: 10 Lambda functions can be written in numerous programming languages (Javascript, Python, Ruby, Java, Go, ...). Sentry is currently supporting automatic instrumentation of Lambda functions written in Javascript and Python. -See the [Sentry Documentation](https://docs.sentry.io/product/integrations/cloud-monitoring/) -on how to set up serverless instrumentation. + +See the [Sentry Documentation](https://docs.sentry.io/product/integrations/cloud-monitoring/) on how to set up serverless instrumentation. ## A short primer into AWS Lambda functions, and layers. diff --git a/develop-docs/sdk/serverless-sdks/index.mdx b/develop-docs/sdk/platform-specifics/serverless-sdks/index.mdx similarity index 69% rename from develop-docs/sdk/serverless-sdks/index.mdx rename to develop-docs/sdk/platform-specifics/serverless-sdks/index.mdx index 1aa43270a09a1e..c47f10abddf72a 100644 --- a/develop-docs/sdk/serverless-sdks/index.mdx +++ b/develop-docs/sdk/platform-specifics/serverless-sdks/index.mdx @@ -4,4 +4,4 @@ description: Information specific to developing serverless SDKs. sidebar_order: 9 --- -- [AWS Lambda](/sdk/serverless-sdks/aws-lambda/) + diff --git a/develop-docs/sdk/development-process/basics.mdx b/develop-docs/sdk/processes/basics.mdx similarity index 81% rename from develop-docs/sdk/development-process/basics.mdx rename to develop-docs/sdk/processes/basics.mdx index 146afc45f4c470..8b2b60f5c17357 100644 --- a/develop-docs/sdk/development-process/basics.mdx +++ b/develop-docs/sdk/processes/basics.mdx @@ -1,12 +1,9 @@ --- title: Basics -description: How to get started with SDK development. +description: So you want to develop an SDK? Before you get started here are some basics that are worth following to have a better experience. sidebar_order: 1 --- -So you want to develop an SDK? Before you get started here are some basics that are -worth following to have a better experience. - ## Run a Local Relay You do not need a local Sentry for SDK development but you will want to run a local @@ -35,9 +32,9 @@ When sending events just substitute `orgXXX.ingest.sentry.io` with `localhost:30 whichever port you ended up chosing. Also note that a local relay will out of the box be available via HTTP only so don't try to send HTTPS requests there. -## Join the SDK chat on Discord +## Join us on Discord -You can reach out to Sentry open source contributors and talk with other SDK maintainers in the [Sentry Discord server](https://discord.gg/sentry). Make sure to say hi in the `#sdk-chat`. +You can reach out to Sentry open source contributors and talk with other SDK maintainers on the [Sentry Discord server](https://discord.gg/sentry). ## Consult Existing SDKs diff --git a/develop-docs/sdk/development-process/index.mdx b/develop-docs/sdk/processes/index.mdx similarity index 85% rename from develop-docs/sdk/development-process/index.mdx rename to develop-docs/sdk/processes/index.mdx index 940c33ea5d71aa..d5ccd6814648b4 100644 --- a/develop-docs/sdk/development-process/index.mdx +++ b/develop-docs/sdk/processes/index.mdx @@ -1,5 +1,5 @@ --- -title: Development Process +title: Processes description: In this section, we aim to highlight some key processes that are essential for SDK development at Sentry. sidebar_order: 3 --- diff --git a/develop-docs/sdk/development-process/releases.mdx b/develop-docs/sdk/processes/releases.mdx similarity index 100% rename from develop-docs/sdk/development-process/releases.mdx rename to develop-docs/sdk/processes/releases.mdx diff --git a/develop-docs/sdk/development-process/triaging.mdx b/develop-docs/sdk/processes/triaging.mdx similarity index 100% rename from develop-docs/sdk/development-process/triaging.mdx rename to develop-docs/sdk/processes/triaging.mdx diff --git a/redirects.js b/redirects.js index 03390a9e478970..3cf638033fa606 100644 --- a/redirects.js +++ b/redirects.js @@ -32,7 +32,7 @@ const developerDocsRedirects = [ }, { source: '/sdk/basics/:path*', - destination: '/sdk/development-process/basics/:path*', + destination: '/sdk/processes/basics/:path*', }, { source: '/sdk/data-handling/:path*', @@ -80,19 +80,31 @@ const developerDocsRedirects = [ }, { source: '/sdk/serverless/:path*', - destination: '/sdk/serverless-sdks/:path*', + destination: '/sdk/platform-specifics/serverless-sdks/:path*', + }, + { + source: '/sdk/serverless-sdks/:path*', + destination: '/sdk/platform-specifics/serverless-sdks/:path*', + }, + { + source: '/sdk/native-sdks/:path*', + destination: '/sdk/platform-specifics/native-sdks/:path*', + }, + { + source: '/sdk/javascript-sdks/:path*', + destination: '/sdk/platform-specifics/javascript-sdks/:path*', }, { source: '/sdk/signal-handlers/:path*', - destination: '/sdk/native-sdks/signal-handlers/:path*', + destination: '/sdk/platform-specifics/native-sdks/signal-handlers/:path*', }, { source: '/sdk/store/:path*', destination: '/sdk/miscellaneous/store/:path*', }, { - source: '/sdk/processes/:path*', - destination: '/sdk/development-process/:path*', + source: '/sdk/development-process/:path*', + destination: '/sdk/processes/:path*', }, { source: '/application/ab-testing/', diff --git a/src/components/docPage/type.scss b/src/components/docPage/type.scss index a6c5931c442cfe..387a0792875936 100644 --- a/src/components/docPage/type.scss +++ b/src/components/docPage/type.scss @@ -1,6 +1,10 @@ // dark mode .dark .prose { --heading-color: var(--gray-12); + + hgroup h2 { + color: var(--desatPurple12); + } } .prose { @@ -68,7 +72,7 @@ hgroup h2 { font-weight: 300; font-size: 1.3rem; - color: var(--foreground-secondary); + color: var(--desatPurple2); line-height: 2rem; margin-bottom: 1.75rem; }