Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs-infra] Remove border from the side nav #40326

Closed
wants to merge 1 commit into from

Conversation

danilo-leal
Copy link
Contributor

@danilo-leal danilo-leal commented Dec 26, 2023

This PR removes the border-right from the documentation side nav. I've been flirting with this idea for a while, feeling like the docs are "heavy" somehow, and doing so helps a lot in alleviating this sentiment.

@danilo-leal danilo-leal added design This is about UI or UX design, please involve a designer scope: docs-infra Specific to the docs-infra product labels Dec 26, 2023
@danilo-leal danilo-leal requested review from alexfauquette and a team December 26, 2023 12:22
@danilo-leal danilo-leal self-assigned this Dec 26, 2023
@mui-bot
Copy link

mui-bot commented Dec 26, 2023

Netlify deploy preview

https://deploy-preview-40326--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 9ba12f3

@oliviertassinari
Copy link
Member

oliviertassinari commented Dec 27, 2023

Bold move, but comparing the experiences to https://www.notion.so/mui-org/Docs-infra-83ba469842104927bb13606b1e859ef4?pvs=4#7647eb75870c42a79dc5bdd85cc412e2, it makes sense.

Side note: for Windows and macOS users like me who always have their scrollbar visible, the difference is very hard to notice.

Copy link
Member

@alexfauquette alexfauquette left a comment

Choose a reason for hiding this comment

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

A divider or not a divider that is the question 💀🎭

Do you also want to remove the divider of the toolbar?

image

I might admit I've no opinion on this kind of choice

@danilo-leal
Copy link
Contributor Author

danilo-leal commented Jan 3, 2024

@mui/design — curious if y'all have any thoughts! 😃 I'm still feeling it...

@zanivan
Copy link
Contributor

zanivan commented Jan 8, 2024

Leaving my 2 cents:

Though it look cleaner and lighter without the border (something I really like), it feels that the content is not properly centered due the uneven whitespaces:
image


Looking to some benchmarks, they solved this with diferent approaches:

Screenshot 2024-01-08 at 12 26 54

Shadcn glued the TOC to the content instead of fixing it to the right.

Screenshot 2024-01-08 at 12 27 34

Radix uses Gestault principles to solve this missperception by making the selected item and search field with full width in the left section

@danilo-leal
Copy link
Contributor Author

The docs main container in our case is centered, though — what made it feel like it isn't, from the first screenshot, is that you don't have any selected item (particularly as we don't maintain the parent-level accordion header link selected), and thus your first red block there is starting from the edge of the longest label rather than the container's width edge.

Screenshot 2024-01-08 at 23 38 16

I'm honestly torn with this change. Not sure which one feels better (current vs. this). And there are various cases of great feeling docs with both approaches, so it's definitely not something concretely objective. 🤔

@zanivan
Copy link
Contributor

zanivan commented Jan 9, 2024

The docs main container in our case is centered, though — what made it feel like it isn't, from the first screenshot, is that you don't have any selected item (particularly as we don't maintain the parent-level accordion header link selected), and thus your first red block there is starting from the edge of the longest label rather than the container's width edge.

Yep, definitely! That was what I was trying to show. When nothing is selected, it feels misaligned—something that Radix solved with the search field and the selected item.

I'm honestly torn with this change. Not sure which one feels better (current vs. this). And there are various cases of great feeling docs with both approaches, so it's definitely not something concretely objective. 🤔

I think we can iterate a bit more, some users seem to like it this way, and tbh I think this feels lighter than the current version, what imo is something we need in the docs.

@danilo-leal
Copy link
Contributor Author

I'll close this one for now as I'm still not entirely sure 😃 We can return it soon — don't want to leave it lingering here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design This is about UI or UX design, please involve a designer scope: docs-infra Specific to the docs-infra product
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants