-
-
Notifications
You must be signed in to change notification settings - Fork 32.3k
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] Duplicated pages for Base components in Material UI are outdated #35077
Comments
What do you think about having a very short description on each of these pages saying that this component is a part of MUI Base and it's documented there (and it's reexported from Material UI just for convenience)? |
@michaldudak In this case, would we remove all other content from the Material UI version of the page? I think this makes sense as a stop-gap measure on the way to deprecation in the future. |
Yes, I think this is my preferred option. |
Cool, I'm happy to move forward with that plan as long as @oliviertassinari doesn't have any objections. |
@michaldudak to be clear on this one. The idea was to remove these components from the left side nav on Material UI. The "redirection" is about the 301 that is necessary to add to not break SEO. So I believe that there won't be the confusion of a magic product change.
We discussed this option. My concern is about the experience when developers search on Google and with Algolia. They will need an extra click when they land on the "wrong" page but I agree it better educates developers.
No objections. I like that we could encourage to import from |
Alright, this sounds like the best course of action to me:
Does that work? |
The problem
The Material UI package contains some utility components that it shares in common with MUI Base.
These components are the exact same—they're imported directly from the Base package into Material UI with nothing added.
Am I missing any others?
Right now, the most up-to-date and comprehensive version of the docs on these duplicated components resides within MUI Base. Additionally, the Material UI versions don't offer much of an explanation regarding what these components are, what Base is, and how these components compare/contrast with their Base counterparts.
This presents a great opportunity to educate Material UI users about Base and encourage them to use the Base versions instead of the Material UI versions going forward.
The proposed solution
After talking it over with @oliviertassinari, we were leaning on:
cc @michaldudak I'd love to hear what you think about this. I think it's the best option to avoid duplicating this content on both sides.
The text was updated successfully, but these errors were encountered: