[blog] Share what's changed about the new docs structure#32044
Merged
siriwatknp merged 34 commits intomui:masterfrom Apr 8, 2022
Merged
[blog] Share what's changed about the new docs structure#32044siriwatknp merged 34 commits intomui:masterfrom
siriwatknp merged 34 commits intomui:masterfrom
Conversation
Collaborator
Author
|
@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!). |
mbrookes
requested changes
Mar 30, 2022
mnajdova
reviewed
Mar 31, 2022
mnajdova
reviewed
Mar 31, 2022
siriwatknp
reviewed
Apr 4, 2022
siriwatknp
reviewed
Apr 4, 2022
Co-authored-by: Siriwat K <siriwatkunaporn@gmail.com>
Co-authored-by: Siriwat K <siriwatkunaporn@gmail.com>
…/material-ui into blog-docs-separation
Contributor
mapache-salvaje
left a comment
mapache-salvaje
left a comment
There was a problem hiding this comment.
Looking good! In addition to my suggestions here, I'll leave a separate comment with some ideas to beef up the title and description.
siriwatknp
reviewed
Apr 6, 2022
siriwatknp
reviewed
Apr 6, 2022
…-docs-separation
Member
|
@samuelsycamore Should we mention the copywriting update on the home page in this blog post as well? |
mnajdova
reviewed
Apr 7, 2022
mnajdova
approved these changes
Apr 7, 2022
Member
mnajdova
left a comment
mnajdova
left a comment
There was a problem hiding this comment.
Just one small comment, looks great otherwise.
cherniavskii
reviewed
Apr 7, 2022
Co-authored-by: Andrew Cherniavskii <andrew.cherniavskii@gmail.com> Co-authored-by: Marija Najdova <mnajdova@gmail.com>
Member
oliviertassinari
left a comment
oliviertassinari
left a comment
There was a problem hiding this comment.
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/). |
Member
There was a problem hiding this comment.
Suggested change
| > 📖 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/). |
Member
There was a problem hiding this comment.
And maybe to be clearer:
Suggested change
| > 📖 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/). |
Collaborator
Author
There was a problem hiding this comment.
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: |
Member
There was a problem hiding this comment.
Suggested change
| 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 |
Member
There was a problem hiding this comment.
Suggested change
| - _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 |
Member
There was a problem hiding this comment.
Suggested change
| - _Date and Time Pickers_ —interface control components for selecting dates and times | |
| - _Date and Time pickers_ —interface control components for selecting dates and times |
Contributor
mapache-salvaje
left a comment
mapache-salvaje
left a comment
There was a problem hiding this comment.
just one tiny grammar fix here and then I think it's ready!
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Deploy preview: https://deploy-preview-32044--material-ui.netlify.app/blog/docs-updates/