Skip to content

Commit ed1d078

Browse files
authored
Merge branch 'master' into buenaflor/docs-flutter-anr-app-hangs
2 parents 70c0680 + 7796c1f commit ed1d078

154 files changed

Lines changed: 2238 additions & 1546 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.claude/skills/technical-docs/SKILL.md

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,12 +130,68 @@ Link to related docs rather than repeating content:
130130
For automatic tracing, see <PlatformLink to="/configuration/apis/">API Reference</PlatformLink>.
131131
```
132132

133-
### Code Block Filenames
133+
### Code Block Meta Flags
134134

135135
Always include filename when showing file-specific code:
136136
```tsx {filename:app/error.tsx}
137137
```
138138

139+
Consecutive fenced code blocks are automatically grouped into tabbed code snippets.
140+
Each tab can have a title and filename:
141+
142+
~~~
143+
```swift {tabTitle:Swift}
144+
SentrySDK.capture(error: error)
145+
```
146+
147+
```objc {tabTitle:Objective-C}
148+
[SentrySDK captureError:error];
149+
```
150+
~~~
151+
152+
#### Markdown Export and `{mdExpandTabs}`
153+
154+
The `.md` export (mainly used by LLMs via the "Copy page" button) **collapses tab groups
155+
by default**: only the first tab is included, with a note listing the other tabs
156+
(e.g. *Other available variations of the above snippet: yarn, pnpm*). This keeps context lean when tabs show
157+
trivial variations an LLM can infer on its own.
158+
159+
Add `{mdExpandTabs}` to the first code fence in a group when the tabs contain code an LLM
160+
**cannot reliably derive** from seeing just one tab. This is rare — most times, adding only
161+
one tab to the produced `.md` is enough.
162+
163+
~~~
164+
```swift {tabTitle:Swift} {mdExpandTabs}
165+
SentrySDK.start { options in
166+
options.dsn = "..."
167+
}
168+
```
169+
170+
```objc {tabTitle:Objective-C}
171+
[SentrySDK startWithConfigureOptions:^(SentryOptions *options) {
172+
options.dsn = @"...";
173+
}];
174+
```
175+
~~~
176+
177+
**Expand** — the code is too different for an LLM to infer:
178+
- Different languages: Swift / Objective-C, cross-language guides (JS/Python/PHP/Ruby/...)
179+
- Different setup flows: Hono guide init (Cloudflare vs Node.js `--import` vs Bun)
180+
- Different APIs or wrappers: GCP Cloud Functions (`wrapHttpFunction` vs `wrapCloudEventFunction`), serverless async/sync handlers
181+
- Different framework versions with distinct imports: Spring 5/6/7, Spring Boot 2/3/4, Svelte v5+ / v3
182+
- Client / Server splits: Next.js, Remix, React Router (Replay + browser tracing vs Node integrations)
183+
- Different platform tooling: KMP (`commonMain` / `iosApp` / `androidApp`), Flutter navigation (Navigator / GoRouter / AutoRoute)
184+
- Install methods with different patterns: npm (`import`) vs CDN (`<script>`) vs Loader (`sentryOnLoad`)
185+
- SDK version migration: SDK 2.x vs 1.x when APIs differ
186+
187+
**Collapse** (default) — an LLM can figure it out from one tab:
188+
- Package managers: npm / yarn / pnpm, pip / uv, .NET CLI / NuGet
189+
- Module format: ESM / CommonJS (same API, different import syntax)
190+
- Config file formats: JSON / TOML, properties / yml
191+
- Java / Kotlin on the same platform (same APIs, syntactic sugar differences)
192+
- Runtime tabs where only the import path changes (e.g. `@sentry/hono/cloudflare` vs `@sentry/hono/node` in `platform-includes/` snippets)
193+
- Build tools when only dependency declaration syntax differs: Gradle / Maven / SBT
194+
139195
## Review Checklist
140196

141197
When reviewing documentation:

.github/CODEOWNERS

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@
3636

3737
# ###### Replays #######
3838

39-
# /docs/product/explore/session-replay/web @jas-kas @getsentry/replay-sdk-web @getsentry/replay-frontend @getsentry/replay-backend
40-
# /docs/product/explore/session-replay/mobile @jas-kas @getsentry/replay-sdk-mobile @getsentry/replay-frontend @getsentry/replay-sdk-mobile
39+
# /docs/product/explore/session-replay/web @getsentry/replay-sdk-web @getsentry/replay-frontend @getsentry/replay-backend
40+
# /docs/product/explore/session-replay/mobile @getsentry/replay-sdk-mobile @getsentry/replay-frontend @getsentry/replay-sdk-mobile
4141
# /includes/session-replay-web-report-bug.mdx @getsentry/replay-sdk-web
4242
# /platform-includes/session-replay/ @getsentry/replay-sdk-web @getsentry/replay-sdk-mobile
4343
# /docs/platforms/javascript/common/session-replay/ @getsentry/replay-sdk-web
4444

45-
# /docs/product/sentry-toolbar/ @ryan953 @jas-kas
45+
# /docs/product/sentry-toolbar/ @ryan953
4646

4747
# ###### End Replays #######

.github/workflows/algolia-index.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
dev-docs:
3030
- 'develop-docs/**'
3131
32-
- uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
32+
- uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
3333
with:
3434
path: |
3535
${{ github.workspace }}/.next/cache

.github/workflows/codeql-analysis.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jobs:
3737

3838
# Initializes the CodeQL tools for scanning.
3939
- name: Initialize CodeQL
40-
uses: github/codeql-action/init@ebcb5b36ded6beda4ceefea6a8bc4cc885255bb3 # v3
40+
uses: github/codeql-action/init@7211b7c8077ea37d8641b6271f6a365a22a5fbfa # v3
4141
with:
4242
languages: ${{ matrix.language }}
4343
# If you wish to specify custom queries, you can do so here or in a config file.
@@ -51,7 +51,7 @@ jobs:
5151
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
5252
# If this step fails, then you should remove it and run the build manually (see below)
5353
- name: Autobuild
54-
uses: github/codeql-action/autobuild@ebcb5b36ded6beda4ceefea6a8bc4cc885255bb3 # v3
54+
uses: github/codeql-action/autobuild@7211b7c8077ea37d8641b6271f6a365a22a5fbfa # v3
5555

5656
# ℹ️ Command-line programs to run using the OS shell.
5757
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -64,6 +64,6 @@ jobs:
6464
# ./location_of_script_within_repo/buildscript.sh
6565

6666
- name: Perform CodeQL Analysis
67-
uses: github/codeql-action/analyze@ebcb5b36ded6beda4ceefea6a8bc4cc885255bb3 # v3
67+
uses: github/codeql-action/analyze@7211b7c8077ea37d8641b6271f6a365a22a5fbfa # v3
6868
with:
6969
category: "/language:${{matrix.language}}"

.github/workflows/lint-404s.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jobs:
3535
- 'scripts/lint-404s/**'
3636
dev-docs:
3737
- 'develop-docs/**'
38-
- uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
38+
- uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
3939
with:
4040
path: |
4141
${{ github.workspace }}/.next/cache

.github/workflows/lint-external-links.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ jobs:
4444
4545
- name: Restore lychee cache
4646
if: steps.changed.outputs.files != ''
47-
uses: actions/cache/restore@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
47+
uses: actions/cache/restore@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
4848
with:
4949
path: .lycheecache
5050
key: lychee-cache-
@@ -76,7 +76,7 @@ jobs:
7676
# - Transient errors (429, 5xx) are excluded from cache and retried
7777
# - Save updated cache for next run
7878
- name: Restore lychee cache
79-
uses: actions/cache/restore@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
79+
uses: actions/cache/restore@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
8080
with:
8181
path: .lycheecache
8282
key: lychee-cache-
@@ -95,7 +95,7 @@ jobs:
9595
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
9696

9797
- name: Save lychee cache
98-
uses: actions/cache/save@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
98+
uses: actions/cache/save@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
9999
if: always()
100100
with:
101101
path: .lycheecache

.github/workflows/screenshot-pipeline.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jobs:
3636

3737
steps:
3838
- name: Checkout repository
39-
uses: actions/checkout@v4
39+
uses: actions/checkout@v6
4040
with:
4141
fetch-depth: 0 # Full history for git log queries
4242

@@ -116,7 +116,7 @@ jobs:
116116
SENTRY_BASE_URL: ${{ secrets.SENTRY_BASE_URL }}
117117

118118
- name: Upload pipeline artifacts
119-
uses: actions/upload-artifact@v4
119+
uses: actions/upload-artifact@v7
120120
if: always()
121121
with:
122122
name: screenshot-pipeline-output

.github/workflows/test.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
node-version-file: 'package.json'
3434
cache: 'pnpm'
3535

36-
- uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
36+
- uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
3737
with:
3838
path: |
3939
${{ github.workspace }}/.next/cache
@@ -77,7 +77,7 @@ jobs:
7777
steps:
7878
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6
7979
- name: Check spelling with typos
80-
uses: crate-ci/typos@5c19779cb52ea50e151f5a10333ccd269227b5ae # v1.41.0
80+
uses: crate-ci/typos@7b04f660f4ee4f048d18fd341887cf28dfbedfe2 # v1.46.3
8181

8282
job_test:
8383
name: Test
@@ -93,7 +93,7 @@ jobs:
9393
node-version-file: 'package.json'
9494
cache: 'pnpm'
9595

96-
- uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4
96+
- uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
9797
with:
9898
path: |
9999
${{ github.workspace }}/.next/cache

.github/workflows/update-docs-changelog.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515

1616
steps:
1717
- name: Checkout repository
18-
uses: actions/checkout@v4
18+
uses: actions/checkout@v6
1919

2020
- name: Get auth token
2121
id: token

.lycheeignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ https?://.*\.intercomhelpcenter\.com.*
4141
https?://godoc\.org.*
4242
https?://pkg\.go\.dev.*
4343

44+
# Docker Hub tag-search endpoint is slow and intermittently returns 504 gateway timeouts
45+
https?://hub\.docker\.com.*
46+
4447
# Interactive demos that may not respond to HEAD requests
4548
https?://demo\.arcade\.software.*
4649

0 commit comments

Comments
 (0)