feat(python): Standardize Python docs navigation structure #15555
+82
−39
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Bundle ReportChanges will increase total bundle size by 4.63kB (0.02%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
| title: Set Up Feature Flags | ||
| sidebar_title: Feature Flags | ||
| sidebar_order: 7000 | ||
| sidebar_section: features |
There was a problem hiding this comment.
Bug: Feature Flags has incorrect sidebar order
Feature Flags is added to the features sidebar section but retains sidebar_order: 7000, which places it far outside the intended sequence. The JavaScript structure uses sidebar_order: 15 for Feature Flags in the features section. With the current value of 7000, Feature Flags will appear after all other features pages (which use orders 2-10) and likely after configuration pages (which use orders 11-18), breaking the intended navigation structure described in the PR.
….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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Standardizes Python SDK documentation navigation to match JavaScript structure:
Sidebar Sections
Features Section (sidebar_section: features)
Order: Capturing Errors → Logs → Tracing → Metrics → Profiling → Crons → User Feedback
Configuration Section (sidebar_section: configuration) Order: Sampling → Enriching Events → Extended Configuration → Integrations → Data Management → Security Policy Reporting → Migration → Troubleshooting
Follows the pattern established in #15440