Skip to content
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] Update MUI Base docs with latest style conventions #35034

Merged
merged 21 commits into from Nov 28, 2022

Conversation

samuelsycamore
Copy link
Member

@samuelsycamore samuelsycamore commented Nov 7, 2022

This PR updates the MUI Base docs to reflect our latest changes to the style conventions for writing about MUI components.

Most changes involve replacing BackTickStyle names with unformatted Title Case Names:

  • ButtonUnstyled –> Unstyled Button

One notable exception is the Tabs page, which gets confusing unless you refer to the components specifically. In this case, I applied full React component formatting:

  • TabsUnstyled –> <TabsUnstyled />

@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation package: base-ui Specific to @mui/base labels Nov 7, 2022
@mui-bot
Copy link

mui-bot commented Nov 7, 2022

Messages
📖 Netlify deploy preview: https://deploy-preview-35034--material-ui.netlify.app/

No bundle size changes

Generated by 🚫 dangerJS against d4a2540

@samuelsycamore samuelsycamore marked this pull request as ready for review November 7, 2022 16:56
Copy link
Member

@oliviertassinari oliviertassinari left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fair 👍

Copy link
Member

@michaldudak michaldudak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@samuelsycamore samuelsycamore merged commit 35c57de into mui:master Nov 28, 2022
daniel-rabe pushed a commit to daniel-rabe/material-ui that referenced this pull request Nov 29, 2022
feliperli pushed a commit to jesrodri/material-ui that referenced this pull request Dec 6, 2022
@samuelsycamore samuelsycamore deleted the update-base branch April 3, 2024 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation package: base-ui Specific to @mui/base
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants