Skip to content

Commit e96738f

Browse files
Develop sdks (#11701)
1 parent 5af5d29 commit e96738f

File tree

23 files changed

+46
-38
lines changed

23 files changed

+46
-38
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 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.
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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Platform Specifics
3+
description: Read more about the specifics when it comes to certain SDKs.
4+
sidebar_order: 99
5+
---
6+
7+
<PageGrid />
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)