feat: JavaScript Docs display order, tags, split-layout #15440
Merged
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
codyde
force-pushed
the
feat/js-docs-apis-sampling-restructure
branch
from
86481fd to
26f7e78
Compare
Bundle ReportChanges will increase total bundle size by 14.3kB (0.06%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
App Routes Affected:
|
codyde
force-pushed
the
feat/js-docs-apis-sampling-restructure
branch
from
32663b2 to
26f7e78
Compare
- Move apis.mdx from /common/ to /common/configuration/ - Move sampling.mdx from /common/configuration/ to /common/ - Add redirects for both old paths to maintain existing links This reorganization improves the documentation structure by: - Placing APIs documentation with other configuration topics - Elevating sampling to a top-level concept (not just a config option) All existing URLs will automatically redirect to the new locations.
- Move Logs to sidebar_order: 2 (add 'new' badge) - Move Metrics to sidebar_order: 3 (add 'beta' badge) - Move Session Replay to sidebar_order: 4 - Move Tracing to sidebar_order: 5 (add section separator) This reorders the navigation to prioritize newer features (Logs, Metrics) higher in the sidebar for better discoverability.
- Rename 'Configuration' to 'Advanced Configuration' for clarity - Add explicit sidebar_title - Move to sidebar_order: 100 to position at end of navigation This helps differentiate basic setup from advanced configuration topics.
codyde
force-pushed
the
feat/js-docs-apis-sampling-restructure
branch
from
26f7e78 to
408a1d8
Compare
codyde
changed the title
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
codyde
requested review from
Lms24,
chargome,
coolguyzone,
s1gr1d and
sergical
and removed request for
a team
sergical
approved these changes
Nov 17, 2025
Member
sergical
left a comment
sergical
left a comment
There was a problem hiding this comment.
Looks great! my small piece of feedback is potentially on mobile getting rid of the line and having the numbers just be part of the headers to give content some more room
Contributor
|
I think we may want to re-evaluate the breakpoints for stacking the two columns, if you look at it at 1040px width, the code sample becomes trick to read/navigate. 
|
coolguyzone
approved these changes
Nov 17, 2025
Contributor
coolguyzone
left a comment
coolguyzone
left a comment
There was a problem hiding this comment.
The changes look good to me, I have some broader thoughts as well. These are not blockers, and I think we should merge this ASAP, but some things to consider looking forward:
-
It certainly feels like an improvement to me, but do we want to quantify this somehow? e.g. run an A/B test in google analytics and see if things like time on page, drop-offs, etc. change in the right direction.
-
Could it be disorienting to users to release the split layout peace-meal like this, rather than updating all the SDKs at once?
-
Are we documenting how to implement this 2-column layout and letting contributors know that we are moving in this direction? For example adding it to the https://docs.sentry.io/contributing/ guide.
-
See my other comment about responsive breakpoints as well.
- Move feature selection buttons from Install to Configure section across all JS framework guides - Add "Quick Start" link to platform sidebars for better navigation - Change sidenav collapse breakpoint from 1024px to 1130px for better responsive behavior 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
codyde
added a commit
that referenced
this pull request
Nov 20, 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 <img width="415" height="932" alt="CleanShot 2025-11-18 at 10 48 58@2x" src="https://github.com/user-attachments/assets/326d3bc4-7109-4d46-9cb5-bc315646ec1c" />
codyde
pushed a commit
that referenced
this pull request
Nov 27, 2025
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR See changes on https://sentry-docs-git-feat-ruby-docs-nav-standardized.sentry.dev/platforms/ruby/ and all ruby platforms Sidebar Sections Added 'Features' section with organized feature pages Added 'Configuration' section Both sections now have proper headers and grouping Features Section (sidebar_section: features) Order: Capturing Errors → Logs → Tracing → Profiling → Crons 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: Enriching Events → Extended Configuration → Integrations → Data Management → Security Policy Reporting → Migration Guide → Troubleshooting Follows the pattern established in #15440 <img width="321" height="744" alt="Screenshot 2025-11-21 at 2 48 07 PM" src="https://github.com/user-attachments/assets/238cc32d-0a70-4121-bb96-1aebb167dd53" /> ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [ ] 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 *Make sure you've checked the following before merging your changes:* - [ ] 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) ## LEGAL BOILERPLATE <!-- Sentry employees and contractors can delete or ignore this section. --> Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms. ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/) --------- Co-authored-by: Alex Krawiec <alex.krawiec@R7J1Y747QQ.local>
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.
Note: This change will create a difference in layout outside of the JavaScript SDKs. I will be fast following updates to the layout for other SDKs, as well as fast following the pill icons to the other SDKs as well for Logs / Metrics - i dont want to overload this PR with all of those changes.