[core][docs] Restore and revise the Box docs #40622
Conversation
samuelsycamore
added
docs
Netlify deploy preview
Bundle size report |
github-actions
bot
added
the
PR: out-of-date
github-actions
bot
removed
the
PR: out-of-date
| @@ -5,6 +5,8 @@ components: Box | |||
| githubLabel: 'component: Box' | |||
| --- | |||
|
|
|||
| <!-- This page's content is duplicated (with some product-specific details) across the Material UI, Joy UI, and MUI System docs. Any changes should be applied to all three pages at the same time. --> | |||
There was a problem hiding this comment.
How do we feel about comments like this? It was the best way I could think of to draw attention to this fact to try to keep these pages in sync.
|
One thing I still don't love is the need to discuss MUI System in the Material UI and Joy UI pages. It's confusing! I shouldn't need to know about this whole other product to use this component. I'm not sure how to address this. |
|
Hey @zanivan ! 👋 I'm pretty much done with the copy revisions in this PR. Feel free to pitch in if you have any ideas to make the demos more interesting! We could use a demo for the Introduction section in particular. |
There was a problem hiding this comment.
Looks great to me—straightforward to understand and go through! 🤙 I supposed the mentions of MUI System in both the Material and Joy UI docs become less weird if we (over time) reinforce that these packages were made optimized for this particular styling package (and how they play extra-nicely together). This may be understood already, but it feels more implicit than the opposite.
WIP
See: #39637 (comment)
This PR brings the Box content back to the Material UI and Joy UI docs, instead of redirecting users to the MUI System docs. I'm also taking the opportunity to do another pass on the content here, to improve the demos and bring the format closer to the latest version of the Material UI demo pages.