Skip to content

docs(sdk): Add two principles extracted from overview#16403

Merged
stephanie-anderson merged 1 commit intomasterfrom
docs/add-sdk-principles-from-overview
Feb 17, 2026
Merged

docs(sdk): Add two principles extracted from overview#16403
stephanie-anderson merged 1 commit intomasterfrom
docs/add-sdk-principles-from-overview

Conversation

@stephanie-anderson
Copy link
Contributor

DESCRIBE YOUR PR

Extract two working principles from sdk/overview.mdx into getting-started/principles/:

  • Never capture your own exceptions — from the "SDK Errors" section. SDKs must not capture internal exceptions to avoid busy loops.
  • Integrate at the lowest level — from the "Layer of Integration" section. Hook runtimes/frameworks directly rather than requiring user subclassing.

Also drops "Ten" from the getting-started index description since the principle count is no longer fixed.

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

Co-Authored-By: Claude noreply@anthropic.com

Move "SDK Errors" and "Layer of Integration" from sdk/overview.mdx
into working principles as "Never capture your own exceptions" and
"Integrate at the lowest level". Drop "Ten" from the index description
since the count is no longer fixed.

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel
Copy link

vercel bot commented Feb 17, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment Feb 17, 2026 1:22pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
sentry-docs Ignored Ignored Feb 17, 2026 1:22pm

Request Review

@stephanie-anderson stephanie-anderson merged commit c542e91 into master Feb 17, 2026
15 checks passed
@stephanie-anderson stephanie-anderson deleted the docs/add-sdk-principles-from-overview branch February 17, 2026 14:16
stephanie-anderson added a commit that referenced this pull request Feb 17, 2026
## DESCRIBE YOUR PR

Create the `foundations/` layer of the SDK docs restructure. This
introduces the transport subsection with dedicated pages for each
concern.

**Moved (git history preserved):**
- `data-model/envelopes.mdx` → `foundations/transport/envelopes.mdx`
- `data-model/envelope-items.mdx` →
`foundations/transport/envelope-items.mdx`
- `expected-features/rate-limiting.mdx` →
`foundations/transport/rate-limiting.mdx`
- `overview.mdx` → `foundations/overview.mdx` (stripped to just "Writing
an SDK" + "Usage for End-users")

**New pages (extracted from overview.mdx):**
- `transport/authentication.mdx` — DSN parsing, X-Sentry-Auth, HTTP
headers, User-Agent
- `transport/compression.mdx` — content-encoding, transfer encoding
- `transport/index.mdx` — response handling, server errors
- `foundations/index.mdx` — hub page

**Redirects added** for all moved pages in `src/middleware.ts`.

Stacks on #16403.

## IS YOUR CHANGE URGENT?

- [ ] Urgent deadline (GA date, etc.):
- [ ] Other deadline:
- [x] None: Not urgent, can wait up to 1 week+

## SLA

- Teamwork makes the dream work, so please add a reviewer to your PRs.
- Please give the docs team up to 1 week to review your PR unless you've
added an urgent due date to it.
Thanks in advance for your help!

## PRE-MERGE CHECKLIST

- [ ] Checked Vercel preview for correctness, including links
- [ ] PR was reviewed and approved by any necessary SMEs (subject matter
experts)
- [ ] PR was reviewed and approved by a member of the [Sentry docs
team](https://github.com/orgs/getsentry/teams/docs)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants