Skip to content

Conversation

@codyde
Copy link
Contributor

@codyde codyde commented Nov 19, 2025

Standardizes Python SDK documentation navigation to match JavaScript structure:

Sidebar Sections

  • Added 'Features' section with organized feature pages
  • Added 'Configuration' section (renamed to 'Extended Configuration')
  • Both sections now have proper headers and grouping

Features Section (sidebar_section: features)
Order: Capturing Errors → Logs → Tracing → Metrics → Profiling → Crons → User Feedback

  • Renamed 'Usage' to 'Capturing Errors' (matching JS)
  • Added 'new' tag to Logs
  • Added 'beta' tag to Metrics
  • Reordered all features for consistency

Configuration Section (sidebar_section: configuration) Order: Sampling → Enriching Events → Extended Configuration → Integrations → Data Management → Security Policy Reporting → Migration → Troubleshooting

  • Moved sampling.mdx from configuration/ to root (matching JS)
  • Renamed Configuration index to 'Extended Configuration'

Follows the pattern established in #15440

CleanShot 2025-11-18 at 10  48 58@2x

Standardizes Python SDK documentation navigation to match JavaScript structure:

**Sidebar Sections**
- Added 'Features' section with organized feature pages
- Added 'Configuration' section (renamed to 'Extended Configuration')
- Both sections now have proper headers and grouping

**Features Section** (sidebar_section: features)
Order: Capturing Errors → Logs → Tracing → Metrics → Profiling → Crons → User Feedback
- Renamed 'Usage' to 'Capturing Errors' (matching JS)
- Added 'new' tag to Logs
- Added 'beta' tag to Metrics
- Reordered all features for consistency

**Configuration Section** (sidebar_section: configuration)
Order: Sampling → Enriching Events → Extended Configuration → Integrations → Data Management → Security Policy Reporting → Migration → Troubleshooting
- Moved sampling.mdx from configuration/ to root (matching JS)
- Renamed Configuration index to 'Extended Configuration'
- Applied sidebar_section to all configuration files
- Applied sidebar_section to all related pages

**File Changes**
- 20 Python documentation files modified
- 1 file moved (sampling.mdx)
- 1 redirect added in redirects.js

Follows the pattern established in feat/js-docs-apis-sampling-restructure branch.
@vercel
Copy link

vercel bot commented Nov 19, 2025

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

Project Deployment Preview Comments Updated (UTC)
sentry-docs Ready Ready Preview Comment Nov 20, 2025 0:16am
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
develop-docs Ignored Ignored Preview Nov 20, 2025 0:16am

@codyde codyde marked this pull request as ready for review November 19, 2025 06:49
@codyde codyde requested review from a team and coolguyzone November 19, 2025 06:50
@codecov
Copy link

codecov bot commented Nov 19, 2025

Bundle Report

Changes will increase total bundle size by 4.83kB (0.02%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 12.82MB 4.83kB (0.04%) ⬆️
sentry-docs-client-array-push 10.17MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.74MB -0.0%
../instrumentation.js -3 bytes 1.07MB -0.0%
9523.js -3 bytes 1.04MB -0.0%
../app/[[...path]]/page.js.nft.json 1.61kB 834.11kB 0.19%
../app/platform-redirect/page.js.nft.json 1.61kB 834.02kB 0.19%
../app/sitemap.xml/route.js.nft.json 1.61kB 831.25kB 0.19%
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 882.71kB -0.0%
static/chunks/8321-*.js -3 bytes 425.87kB -0.0%
static/Af1G09tGZDXR0yVrUmuNv/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/Af1G09tGZDXR0yVrUmuNv/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/6LgtbPx1rJRx6mMAKnQeU/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/6LgtbPx1rJRx6mMAKnQeU/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

….com/getsentry/sentry-docs into feat/python-docs-nav-standardization

* 'feat/python-docs-nav-standardization' of https://github.com/getsentry/sentry-docs:
  ref: Allign badges with Sentry’s in-product ones (#15561)
  feat: Document exporting from OTLP from shopify hydrogen storefronts (#15534)
  docs(size-analysis): Update sentry-android-gradle-plugin to 6.0.0-beta.2 (#15560)
  fix(developer docs): Correcting width issues in developer docs for toc (#15559)
  docs(feature-flag): add documentation for php feature flags (#15443)
  feat(python): Illustrate types of metrics (#15556)
  fix(dev-docs): Buffer fixes for logs and metrics (#15513)
  docs(sourcemaps): Remove mentions of `sentry-cli sourcemaps explain` (#15481)
  ref(develop/scopes): Clarify unit type for attributes (#15546)
  ref(develop/spans): Clarify span attribute `unit` and `type` types (#15547)
  docs(metrics): add upcoming SDKs to Metrics getting started page (#15545)
  doc(proguard): No inbound filters (#15543)
  getsentry/relay@9b19609
@codyde codyde merged commit e240628 into master Nov 20, 2025
16 checks passed
@codyde codyde deleted the feat/python-docs-nav-standardization branch November 20, 2025 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants