From a25b030c92679dfd34b280a69c3204a0913db3cb Mon Sep 17 00:00:00 2001 From: Sycamore <71297412+samuelsycamore@users.noreply.github.com> Date: Fri, 6 Sep 2024 16:06:28 -0400 Subject: [PATCH] [docs] Update the Material UI readme post-v6 (#43504) --- README.md | 42 +++++++++---------- .../joy/getting-started/overview/overview.md | 4 +- 2 files changed, 23 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 3c122d4cebe02e..41bbdd7cc4dd8e 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,6 @@

Material UI

-**Material UI** contains foundational React UI component libraries for shipping new features faster: - -- [Material UI](https://mui.com/material-ui/) is a comprehensive library of components that features our implementation of Google's [Material Design](https://m2.material.io/design/introduction/) system. - -- [Joy UI](https://mui.com/joy-ui/getting-started/) is a library of beautifully designed React UI components built to spark joy. -
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mui/material-ui/blob/HEAD/LICENSE) @@ -27,30 +21,37 @@
-## Documentation +[Material UI](https://mui.com/material-ui/) is a comprehensive library of React components that features our independent implementation of Google's [Material Design](https://m2.material.io/design/introduction/) system. +It's trusted by some of the world's greatest product teams because it's been rigorously battle-tested through more than a decade of development by thousands of open-source contributors. -### Material UI +Material UI's core functionality is extended by [MUI X](https://github.com/mui/mui-x), a suite of complex components for advanced use cases. -Visit [https://mui.com/material-ui/](https://mui.com/material-ui/) to view the full documentation. +## Documentation + +Get started in the [Material UI documentation](https://mui.com/material-ui/getting-started/).
Older versions -- **[v4.x](https://v4.mui.com/)** ([Migration from v4 to v5](https://mui.com/material-ui/migration/migration-v4/)) -- **[v3.x](https://v3.mui.com/)** ([Migration from v3 to v4](https://mui.com/material-ui/migration/migration-v3/)) -- **[v0.x](https://v0.mui.com/)** ([Migration to v1](https://mui.com/material-ui/migration/migration-v0x/)) +- **[v5.x](https://v5.mui.com/)** ([Upgrading from v5 to v6](https://mui.com/material-ui/migration/upgrade-to-v6/)) +- **[v4.x](https://v4.mui.com/)** ([Upgrading from v4 to v5](https://mui.com/material-ui/migration/migration-v4/)) +- **[v3.x](https://v3.mui.com/)** ([Upgrading from v3 to v4](https://mui.com/material-ui/migration/migration-v3/)) +- **[v0.x](https://v0.mui.com/)** ([Upgrading to v1](https://mui.com/material-ui/migration/migration-v0x/))
-**Note:** `@next` only points to pre-releases. +**Note:** `@next` points to pre-releases. Use `@latest` for the latest stable release. -### Joy UI +## Joy UI + +This repository also contains Joy UI, an experimental component library that implements our own in-house Joy Design. +Joy UI is in beta and _development is currently on hold_. +When starting a new project from scratch, we recommend Material UI over Joy UI because we can guarantee ongoing support. -Visit [https://mui.com/joy-ui/getting-started/](https://mui.com/joy-ui/getting-started/) to view the full documentation. +You're welcome to open new issues and PRs to help improve Joy UI, but please keep in mind that the maintainers are primarily focused on other projects and may not be able to respond in a timely manner. -**Note**: Joy UI is still in beta. -We are adding new components regularly and you're welcome to contribute! +View the [Joy UI documentation](https://mui.com/joy-ui/getting-started/). ## Sponsors @@ -108,7 +109,7 @@ You can find complete templates and themes in the [MUI Store](https://mui.com/s Read the [contributing guide](/CONTRIBUTING.md) to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes. Contributing is about more than just issues and pull requests! -There are many other ways to [support Material UI](https://mui.com/material-ui/getting-started/faq/#mui-is-awesome-how-can-i-support-the-project) beyond contributing to the code base. +There are many other ways to [support Material UI](https://mui.com/material-ui/getting-started/faq/#mui-is-an-awesome-organization-how-can-i-support-it) beyond contributing to the code base. ## Changelog @@ -120,12 +121,11 @@ Future plans and high-priority features and enhancements can be found in the [ro ## License -This project is licensed under the terms of the -[MIT license](/LICENSE). +This project is licensed under the terms of the [MIT license](/LICENSE). ## Security -For details of supported versions and contact details for reporting security issues, please refer to the [security policy](https://github.com/mui/material-ui/security/policy). +For details on supported versions and contact information for reporting security issues, please refer to the [security policy](https://github.com/mui/material-ui/security/policy). ## Sponsoring services diff --git a/docs/data/joy/getting-started/overview/overview.md b/docs/data/joy/getting-started/overview/overview.md index 63c8ae851e43c1..59e1d0a92102b3 100644 --- a/docs/data/joy/getting-started/overview/overview.md +++ b/docs/data/joy/getting-started/overview/overview.md @@ -11,10 +11,10 @@ title: Overview Joy UI is an open-source React component library that follows a lightly opinionated design direction, for a clean and modern UI that gives you plenty of room to customize the look and feel. :::warning -Joy UI development is temporarily on hold as the maintainers focus on the next two major releases of Material UI. +Joy UI is in beta and _development is currently on hold_. Read [this blog post](/blog/2023-material-ui-v6-and-beyond/) to learn more. -However, you're welcome to look for the [`package: joy-ui`](https://github.com/mui/material-ui/labels/package%3A%20joy-ui) label on open issues and pull requests in the `mui/material-ui` GitHub repository to see what other community members are working on, and submit your own. +You're welcome to open new issues and PRs to help improve Joy UI, but please keep in mind that the maintainers are primarily focused on other projects and may not be able to respond in a timely manner. ::: ## Why use Joy UI