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] Update README.md to match Introduction section of the docs #5754

Merged
merged 9 commits into from
Sep 1, 2022

Conversation

samuelsycamore
Copy link
Member

@samuelsycamore samuelsycamore commented Aug 10, 2022

This PR updates the MUI X repo README to bring it up to date with the text from the Introduction section of the docs. All sections have been revised, and new sections have been added for installation instructions and detailed info on the different plans.

Before: https://github.com/mui/mui-x/blob/master/README.md
After: https://github.com/samuelsycamore/mui-x/blob/update-readme/README.md

@samuelsycamore samuelsycamore added the docs Improvements or additions to the documentation label Aug 10, 2022
@mui-bot
Copy link

mui-bot commented Aug 10, 2022

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms 441.3 699.8 501.5 543.36 92.947
Sort 100k rows ms 664.3 1,129.1 809 896.34 157.034
Select 100k rows ms 176 415.1 283.2 278.9 80.34
Deselect 100k rows ms 168.3 264.1 209.8 208.98 32.715

Generated by 🚫 dangerJS against 4613fc1

README.md Outdated Show resolved Hide resolved
README.md Outdated

## Roadmap

The future plans and high priority features and enhancements can be found in the [roadmap](https://mui.com/discover-more/roadmap/) file.
Future plans and high-priority features and enhancements can be found in our [roadmap](https://mui.com/material-ui/discover-more/roadmap/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Future plans and high-priority features and enhancements can be found in our [roadmap](https://mui.com/material-ui/discover-more/roadmap/).
Future plans and high-priority features and enhancements can be found in our [roadmap](https://mui.com/x/introduction/roadmap/).

Link to MUI X roadmap instead?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops! 😅

Copy link
Member

@oliviertassinari oliviertassinari Aug 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Off-topic

I didn't know we had these two different roadmap pages. https://mui.com/material-ui/discover-more/roadmap/#new-components talks about what the next components planned for MUI X, an information developers don't get on https://mui.com/x/introduction/roadmap/.

I guess we need a central place to talk about the next component (not necessarily on the docs, it could be private in notion) so that Core and X don't say they will build the same one.

How should we resolve this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@oliviertassinari this sounds like another page that would be best suited for a companywide document—mui/material-ui#33514.

Copy link
Member

@joserodolfofreitas joserodolfofreitas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this update, @samuelsycamore!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: José Rodolfo Freitas <joserodolfo.freitas@gmail.com>
Co-authored-by: Andrew Cherniavskii <andrew.cherniavskii@gmail.com>
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@mbrookes
Copy link
Member

I do see the benefits of distinguishing the generic name for a control such as a "button", from the React component name "Button". It seems awkward to refer to a Button mid-sentence when referring generically to a button, and not to our specific React implementation.

For the example that sparked this discussion "Date and time pickers" seems fine to me.

@oliviertassinari
Copy link
Member

oliviertassinari commented Aug 31, 2022

It seems awkward to refer to a Button mid-sentence when referring generically to a button, and not to our specific React implementation.

@mbrookes Then I would be curious to get your perspective on these cases: #5780 (comment). It's no longer about the headers (what I felt we talked about here), but about how we reference these components in the body of the docs.

@samuelsycamore
Copy link
Member Author

I'm going to go ahead and merge this as is, but we can continue the conversation about capitalization conventions and come back to those minor details later if needed.

@samuelsycamore samuelsycamore merged commit 6f3e386 into mui:master Sep 1, 2022
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.

None yet

7 participants