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] Clarify what Controlled / Uncontrolled means #8926
Conversation
Netlify deploy previewNetlify deploy preview: https://deploy-preview-8926--material-ui-x.netlify.app/ Updated pages
These are the results for the performance tests:
|
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.
What do you think about including a sentence or two summarizing the React docs here? It would be nice if the reader didn't have to leave this page to at least get a basic idea of what this means. |
@samuelsycamore if we make the note longer, would you put in on top or under the demo? |
I think it makes sense to keep it where it is: the concept gets introduced in the main text, and then elaborated on in the callout. Feels like a natural flow. I can imagine being frustrated if I didn't know these concepts and didn't immediately see the explanation (if it was below the demo). |
52ec149
to
32dda91
Compare
@samuelsycamore I added a small description |
That's a great description @flaviendelangle! Maybe it should even go directly in the body text rather than in a callout? Either way, we should definitely run with this text throughout the rest of the docs. |
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 Info Callout LGTM!
I saw that @samuelsycamore has given the sign-off but I would recommend for one more review as I am still fairly new :)
I like the callout, because I still think most people know what controlled / uncontrolled mean, so putting it outside of the main flows avoids bothering them with something "useless". |
I'm trying to improve the understanding of this section for people doing the following feedback:
I will apply the same change on all the other pages once we'll have decided on a wording
https://deploy-preview-8926--material-ui-x.netlify.app/x/react-date-pickers/date-picker/#uncontrolled-vs-controlled-value