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 icons and tweak the design of the side nav #37860

Merged
merged 6 commits into from
Jul 12, 2023

Conversation

danilo-leal
Copy link
Contributor

@danilo-leal danilo-leal commented Jul 7, 2023

After a few days of sleeping on this, I'm enjoying this design. It removes some of the visual weight of the whole docs, simplifies things, and makes it easier to identify subheaders in the side nav. Here's how it looks:

Screen Shot 2023-07-10 at 20 42 53

https://deploy-preview-37860--material-ui.netlify.app/base-ui/getting-started/

@danilo-leal danilo-leal added the docs Improvements or additions to the documentation label Jul 7, 2023
@danilo-leal danilo-leal self-assigned this Jul 7, 2023
@gerdadesign
Copy link
Member

Really nice! Simpler and easier to see subheaders. Should we also apply this to X and Toolpad?

@danilo-leal danilo-leal marked this pull request as ready for review July 10, 2023 23:44
@mui-bot
Copy link

mui-bot commented Jul 10, 2023

Netlify deploy preview

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

Bundle size report

No bundle size changes

Generated by 🚫 dangerJS against 90da3ff

@danilo-leal danilo-leal added the scope: docs-infra Specific to the docs-infra product label Jul 10, 2023
@danilo-leal danilo-leal changed the title [docs] Remove icons and tweak the design of the side nav [docs-infra] Remove icons and tweak the design of the side nav Jul 10, 2023
@samuelsycamore
Copy link
Member

I like this a lot! Makes the subheaders much easier to distinguish from the docs themselves.

@noraleonte
Copy link
Contributor

Love this! 🎉 Looks so much cleaner!

Copy link
Member

@DavidCnoops DavidCnoops left a comment

Choose a reason for hiding this comment

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

LGTM!

@danilo-leal danilo-leal merged commit f95e2ce into master Jul 12, 2023
24 checks passed
@danilo-leal danilo-leal deleted the tweak-navdraweritem-design branch July 12, 2023 00:12
@oliviertassinari
Copy link
Member

oliviertassinari commented Jul 16, 2023

So I believe we should remove all the icons from the sidenavs, e.g.

icon: standardNavIcons.ReaderIcon,

It's bundle size / code we don't use.


MUI X might be the most impacted by this change,

Screenshot 2023-07-16 at 20 42 14

but no objections from my end. This is a different tradeoff:

Screenshot 2023-07-16 at 20 43 40

which I imagine can be solved with an index page, like https://mui.com/base-ui/all-components/.

@oliviertassinari oliviertassinari added the design This is about UI or UX design, please involve a designer label Jul 16, 2023
@@ -1,6 +1,5 @@
import * as React from 'react';
Copy link
Member

Choose a reason for hiding this comment

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

@danilo-leal Nice, I love the new side nav design! 🎉
I tried it out in MUI X - where we have a more nested structure: https://deploy-preview-9716--material-ui-x.netlify.app/x/react-data-grid/

Here are a few things I have noticed so far:

  1. Pages on the same level are not visually aligned. It looks like "Columns" and "Rows" are children of the "Layout" page, even though they are siblings:
  1. No vertical separator on the second level of nesting.
    Do you think it would look better if there were separators on each nesting level?

Let me know what you think 🙂
Looking forward to bringing the new design to MUI X docs!

Copy link
Member

Choose a reason for hiding this comment

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

It sounds like we should add this navigation case in https://master--material-ui.netlify.app/experiments/docs/installation/, so that when we make changes, we can also cover nested navigation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@cherniavskii sweet, I'm glad you enjoyed it, and thanks for calling attention to this ⎯ @oliviertassinari had already signaled it! Is there a way I can play with this to try to tackle these issues? I don't know how I'd change something on this repo and have an effect on the X docs 🤔 Having a mocked scenario on the experiments folder would 100% help, I think!

Either way, apologies for not having consulted y'all before merging that PR, that's my bad 😞

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@cherniavskii that'd be perfect! Let me know when these are up so I can promptly work on the design!

Copy link
Member

Choose a reason for hiding this comment

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

@danilo-leal Here you go: #38047

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 docs Improvements or additions to the documentation scope: docs-infra Specific to the docs-infra product
Projects
Status: Recently completed
Development

Successfully merging this pull request may close these issues.

None yet

8 participants