-
-
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] Standardize the usage of callouts in the MUI Core docs #35361
[docs] Standardize the usage of callouts in the MUI Core docs #35361
Conversation
|
@samuelsycamore It sounds great, we can later implement them in a systematic fashion based on the design direction that we would like to them to look like 👍
|
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.
Looking great 🙌 Thanks for setting up the experiments page too, though ⎯ I have a branch open for doing some design tweaks to the callouts and that will be useful. Hoping we do add some icons "natively" later on, as suggested above, to drive more attention and to differentiate them a bit on the UI (a container with text only feels a bit empty). cc @siriwatknp
This PR is part of the ongoing effort to standardize the style and formatting of the MUI docs.
The purpose here is to enforce consistent usage of the four types of callouts, based on the rules set forth in the doc I've created in the Company Handbook.
Additionally, I've removed all signifiers (⚠️ , 💡, Note:, Tip:, etc.) within the callouts, which are redundant now that we have different types.
I've also made some tiny grammar and style changes in and around the callouts where I noticed them, but tried to limit the scope of this PR by not actively editing the content.
If/when we're in agreement about the implementation of the style rules here, I'll perform this same audit for the X and Toolpad docs.
https://deploy-preview-35361--material-ui.netlify.app/experiments/docs/callouts/