Skip to content

Conversation

@ryan953
Copy link
Member

@ryan953 ryan953 commented Apr 7, 2025

Problem Statement
The framework you’ve picked is really important, but it scrolls away. So if you arrived at docs via a search you might be looking at instructions for a random framework and not realize it. Other hints on the page are:

  • The url (not a huge hint if you’re looking at javascript but want NextJS),
  • ‘Home / Platforms / JavaScript / Next.js’ breadcrumb but that scrolls away too
  • Package details in the right column, hard to spot that.

Solution
When the window is wide the navigation sidebar will now have a sticky Platform dropdown. So that dropdown is always visible, and users can easily see what docs are they reading. The nav links below will scroll behind the platform dropdown.

In narrow modes, when you have to click to see this whole nav column, the scrolling is the same as before, the platform list will move out of the way so you can find the link you're looking for.

Wide Narrow
SCR-20250407-ohrm SCR-20250407-ohxo

@vercel
Copy link

vercel bot commented Apr 7, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 7, 2025 11:31pm
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 7, 2025 11:31pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Apr 7, 2025 11:31pm

@ryan953 ryan953 requested a review from a team April 7, 2025 23:20
@codecov
Copy link

codecov bot commented Apr 7, 2025

Bundle Report

Changes will increase total bundle size by 42 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 11.13MB 5 bytes (0.0%) ⬆️
sentry-docs-client-array-push 9.47MB 37 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.75MB -0.0%
../instrumentation.js -3 bytes 1.08MB -0.0%
9523.js -3 bytes 1.05MB -0.0%
2065.js 14 bytes 82.5kB 0.02%

Files in 2065.js:

  • ./src/components/sidebar/style.module.scss → Total Size: 236 bytes

  • ./src/components/sidebar/style.module.scss → Total Size: 236 bytes

  • ./src/components/sidebar/index.tsx → Total Size: 5.34kB

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 868.7kB -0.0%
static/css/*.css 29 bytes 739.67kB 0.0%
static/css/*.css 14 bytes 14.12kB 0.1%
static/chunks/8165-*.js -3 bytes 410.1kB -0.0%
static/mnYqH0KXXO6zzwr0-*.js (New) 578 bytes 578 bytes 100.0% 🚀
static/mnYqH0KXXO6zzwr0-*.js (New) 77 bytes 77 bytes 100.0% 🚀
static/*XfF0_HUqdOk_Z/_buildManifest.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/*XfF0_HUqdOk_Z/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

Copy link
Contributor

@sfanahata sfanahata left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a chef's kiss! I love it. Looks great.

@ryan953 ryan953 merged commit 4d85a45 into master Apr 8, 2025
13 checks passed
@ryan953 ryan953 deleted the ryan953/fixed-framework-dropdown branch April 8, 2025 17:20
@github-actions github-actions bot locked and limited conversation to collaborators Apr 24, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants