[docs-infra] Improve access to the component demos via the API page #39690
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
danilo-leal
added
design
Netlify deploy previewhttps://deploy-preview-39690--material-ui.netlify.app/ Bundle size report |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There has been more than one docs-feedback entry (here's an example of a recent one) in varying component API pages, requesting something like "I want to see demos, not just a list of props" as if we didn't provide the usual demo pages. So, this points out how we can call more attention to the "Demos" heading on the top of the API page to, hopefully, improve access to them.
To do that, on this PR, I'm wrapping in a success alert the content that was sitting under the "Demos" heading, as well as changing its title to be even more apparent (and slightly redundant, possibly).
馃憠 https://deploy-preview-39690--material-ui.netlify.app/joy-ui/api/accordion-summary/#demos