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.

Sign up for GitHub

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

Jump to bottom

[docs] Clarify where to find docs for MUI Base components in Material UI #35799

Merged
merged 4 commits into from
Jan 16, 2023
Merged

[docs] Clarify where to find docs for MUI Base components in Material UI #35799

merged 4 commits into from
Jan 16, 2023

Conversation

samuelsycamore
Copy link
Member

@samuelsycamore samuelsycamore commented Jan 11, 2023 •
edited by oliviertassinari
Loading

https://deploy-preview-35799--material-ui.netlify.app/material-ui/react-portal/

Iterating on doc feedback following #35293, part of #35077.

We received feedback from a user that suggested that they did not understand where to find demos for the MUI Base components that are re-exported in Material UI.

This PR attempts to make things more clear and obvious by:

  • changing the headline on these pages from MUI Base to This document has moved
  • bumping up the callout severity from info to warning so it's more eye-catching
  • moving the most important link—the corresponding MUI Base doc—to the top of the callout

Before:
Screen Shot 2023-01-11 at 12 56 06 PM

After:
Screen Shot 2023-01-11 at 12 56 37 PM

@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation package: material-ui Specific to @mui/material package: base-ui Specific to @mui/base labels Jan 11, 2023
@mui-bot
Copy link

mui-bot commented Jan 11, 2023 •
edited
Loading

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

No bundle size changes

Generated by 🚫 dangerJS against 8100513

oliviertassinari
oliviertassinari reviewed Jan 14, 2023
View reviewed changes
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.

It's much clearer for me 👍

michaldudak
michaldudak approved these changes Jan 16, 2023
View reviewed changes
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.

👍

@mnajdova mnajdova merged commit 3d2c89b into mui:master Jan 16, 2023
@samuelsycamore samuelsycamore deleted the update-material-base-docs branch April 3, 2024 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oliviertassinari oliviertassinari oliviertassinari left review comments

@mnajdova mnajdova mnajdova approved these changes

@michaldudak michaldudak michaldudak approved these changes

Assignees
No one assigned
Labels
docs Improvements or additions to the documentation package: base-ui Specific to @mui/base package: material-ui Specific to @mui/material
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@samuelsycamore @mui-bot @oliviertassinari @mnajdova @michaldudak