-
-
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] Reorganize the page menu #10139
Conversation
Netlify deploy previewNetlify deploy preview: https://deploy-preview-10139--material-ui-x.netlify.app/ Updated pagesNo updates. These are the results for the performance tests:
|
I like a lot the result 🤩 I don't know if Common features should be above or below Components And how about moving Base concepts inside Common features? |
I think it depends for which audience we write it. For new users, I believe Common before Components is better because it forces them to read it (at least the title) before finding the component. So they know those pages exist For advanced users, the opposite feels more natural: components > features > API
Not sure. For me up to "Base concepts" it is about pages you have to read before trying to use those components. Otherwise, you might spend some time lost. In common features, it's well-scoped features such as validation or shortcuts. If you don't need validation, you can skip this page. |
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 change looks great! 💯
My only concern is the vertical height, which no longer fits all the pickers menu items on a MacBook 16" screen.
I do agree with Flavien, IMHO, Common features
would probably make more sense below the Components
section. 👌
As for the Base Concepts
, I'm not sure it needs to end up in the Common features
section, especially if we move it below the components. 🤔
I don't think it's an issue since it's just moving from "hidden by a click" to "hidden by scroll" |
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.
Super nice improvement! 🎉
I also think that Base concepts
should live on the top of the menu, as an 'outline' of sorts that users would read before diving deep into the docs, not in Common features
. So I think the current placement of thinks is 💯
To simplify the distinction between docs pages that are common to most of the components and the components themself, I propose to reorganize the menu. Part of #10075
Proposal
A first group "common feature" with most used features: validation, lifecycle, and shortcuts
Identify all components in a group
Replace the two accordion by a subsection
The diff