-
-
Notifications
You must be signed in to change notification settings - Fork 32.7k
[blog] Share what's changed about the new docs structure #32044
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
Conversation
|
@samuelsycamore Tagging you here early so we work on it while it is on draft =) PS: I'd love to get thoughts on the URL. Unsure if the one I came up with is good enough (feeling like it isn't!). |
Co-authored-by: Siriwat K <[email protected]>
Co-authored-by: Siriwat K <[email protected]>
…/material-ui into blog-docs-separation
siriwatknp
left a comment
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.
👍 Looks great!
mapache-salvaje
left a comment
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.
Looking good! In addition to my suggestions here, I'll leave a separate comment with some ideas to beef up the title and description.
|
@samuelsycamore Should we mention the copywriting update on the home page in this blog post as well? |
mnajdova
left a comment
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.
Just one small comment, looks great otherwise.
Co-authored-by: Andrew Cherniavskii <[email protected]> Co-authored-by: Marija Najdova <[email protected]>
oliviertassinari
left a comment
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.
Great to have a blog post to announce this change 👍
docs/pages/blog/docs-updates.md
Outdated
| - Data Grid: [https://mui.com/x/react-data-grid/](https://mui.com/x/react-data-grid/) | ||
| - Date and Time Pickers: [https://mui.com/x/react-date-pickers/](https://mui.com/x/react-date-pickers/getting-started/) | ||
|
|
||
| > 📖 The MUI X date and time pickers has been moved from the lab (`@mui/lab`). If you are curious about it, check out the [dedicated blog post](/blog/lab-date-pickers-to-mui-x/). |
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.
| > 📖 The MUI X date and time pickers has been moved from the lab (`@mui/lab`). If you are curious about it, check out the [dedicated blog post](/blog/lab-date-pickers-to-mui-x/). | |
| > 📖 The MUI X date and time pickers have been moved from the lab (`@mui/lab`). If you are curious about it, check out the [dedicated blog post](/blog/lab-date-pickers-to-mui-x/). |
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.
And maybe to be clearer:
| > 📖 The MUI X date and time pickers has been moved from the lab (`@mui/lab`). If you are curious about it, check out the [dedicated blog post](/blog/lab-date-pickers-to-mui-x/). | |
| > 📖 The date and time pickers have been promoted from the lab (`@mui/lab`) to MUI X, saying MIT licensed. If you are curious about it, check out the [dedicated blog post](/blog/lab-date-pickers-to-mui-x/). |
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'll leave it to @samuelsycamore for these grammar revisions (there are others below if you could take a look!). Regardless, the notion of "promoted" is good!
|
|
||
| <img src="/static/blog/docs-updates/docs-product-label.png" style="width: 796px; margin-top: 16px; margin-bottom: 16px;" alt="Screenshot of the search results displaying product labels per result" /> | ||
|
|
||
| As a side benefit of the documentation restructuring, we have seen a huge improvement in the quality of search results related to MUI X. Data Grid users can now see comprehensive results when searching for features. Here is a comparison of before and after when searching for the "pagination" feature: |
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.
| As a side benefit of the documentation restructuring, we have seen a huge improvement in the quality of search results related to MUI X. Data Grid users can now see comprehensive results when searching for features. Here is a comparison of before and after when searching for the "pagination" feature: | |
| As a side benefit of the documentation restructuring, we have seen a huge improvement in the quality of search results related to MUI X. Data grid users can now see comprehensive results when searching for features. Here is a comparison of before and after when searching for the "pagination" feature: |
| - _MUI Base_ —unstyled components for implementing your own design system | ||
| - _MUI System_ —CSS utilities for quickly laying out design systems | ||
| - **MUI X**—a collection of advanced components for complex use cases, including: | ||
| - _Data Grid_ —fast, feature-rich, extendable React data table |
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.
| - _Data Grid_ —fast, feature-rich, extendable React data table | |
| - _Data grid_ —fast, feature-rich, extendable React data table |
| - _MUI System_ —CSS utilities for quickly laying out design systems | ||
| - **MUI X**—a collection of advanced components for complex use cases, including: | ||
| - _Data Grid_ —fast, feature-rich, extendable React data table | ||
| - _Date and Time Pickers_ —interface control components for selecting dates and times |
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.
| - _Date and Time Pickers_ —interface control components for selecting dates and times | |
| - _Date and Time pickers_ —interface control components for selecting dates and times |
mapache-salvaje
left a comment
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.
just one tiny grammar fix here and then I think it's ready!
Co-authored-by: Sam Sycamore <[email protected]>
Deploy preview: https://deploy-preview-32044--material-ui.netlify.app/blog/docs-updates/