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] Improve the default theme viewer design #39049

Merged

Conversation

danilo-leal
Copy link
Contributor

@danilo-leal danilo-leal commented Sep 19, 2023

This PR adds a small uplift on the default viewer page design: tweaked the Tree View a bit and the page formatting (e.g., removing the table of contents)(both the Material UI & Joy Ui pages). It's been bothering me for a while that this very useful resource wasn't fitting in well with the docs current visuals... so, finally put in some time to polish it up a bit.

Before After
Screen Shot 2023-09-18 at 21 17 24 Screen Shot 2023-09-18 at 21 17 17

@danilo-leal danilo-leal added docs Improvements or additions to the documentation design This is about UI or UX design, please involve a designer labels Sep 19, 2023
@danilo-leal danilo-leal self-assigned this Sep 19, 2023
@mui-bot
Copy link

mui-bot commented Sep 19, 2023

@zanivan
Copy link
Contributor

zanivan commented Sep 19, 2023

Great improvement, it looks amazing! 🤙

I was wondering if we should add the switches to 'expand all' and 'use dark theme' to Joy UI too—and maybe polish out these a bit

@danilo-leal
Copy link
Contributor Author

Absolutely! Having docs feature parity between the two + those switches not with default MD would be great! I'd need some engineering support there from the team (cc @noraleonte, @siriwatknp, @DiegoAndai) as I tried to do it myself for the last few here and found it to be kinda tricky 😬 😅

Copy link
Member

@siriwatknp siriwatknp left a comment

Choose a reason for hiding this comment

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

👍 Left one comment.

@noraleonte
Copy link
Contributor

Looks very cool! 🎉 🤙

I think that the typeface is not loading as it is supposed to...not sure why, but it defaults back to this for me:
image

Might be an OS thing, because it looks very different on my phone, but maybe if we want to change a font family we should always import it first to make sure there is consistency 🤔

@danilo-leal
Copy link
Contributor Author

@noraleonte Uhm... can you try again now? I've added Consolas as another font family, which seems to be the Windows default monospace family? As a meta note, for some reason, using the theme in the TreeView item in this file doesn't work, for a reason I can't understand 😬 😅

Copy link
Contributor

@noraleonte noraleonte left a comment

Choose a reason for hiding this comment

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

Looks great! 🎉 🤙

@danilo-leal danilo-leal merged commit b305e09 into mui:master Sep 22, 2023
6 checks passed
@danilo-leal danilo-leal deleted the imrpvoe-default-theme-viewer-design branch September 22, 2023 11:26
mnajdova pushed a commit to mnajdova/material-ui that referenced this pull request Sep 25, 2023
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
Projects
Status: Recently completed
Development

Successfully merging this pull request may close these issues.

5 participants