-
-
Notifications
You must be signed in to change notification settings - Fork 32.3k
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][material-ui] Revise the Paper component docs #38841
Conversation
Netlify deploy previewBundle size report |
While we're here, should we talk about starting to apply consistent structure and formatting to all of the Material UI Component docs? #35158 We could go ahead and start applying the same basic format that we've established in the latest drafts of the Joy UI docs. Or do you think that's beyond the scope of this PR? |
@samuelsycamore I'd be happy to start now! I wondered if I could have done it already but wasn't sure. Seems like we're good to get started, then? 😬 |
Might as well! I had put that umbrella issue on hold to focus on Base and Joy, but it seems like the content revisions for Base are coming to an end. Try applying the basic header structure and formatting from the Joy docs and see what happens! This is a short and sweet doc so it should be pretty simple, and I think it will make for a much better experience. |
@samuelsycamore Added the formatting, let me know what you think about it! |
Hey @danilo-leal ! I started reviewing but quickly realized it would be easier for me to just push some changes myself. Hope you don't mind! Here's what I did:
Let me know what you think! Nothing is set in stone here—still feeling out how the patterns translate. |
@samuelsycamore absolutely, no worries at all! This is looking so much better! 🥲 Appreciate you chiming in 🤘 |
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com> Signed-off-by: Danilo Leal <67129314+danilo-leal@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm happy with it if you are @danilo-leal ! I think this is a night-and-day improvement honestly.
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
This PR revises the Paper component documentation content. I'm one of those Material UI users who probably have questioned themselves on why using this component vs. the Box, or really any other container-like component, for virtually everything if following Material Design isn't a desired thing. Through a recent docs-feedback entry mentioning this, I realize the docs didn't answer this... so, this is an attempt to flesh this out a bit for readers.
https://deploy-preview-38841--material-ui.netlify.app/material-ui/react-paper/