Skip to content

Commit ef18f4a

Browse files
docs(sdks): restructure content; update page description style
1 parent 16f0cc2 commit ef18f4a

File tree

10 files changed

+19
-30
lines changed

10 files changed

+19
-30
lines changed

develop-docs/sdk/expected-features/index.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2-
title: Expected Features
2+
title: Features
3+
description: The following is a description of features that are commonly expected in Sentry SDKs.
34
sidebar_order: 4
45
---
56

6-
The following is a description of features that are commonly expected in Sentry SDKs. Make sure to also
7-
have read the <Link to="/sdk/miscellaneous/unified-api">unified API design</Link> documentation
8-
which explains the common API design.
7+
<Alert title="Unified API" level="warning">
8+
Make sure to also have read the <Link to="/sdk/miscellaneous/unified-api">unified API</Link> documentation
9+
which explains the common API design.
10+
</Alert>
911

1012
## Background Sending
1113

develop-docs/sdk/index.mdx

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,4 @@ title: SDK Development
33
sidebar_order: 60
44
---
55

6-
The following is a guide for implementing a Sentry SDK.
7-
8-
It covers the protocol for event submission as well as guidelines for how clients should
9-
typically look and behave.
10-
11-
- <Link to="/sdk/overview/">Overview</Link>
12-
- <Link to="/sdk/philosophy/">Philosophy and Design Principles</Link>
13-
- <Link to="/sdk/development-process/">Development Process</Link>
14-
- <Link to="/sdk/expected-features/">Expected Features</Link>
15-
- <Link to="/sdk/telemetry/">Telemetry</Link>
16-
- <Link to="/sdk/data-model/">Data Model</Link>
17-
- <Link to="/sdk/javascript-sdks/">Javascript SDKs</Link>
18-
- <Link to="/sdk/native-sdks/">Native SDKs</Link>
19-
- <Link to="/sdk/serverless-sdks/">Serverless SDKs</Link>
6+
<PageGrid />
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Miscellaneous
3-
sidebar_order: 10
3+
sidebar_order: 100
44
---
55

66
<PageGrid />

develop-docs/sdk/overview.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
title: Overview
3+
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.
34
sidebar_order: 1
45
---
56

6-
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.
7-
87
## Writing an SDK
98

109
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.

develop-docs/sdk/philosophy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: Philosophy
3+
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.
34
sidebar_order: 2
45
---
56

6-
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.
77

88
## Trust is #1
99

develop-docs/sdk/development-process/basics.mdx renamed to develop-docs/sdk/processes/basics.mdx

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
---
22
title: Basics
3-
description: How to get started with SDK development.
3+
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.
44
sidebar_order: 1
55
---
66

7-
So you want to develop an SDK? Before you get started here are some basics that are
8-
worth following to have a better experience.
9-
107
## Run a Local Relay
118

129
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
3532
whichever port you ended up chosing. Also note that a local relay will out of the box
3633
be available via HTTP only so don't try to send HTTPS requests there.
3734

38-
## Join the SDK chat on Discord
35+
## Join us on Discord
3936

40-
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`.
37+
You can reach out to Sentry open source contributors and talk with other SDK maintainers on the [Sentry Discord server](https://discord.gg/sentry).
4138

4239
## Consult Existing SDKs
4340

develop-docs/sdk/development-process/index.mdx renamed to develop-docs/sdk/processes/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Development Process
2+
title: Processes
33
description: In this section, we aim to highlight some key processes that are essential for SDK development at Sentry.
44
sidebar_order: 3
55
---
File renamed without changes.
File renamed without changes.

src/components/docPage/type.scss

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
// dark mode
22
.dark .prose {
33
--heading-color: var(--gray-12);
4+
5+
hgroup h2 {
6+
color: var(--desatPurple12);
7+
}
48
}
59

610
.prose {
@@ -68,7 +72,7 @@
6872
hgroup h2 {
6973
font-weight: 300;
7074
font-size: 1.3rem;
71-
color: var(--foreground-secondary);
75+
color: var(--desatPurple2);
7276
line-height: 2rem;
7377
margin-bottom: 1.75rem;
7478
}

0 commit comments

Comments
 (0)