-
Notifications
You must be signed in to change notification settings - Fork 832
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] Improve English and fix 404 link #1815
Conversation
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/mui-org/material-ui-pickers/200r3km80 |
Test summaryRun details
View run in Cypress Dashboard ➡️ This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard |
Co-authored-by: Dmitriy Kovalenko <dmtr.kovalenko@outlook.com>
I think we should mention not only ‘minTime’ and |
Co-authored-by: Dmitriy Kovalenko <dmtr.kovalenko@outlook.com>
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.
I have updated the markdown to fix the 404 links as well as uniformize the generated markdown between the components. A couple of thoughts:
- I wonder what should be our strategy to document the Mobile, Desktop, and Static variants of the components? I wouldn't be against a standalone component file, e.g.
MobileDatePicker.js
and API page. - The heading structure of the docs is wrong. The h1 > h2 > h3 structure should be continuous (for a11y). For instance, there is no h1, it starts (❌) from h2, then there is no h3, to jumps (❌) to h4. This gave me a new item idea to list into [DatePicker] Misc TODO material-ui#20960: the accessibility of the docs. A report by the Chrome Wave extension:
- There are a couple of UI jumps between the SSR rendered and hydrated versions of the components, I'm surprised nobody reported it yet (I guess people use it for client-side only dashboard, not e-commerce much). I think that it will come with more usage, happy to be lazy and wait.
Answering:
|
Yeah, I guess it's a much smaller segment of the market 😆. |
This PR hopefully closes #1814 partially.