-
-
Notifications
You must be signed in to change notification settings - Fork 32.5k
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] Move the demo higher in the API TOC #35202
[docs] Move the demo higher in the API TOC #35202
Conversation
|
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.
👍
One of the ideas we had when discussing the issue was to add an explanation. Hopping it helps people who land on this page discover the structure of the docs. Especially the "Components" section. Here is the text proposed in the issue:
|
@alexfauquette Ok, I have updated the description.
|
Would it make more sense for this section to be a callout? It feels kind of weird to be the first section of the page, but not really a part of the page's flow. I think it should be somewhat eye-catching, since the purpose is to quickly redirect users who've landed on the wrong page. |
Co-authored-by: Sam Sycamore <[email protected]> Signed-off-by: Olivier Tassinari <[email protected]>
@samuelsycamore A callout would make the information more likely to be seen by a developer. IMHO, we don't need to go there yet. We already give it more visibility by moving it to the top and the least amount of visibility we can get away with, the better. |
Signed-off-by: Olivier Tassinari <[email protected]> Co-authored-by: Sam Sycamore <[email protected]>
It might solve these feedback:
https://mui-org.slack.com/archives/C041SDSF32L/p1668804057511509
When I'm landing on the API page, I usually have to scroll to the bottom of the page to then go to the demo (it happens to me quite often). Maybe this is a better UX https://deploy-preview-35202--material-ui.netlify.app/material-ui/api/alert/. I have made sure that searching for "example" yield a result too on the page.
Close #35004