Skip to content
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

Merged
merged 3 commits into from
Aug 28, 2023

Conversation

alexfauquette
Copy link
Member

@alexfauquette alexfauquette commented Aug 25, 2023

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

Screenshot from 2023-08-25 16-34-36

@mui-bot
Copy link

mui-bot commented Aug 25, 2023

Netlify deploy preview

Netlify deploy preview: https://deploy-preview-10139--material-ui-x.netlify.app/

Updated pages

No updates.

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms -206.6 97.9 -83.7 -74.38 117.721
Sort 100k rows ms 720.5 1,674.8 1,571.5 1,312.68 336.692
Select 100k rows ms 747.7 991.9 812.4 848.32 85.298
Deselect 100k rows ms 151 300.8 207.7 209.96 54.274

Generated by 🚫 dangerJS against 1ebf2c6

@alexfauquette alexfauquette added the docs Improvements or additions to the documentation label Aug 25, 2023
@flaviendelangle
Copy link
Member

flaviendelangle commented Aug 25, 2023

I like a lot the result 🤩

I don't know if Common features should be above or below Components
They are less used than some pages from Components so maybe we should keep the components on the top to make those pages as accessible as possible.

And how about moving Base concepts inside Common features?

@alexfauquette
Copy link
Member Author

I don't know if Common features should be above or below Components

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

And how about moving Base concepts inside Common features?

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.

Copy link
Member

@LukasTy LukasTy left a 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. 🤔

@alexfauquette
Copy link
Member Author

My only concern is the vertical height, which no longer fits all the pickers menu items on a MacBook 16" screen.

I don't think it's an issue since it's just moving from "hidden by a click" to "hidden by scroll"

Copy link
Contributor

@noraleonte noraleonte left a 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 💯

@alexfauquette alexfauquette merged commit 9458b70 into mui:master Aug 28, 2023
@alexfauquette alexfauquette deleted the update-page-order branch August 28, 2023 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants