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][joy-ui] Update Overview copy to match Readme #44136

Merged
merged 3 commits into from
Oct 17, 2024
Merged

[docs][joy-ui] Update Overview copy to match Readme #44136

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8cc4cea
update copy
samuelsycamore Oct 17, 2024
0f4389d
ci: run (empty commit)
samuelsycamore Oct 17, 2024
3223dab
nbsps
samuelsycamore Oct 17, 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
6 changes: 3 additions & 3 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 @@ -4,17 +4,17 @@

# Joy UI - Overview

<p class="description">Joy UI is an open-source React component library that implements MUI's own design principles. It's comprehensive and can be used in production out of the box.</p>
<p class="description">Joy UI is an open-source React component library that implements MUI's own design principles.</p>

## Introduction

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_.
Read [this blog post](/blog/2023-material-ui-v6-and-beyond/) to learn more.
When starting a new project from scratch, we recommend Material UI over Joy UI because we can guarantee ongoing support.

Check warning on line 15 in docs/data/joy/getting-started/overview/overview.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": "docs/data/joy/getting-started/overview/overview.md", "range": {"start": {"line": 15, "column": 43}}}, "severity": "WARNING"}

Check failure on line 15 in docs/data/joy/getting-started/overview/overview.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[MUI.MuiBrandName] Use a non-breaking space (option+space on Mac, Alt+0160 on Windows or AltGr+Space on Linux, instead of space) for brand name ('Material UI' instead of 'Material UI')

Raw Output:
{"message": "[MUI.MuiBrandName] Use a non-breaking space (option+space on Mac, Alt+0160 on Windows or AltGr+Space on Linux, instead of space) for brand name ('Material UI' instead of 'Material UI')", "location": {"path": "docs/data/joy/getting-started/overview/overview.md", "range": {"start": {"line": 15, "column": 56}}}, "severity": "ERROR"}

Check warning on line 15 in docs/data/joy/getting-started/overview/overview.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": "docs/data/joy/getting-started/overview/overview.md", "range": {"start": {"line": 15, "column": 88}}}, "severity": "WARNING"}

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.
Keep in mind that the maintainers are primarily focused on other projects and may not be able to respond in a timely manner to issues or pull requests related to Joy UI.
:::

## Why use Joy UI
Expand Down
Loading