[docs] Improve the autogenerated "Unstyled" and "API" text #35185
Conversation
|
| @@ -414,14 +414,18 @@ function prepareMarkdown(config) { | |||
| contents.push(` | |||
| ## Unstyled | |||
|
|
|||
| The component also comes with an [unstyled version](${headers.unstyled}). It's ideal for doing heavy customizations and minimizing bundle size. | |||
| :::success | |||
There was a problem hiding this comment.
it's unclear to me that it should be an alert. I think that the least often we use callouts, the more they mean something. But why not
There was a problem hiding this comment.
I don't have a strong feeling about it either way. The reasoning was that we've started to use the :::success callout as a way to alert the reader about helpful hints or useful patterns/practices, and I felt that the info here fits that description. I also like that it draws more attention to the existence of Base (for educational/awareness purposes). But I think it would be fine without the callout, too.
samuelsycamore
requested review from
danilo-leal,
michaldudak and
siriwatknp
|
Let's keep the callout for now. If we decide it's too annoying or distracting we can always remove it later. |
|
Regarding the callout type. Why use a success type? Should it be more of an info callout? https://master--material-ui.netlify.app/experiments/docs/callouts/ |
This PR updates the copy for the "Unstyled" and "API" sections of the docs pages. I always felt that the earlier version of the "Unstyled" text lacked clarity and context, and that the "API" section could use a description to explain what's on the other side of the links.
Before:
After:
https://deploy-preview-35185--material-ui.netlify.app/material-ui/react-select/#unstyled