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 "Unstyled" sections to point to new Base UI package #44910

Open
samuelsycamore opened this issue Jan 1, 2025 · 3 comments
Open
Assignees
Labels
docs Improvements or additions to the documentation package: base-ui Specific to @mui/base priority: important This change can make a difference

Comments

@samuelsycamore
Copy link
Contributor

samuelsycamore commented Jan 1, 2025

Related page

https://mui.com/material-ui/react-select/#unstyled

Kind of issue

Other

Issue description

Material UI components with Base UI equivalents have an "Unstyled" section in their component docs to direct users to the latter if they need them. With mui/base-ui now replacing the older legacy package in the material-ui repo, these links and descriptions should be updated to point to the new library.

The only question is when to do it. ASAP? Or should it coincide with a later milestone for Base UI—beta or stable release?

Search keywords: unstyled, base ui, docs

@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page labels Jan 1, 2025
@samuelsycamore samuelsycamore self-assigned this Jan 1, 2025
@oliviertassinari oliviertassinari added package: base-ui Specific to @mui/base and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page labels Jan 1, 2025
@oliviertassinari
Copy link
Member

oliviertassinari commented Jan 1, 2025

The only question is when to do it. ASAP? Or should it coincide with a later milestone for Base UI—beta or stable release?

It feels like ASAP. Reasoning:

  • We link to a legacy version. We can't have this. Either we remove all links or we link to the most up-to-date version.
  • If we remove all links, won't we undeserve users? The ones that want more customization freedom?
  • If we link the new Base UI, we will get users coming and reporting issues, and experiencing what might not be amazing, yet. But it seems still better than going with linking nothing or linking the old Base UI.

@oliviertassinari oliviertassinari added the priority: important This change can make a difference label Jan 1, 2025
@samuelsycamore
Copy link
Contributor Author

It feels like ASAP.

That's my thought as well. cc @colmtuite in case you have any thoughts or preferences about when to move forward with this.

@oliviertassinari
Copy link
Member

oliviertassinari commented Jan 1, 2025

Per https://mui-org.slack.com/archives/C02P87NQLJC/p1734608624843609, I think that we could turn this issue into an umbrella issue. Current steps we see:

  • 1. Update our repo social preview: https://github.com/mui/base-ui/settings
  • 4. Change any remaining "Base UI" text or anchor text to "MUI Base". Helping the branding messaging to talk about the two different versions. This seems the simplest, by following the npm names.
  • 5. Add a deprecation warning to every page of https://mui.com/base-ui/*. Link to the new component's page.
  • 3. Delete all links from mui.com/* pointing to https://mui.com/base-ui/*
  • 2. Delete https://mui.com/base-ui/, the marketing page. Instead, add a 301 to link the page to https://base-ui.com/.
  • 7. Email our mailing list announcing the launch of Base UI, explaining the @mui/base deprecation, and encouraging migration.
  • 6. Deprecate the @mui/base npm package. Use the blog post of 7. for people who wants to learn more.

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 priority: important This change can make a difference
Projects
None yet
Development

No branches or pull requests

2 participants