Skip to content

[docs] Improve getting-started page #5293

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

Merged
merged 5 commits into from
Jun 27, 2022

Conversation

alexfauquette
Copy link
Member

@alexfauquette alexfauquette commented Jun 22, 2022

Fix #5290

main modifications:

before: https://mui.com/x/react-date-pickers/getting-started/
after: https://deploy-preview-5293--material-ui-x.netlify.app/x/react-date-pickers/getting-started/

@alexfauquette alexfauquette added the docs Improvements or additions to the documentation label Jun 22, 2022
@mui-bot
Copy link

mui-bot commented Jun 22, 2022

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms 243.7 406.2 384.1 335 72.239
Sort 100k rows ms 435.4 802.4 704.6 652.34 125.058
Select 100k rows ms 83.1 246.9 167.8 157.3 54.526
Deselect 100k rows ms 101.1 226.8 163.4 163.88 42.607

Generated by 🚫 dangerJS against f23900b

@joserodolfofreitas
Copy link
Member

joserodolfofreitas commented Jun 22, 2022

Nice! I like the interactive proposal on defining what to install
image

It touches a pain I felt yesterday. Perhaps we can consider updating the other installation pages as well (Not on this PR).

Copy link
Member

@flaviendelangle flaviendelangle left a comment

Choose a reason for hiding this comment

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

A lot better than today !

Partially verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
We cannot verify signatures from co-authors, and some of the co-authors attributed to this commit require their commits to be signed.

Partially verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
We cannot verify signatures from co-authors, and some of the co-authors attributed to this commit require their commits to be signed.
@oliviertassinari
Copy link
Member

The layout is a bit broken on mobile.

@oliviertassinari
Copy link
Member

oliviertassinari commented Jun 24, 2022

Fix #5290

Are we sure? I understood the issue as the user doesn't want to use moment. It also seems to about the lack of a live demo, e.g. with the Chinese calandar like in https://ant.design/components/date-picker-cn/

@alexfauquette
Copy link
Member Author

From the answer, I assume that adding explanations in the doc fix the pain of the user

@flaviendelangle, your explanation is exactly what I mean to be added to MUI docs.

Your explanation made it much clearer. You can even extend it. Now I have a better understanding of what should I search for.

Copy link
Member

@flaviendelangle flaviendelangle left a comment

Choose a reason for hiding this comment

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

We will be able to improve it later based on feedback, but it's already 100x better than the existing

@alexfauquette alexfauquette merged commit 65e9a94 into mui:master Jun 27, 2022
@alexfauquette alexfauquette deleted the update-getting-started branch June 27, 2022 15:35
@Nefcanto
Copy link

@alexfauquette, thank you so much.

I read the improved docs and now I can understand the architecture of date-time handling in MUI.

Still, a couple of demos would be great. But this is good enough.

Now everything is clear and thank you so much for this clarification.

@oliviertassinari
Copy link
Member

oliviertassinari commented Jun 28, 2022

@alexfauquette OK great.

@Nefcanto 👍 it could make sense to open a new GitHub issue about having a Chinese calendar demo. If we want to attract this audience, it would be a good opportunity to communicate them that we give it value, and to more easily test that it works as expected.

@Nefcanto
Copy link

@oliviertassinari it would be awesome. But I'm not from China. I'm from Iran.

However, I would gladly help. I can create the issue, but in English. And I would test them in my own applications.

Please let me know if I should open the issue or not.

joserodolfofreitas pushed a commit to joserodolfofreitas/mui-x that referenced this pull request Jul 15, 2022
alexfauquette added a commit to alexfauquette/mui-x that referenced this pull request Aug 26, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
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.

[pickers] Usage with various calendars (Hijri, Hebrew, Chinese, ...)
6 participants