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] Direct users from Material UI to MUI Base for duplicated components #35293

Merged
merged 14 commits into from Dec 6, 2022

Conversation

samuelsycamore
Copy link
Member

@samuelsycamore samuelsycamore commented Nov 29, 2022

Closes #35077 (at least until these components are removed from Material UI in the future)

This PR addresses the issue of outdated pages in the Material UI docs that cover components that are exact duplicates from MUI Base:

  • Click-Away Listener
  • No-SSR
  • Portal
  • Textarea Autosize

I have deleted the content from the Material UI pages, and replaced it with an info callout directing users to the MUI Base docs:

Screen Shot 2022-12-05 at 10 08 41 AM

https://deploy-preview-35293--material-ui.netlify.app/material-ui/react-click-away-listener/

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

mui-bot commented Nov 29, 2022

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

No bundle size changes

Generated by 🚫 dangerJS against bff31fc

@samuelsycamore samuelsycamore merged commit 22e6dc2 into mui:master Dec 6, 2022
feliperli pushed a commit to jesrodri/material-ui that referenced this pull request Dec 6, 2022
…nents (mui#35293)

Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>
@oliviertassinari
Copy link
Member

oliviertassinari commented Dec 7, 2022

@samuelsycamore As a continuation of #35293 (comment), when I land on https://deploy-preview-35293--material-ui.netlify.app/material-ui/react-click-away-listener/ as a developer, I might struggle a bit to:

  1. Find the new docs. I didn't really read the content. I skipped read. I intuitively clicked on the first link thinking it would be MUI Base ClickAwayListener page. Should we have the first link to point to the most relevant page?
  2. Find what's the stable import path. We do no longer document explicitly, to consider if it's fine.

@samuelsycamore
Copy link
Member Author

samuelsycamore commented Dec 7, 2022

Those are both good points @oliviertassinari. I can rearrange the text a bit so that the first link goes to the component page. As for 2, should we provide the Material UI import or the MUI Base import on this page? It does make sense to give the Material UI import here since we're saying it's re-exported for convenience, but then again it feels a bit odd to give this import while at the same time informing users that it's going to be deprecated. I guess the Material UI import is preferable for now, until MUI Base gets a stable release.

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: material-ui Specific to @mui/material
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Duplicated pages for Base components in Material UI are outdated
4 participants