[docs] Add "Overview" page to Material UI docs #32643
Conversation
Co-authored-by: danilo leal <[email protected]>
Co-authored-by: Matt <[email protected]>
Co-authored-by: Matt <[email protected]>
Co-authored-by: Matt <[email protected]>
|
|
||
| ## Introduction | ||
|
|
||
| Material UI is an open-source React component library that implements Google's [Material Design](https://material.io/). |
There was a problem hiding this comment.
| Material UI is an open-source React component library that implements Google's [Material Design](https://material.io/). | |
| Material UI is an open-source React component library that implements version 2 of Google's [Material Design](https://material.io/). |
There was a problem hiding this comment.
We take the risk to forget to update "version 2" with Material UI v6 which would cover Material Design v3 if everything goes smoothly.
If we really want to mention a version, then I think that we should rephrase it, in the current wording, it could sounds like v2 is our ultimate goal. Instead, we could say something around "currently v2". e.g.
| Material UI is an open-source React component library that implements Google's [Material Design](https://material.io/). | |
| Material UI is an open-source React component library that implements Google's [Material Design](https://material.io/). | |
| It currently only supports Material Design v2, see [issue #12134](foo/bar) for the support of Material Design v3. |
There was a problem hiding this comment.
I'm confused about what's the intended direction regarding Material's v3, it doesn't seem to exist alignment in this matter — see #32643 (comment)
There was a problem hiding this comment.
Here's what I've added based on my understanding of the situation—please correct me if I'm wrong:
:::info
Material UI currently supports Material Design v2.
Adoption of v3 is tentatively planned for Material UI v6.
You can follow [this GitHub issue](https://github.com/mui/material-ui/issues/29345) for future updates.
:::
There was a problem hiding this comment.
Alternatively: we could always just leave this out completely if we aren't prepared to say yes or no to v3 adoption. 😅
|
|
||
| ## Introduction | ||
|
|
||
| Material UI is an open-source React component library that implements Google's [Material Design](https://material.io/). |
There was a problem hiding this comment.
We take the risk to forget to update "version 2" with Material UI v6 which would cover Material Design v3 if everything goes smoothly.
If we really want to mention a version, then I think that we should rephrase it, in the current wording, it could sounds like v2 is our ultimate goal. Instead, we could say something around "currently v2". e.g.
| Material UI is an open-source React component library that implements Google's [Material Design](https://material.io/). | |
| Material UI is an open-source React component library that implements Google's [Material Design](https://material.io/). | |
| It currently only supports Material Design v2, see [issue #12134](foo/bar) for the support of Material Design v3. |
Co-authored-by: Matt <[email protected]>
Co-authored-by: Matt <[email protected]>
Co-authored-by: Matt <[email protected]>
Co-authored-by: Matt <[email protected]>
Co-authored-by: Matt <[email protected]>
Co-authored-by: Olivier Tassinari <[email protected]>
Co-authored-by: Olivier Tassinari <[email protected]>
Co-authored-by: Olivier Tassinari <[email protected]>
This PR adds an Overview page to the Getting started section of the Material UI docs, following the same format as #32310.
Once this PR gets merged, I'll return to the Base Overview page and link back to this one when mentioning Material UI.Might as well just add this here too. 😁