mui
[docs] Subdivide and reorganize navigation bar
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.
- "Common features" –> "~Core~ Main features"
- consistent placement of docs repeated across packages
- API references live in Resources sections
- Accessibility docs live in Main features
- FAQs live in Getting Started sequence (following Material UI's pattern)
- "Common concepts—Custom subcomponents" –> "Common concepts—Slots and subcomponents" to differentiate the doc from the individual product "Custom subcomponents" page - I'd like to return to these pages another time, but for now this is just a change to the nav bar and some links.
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
- (Getting started sequence)
- Main features
- Advanced features
- Customization
- Resources
Date and Time Pickers
- (Getting started sequence)
- Components
- Main features
- Localization
- Customization
- Resources
Charts
- (Getting started sequence)
- Components
- Main features
- Resources
- Future components - I think this section should be merged into Components after one or two more Charts move from "Planned" to "Preview"
Tree View
- (Getting started sequence)
- Simple Tree View
- Rich Tree View
- Main features
- Resources
Deploy preview: https://deploy-preview-15014--material-ui-x.netlify.app/
Updated pages:
- docs/data/data-grid/components/components.md
- docs/data/date-pickers/custom-components/custom-components.md
- docs/data/date-pickers/custom-field/custom-field.md
- docs/data/date-pickers/custom-layout/custom-layout.md
- docs/data/date-pickers/custom-opening-button/custom-opening-button.md
Generated by :no_entry_sign: dangerJS against 920167cd8fe96f856d3344c627fe285fc38f891d
This pull request has conflicts, please resolve those before we can evaluate the pull request.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
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.)
- https://mui.com/x/react-data-grid/row-recipes/
- https://mui.com/x/react-data-grid/filtering-recipes/
- https://mui.com/x/react-data-grid/style-recipes/
- https://mui.com/x/react-data-grid/recipes-editing/
- https://mui.com/x/react-data-grid/recipes-row-grouping/
All recipe docs in the dedicated Recipes section, or living alongside their main feature docs?
I think the plan was to have recipes alongside their main feature docs. I moved editing recipes to the Editing section in https://github.com/mui/mui-x/pull/7772, but I never finished that effort 🫠 I propose doing this:
- Editing
- Overview
- Recipes
- Row grouping
- Overview
- Recipes
There should be no changes to the pages URLs required for this.
All recipe docs in the dedicated Recipes section, or living alongside their main feature docs?
I think "Recipes" is mostly relevant to the Data Grid. For other packages we don't have such a clear notion, maybe Charts could replace "Demos" with "Recipes". cc @mui/xcharts
Whereas, for Pickers, it is pretty rare to have many examples, we mostly showcase props and customization options.
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!