feat: JavaScript Docs display order, tags, split-layout #15440
Conversation
|
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 2.46kB (0.01%) ⬆️. 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:
|
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
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
|
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
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.
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.