-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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] Subdivide and reorganize navigation bar #15014
Conversation
Deploy preview: https://deploy-preview-15014--material-ui-x.netlify.app/ Updated pages: |
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.
Approving the pickers and tree view changes 👍
This pull request has conflicts, please resolve those before we can evaluate the pull request. |
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.
Nice unification, thank you for taking care of it. 👍
Data Grid sees the biggest overhaul. 🎉
If the existing raised points are addressed, everything else looks good. 💯
I just realized that the Data Grid's Recipes section has pages for Editing and Row Grouping—but other features like Filtering and Rows have a Recipes page alongside their main content, rather than in this section. I think it should be one way or the other for all features. Which do you prefer @cherniavskii @LukasTy @KenanYusuf : All recipe docs in the dedicated Recipes section, or living alongside their main feature docs? (I would propose moving them all to the dedicated Recipes section, but I don't have a strong preference on this.) |
I think the plan was to have recipes alongside their main feature docs. I moved editing recipes to the Editing section in #7772, but I never finished that effort 🫠
There should be no changes to the pages URLs required for this. |
I think "Recipes" is mostly relevant to the Data Grid. Whereas, for Pickers, it is pretty rare to have many examples, we mostly showcase props and customization options. |
The closest we have from a recipe are the examples in "Custom field" and they should remain in a customization-related page, not a page called "Recipe" IMHO. So I'm fine with the grid moving their recipes next to the feature. |
Tangential: "Recipes" as a concept does seem to be unique to the Data Grid. We don't have them in play for any of the other MUI products. Some Material UI and Joy UI components have "Common Examples" intended to be closest to real-world UI in the demos, but maybe that's a slightly different concept. I don't think the Charts "Demos" would fall into the Recipes category either, because it seems like recipes are more about complex use cases that implement advanced features. (From what I've seen, the question of whether or not a demo could be considered a recipe might be, "could I create a full tutorial around this implementation?") If users find the Data Grid recipes helpful then we should consider creating them for other packages/components as well. For now, I'll move forward with @cherniavskii 's proposal for these pages and then I think this PR will be ready to merge. Thanks for the input everyone! |
{ | ||
pathname: '/x/api/picker-resources', | ||
subheader: 'Resources', | ||
children: [ | ||
{ | ||
pathname: '/x/api/date-pickers-group', | ||
title: 'API reference', | ||
children: [{ pathname: '/x/api/date-pickers', title: 'Index' }, ...pickersComponentApi], | ||
}, | ||
], | ||
}, |
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.
This lead to two bugs. Fixing this in mui/material-ui#44514.
The primary purpose of this PR is to better organize the Data Grid navigation, which has outgrown its current structure, by introducing new subheaders and applying them consistently across all of the X products. This should help the docs scale comfortably over the next couple years.
CoreMain features"I don't have strong opinions about the order of most of the pages under the subheaders, so if others feel strongly about rearranging any of them please speak up!
Data Grid
Date and Time Pickers
Charts
Tree View