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.

Sign up for GitHub

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

Jump to bottom

[docs] Update the Material UI readme post-v6 #43504

Merged
merged 9 commits into from
Sep 6, 2024
Merged

[docs] Update the Material UI readme post-v6 #43504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
01f57cd
hard reset
samuelsycamore Aug 29, 2024
d344719
specify react
samuelsycamore Aug 29, 2024
3d24eff
soft line breaks
samuelsycamore Sep 2, 2024
d3489c6
fix broken support link
samuelsycamore Sep 2, 2024
68ed90e
security copy and unnecessary line break
samuelsycamore Sep 2, 2024
0582d40
update joy ui getting started
samuelsycamore Sep 2, 2024
c1f1198
say more about material ui
samuelsycamore Sep 2, 2024
465b3d3
rearrange headers
samuelsycamore Sep 2, 2024
deefa74
nbsp
samuelsycamore Sep 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,6 @@

<h1 align="center">Material UI</h1>

**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.

<div align="center">

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mui/material-ui/blob/HEAD/LICENSE)
Expand All @@ -27,30 +21,37 @@

</div>

## 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.

Check warning on line 24 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.We] Try to avoid using first-person plural like 'our'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "README.md", "range": {"start": {"line": 24, "column": 106}}}, "severity": "WARNING"}
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/).

<details>
<summary>Older versions</summary>

- **[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/))

</details>

**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.

Check warning on line 48 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.We] Try to avoid using first-person plural like 'our'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'our'.", "location": {"path": "README.md", "range": {"start": {"line": 48, "column": 89}}}, "severity": "WARNING"}
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.

Check warning on line 50 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.We] Try to avoid using first-person plural like 'we'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "README.md", "range": {"start": {"line": 50, "column": 43}}}, "severity": "WARNING"}

Check warning on line 50 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.We] Try to avoid using first-person plural like 'we'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "README.md", "range": {"start": {"line": 50, "column": 88}}}, "severity": "WARNING"}

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/).
samuelsycamore marked this conversation as resolved.
Show resolved Hide resolved

## Sponsors

Expand Down Expand Up @@ -102,7 +103,7 @@
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

Expand All @@ -114,12 +115,11 @@

## 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

Expand Down
4 changes: 2 additions & 2 deletions docs/data/joy/getting-started/overview/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading