Skip to content

Commit

Permalink
docs(sdks): restructure content; update page description style
Browse files Browse the repository at this point in the history
  • Loading branch information
stephanie-anderson committed Oct 31, 2024
1 parent 16f0cc2 commit ef18f4a
Show file tree
Hide file tree
Showing 10 changed files with 19 additions and 30 deletions.
10 changes: 6 additions & 4 deletions develop-docs/sdk/expected-features/index.mdx
Original file line number Diff line number Diff line change
@@ -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 <Link to="/sdk/miscellaneous/unified-api">unified API design</Link> documentation
which explains the common API design.
<Alert title="Unified API" level="warning">
Make sure to also have read the <Link to="/sdk/miscellaneous/unified-api">unified API</Link> documentation
which explains the common API design.
</Alert>

## Background Sending

Expand Down
15 changes: 1 addition & 14 deletions develop-docs/sdk/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

- <Link to="/sdk/overview/">Overview</Link>
- <Link to="/sdk/philosophy/">Philosophy and Design Principles</Link>
- <Link to="/sdk/development-process/">Development Process</Link>
- <Link to="/sdk/expected-features/">Expected Features</Link>
- <Link to="/sdk/telemetry/">Telemetry</Link>
- <Link to="/sdk/data-model/">Data Model</Link>
- <Link to="/sdk/javascript-sdks/">Javascript SDKs</Link>
- <Link to="/sdk/native-sdks/">Native SDKs</Link>
- <Link to="/sdk/serverless-sdks/">Serverless SDKs</Link>
<PageGrid />
2 changes: 1 addition & 1 deletion develop-docs/sdk/miscellaneous/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Miscellaneous
sidebar_order: 10
sidebar_order: 100
---

<PageGrid />
3 changes: 1 addition & 2 deletions develop-docs/sdk/overview.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion develop-docs/sdk/philosophy.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Philosophy
description: 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.
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

Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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
---
Expand Down
File renamed without changes.
File renamed without changes.
6 changes: 5 additions & 1 deletion src/components/docPage/type.scss
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
// dark mode
.dark .prose {
--heading-color: var(--gray-12);

hgroup h2 {
color: var(--desatPurple12);
}
}

.prose {
Expand Down Expand Up @@ -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;
}
Expand Down

0 comments on commit ef18f4a

Please sign in to comment.