@@ -29,28 +25,28 @@
## Documentation
-### Material UI
-
-Visit [https://mui.com/material-ui/](https://mui.com/material-ui/) to view the full documentation.
+Get started in the [Material UI documentation](https://mui.com/material-ui/getting-started/).
-**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
From d344719caa49a87a707ad0f407a395d6665dd3e7 Mon Sep 17 00:00:00 2001
From: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Date: Thu, 29 Aug 2024 09:50:09 -0600
Subject: [PATCH 2/9] specify react
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 28707220a51ae0..4228bb57b8c97b 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
-[Material UI](https://mui.com/material-ui/) is a comprehensive library of components that features our independent implementation of Google's [Material Design](https://m2.material.io/design/introduction/) system.
+[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.
From 3d24eff5ab3fbc0b8163bb2449238a4d3c87504f Mon Sep 17 00:00:00 2001
From: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Date: Mon, 2 Sep 2024 08:11:31 -0700
Subject: [PATCH 3/9] soft line breaks
---
README.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 4228bb57b8c97b..d796c6503c12b6 100644
--- a/README.md
+++ b/README.md
@@ -42,7 +42,9 @@ Use `@latest` for the latest stable release.
## 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.
+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.
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.
From d3489c64cc029e691e7d7e2826c7e8b1c9a2913f Mon Sep 17 00:00:00 2001
From: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Date: Mon, 2 Sep 2024 08:12:00 -0700
Subject: [PATCH 4/9] fix broken support link
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index d796c6503c12b6..bb754cc9512b6b 100644
--- a/README.md
+++ b/README.md
@@ -100,7 +100,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
From 68ed90e92f9b11558fcf861ee776a7b5ddf144d4 Mon Sep 17 00:00:00 2001
From: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Date: Mon, 2 Sep 2024 08:13:33 -0700
Subject: [PATCH 5/9] security copy and unnecessary line break
---
README.md | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index bb754cc9512b6b..7c3ac3d9babb59 100644
--- a/README.md
+++ b/README.md
@@ -112,12 +112,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
From 0582d40174a7a0ef735b1b470f9caa048fcd0269 Mon Sep 17 00:00:00 2001
From: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Date: Mon, 2 Sep 2024 08:17:20 -0700
Subject: [PATCH 6/9] update joy ui getting started
---
README.md | 4 ++--
docs/data/joy/getting-started/overview/overview.md | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 7c3ac3d9babb59..32e30fbded1623 100644
--- a/README.md
+++ b/README.md
@@ -42,8 +42,8 @@ Use `@latest` for the latest stable release.
## 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_.
+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.
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.
diff --git a/docs/data/joy/getting-started/overview/overview.md b/docs/data/joy/getting-started/overview/overview.md
index 63c8ae851e43c1..0e20a996217e1a 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
From c1f119874f0535e2723b82613882a7756b7b841d Mon Sep 17 00:00:00 2001
From: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Date: Mon, 2 Sep 2024 08:49:49 -0700
Subject: [PATCH 7/9] say more about material ui
---
README.md | 3 +++
docs/data/joy/getting-started/overview/overview.md | 4 ++--
2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 32e30fbded1623..c91613a402efe5 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,9 @@
Material UI
[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's core functionality is extended by [MUI X](https://github.com/mui/mui-x), a suite of complex components for advanced use cases.
diff --git a/docs/data/joy/getting-started/overview/overview.md b/docs/data/joy/getting-started/overview/overview.md
index 0e20a996217e1a..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 is in beta and _development is currently on hold_.
+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.
-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.
+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
From 465b3d346b32d9fe8e0ec35b60ef315bac0bd4ec Mon Sep 17 00:00:00 2001
From: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Date: Mon, 2 Sep 2024 08:51:49 -0700
Subject: [PATCH 8/9] rearrange headers
---
README.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index c91613a402efe5..e7affe5fcdb8f2 100644
--- a/README.md
+++ b/README.md
@@ -5,11 +5,6 @@
Material UI
-[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's core functionality is extended by [MUI X](https://github.com/mui/mui-x), a suite of complex components for advanced use cases.
-
[](https://github.com/mui/material-ui/blob/HEAD/LICENSE)
@@ -26,6 +21,11 @@ Material UI's core functionality is extended by [MUI X](https://github.com/mui/
+[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's core functionality is extended by [MUI X](https://github.com/mui/mui-x), a suite of complex components for advanced use cases.
+
## Documentation
Get started in the [Material UI documentation](https://mui.com/material-ui/getting-started/).
From deefa74b4f535ee6ce234155666ee6e8fff2118d Mon Sep 17 00:00:00 2001
From: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Date: Mon, 2 Sep 2024 09:23:35 -0700
Subject: [PATCH 9/9] nbsp
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index e7affe5fcdb8f2..36538eb2b0f0bc 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@
[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's core functionality is extended by [MUI X](https://github.com/mui/mui-x), a suite of complex components for advanced use cases.
+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.
## Documentation