Skip to content

Commit

Permalink
Add callout about Pigment being in alpha
Browse files Browse the repository at this point in the history
  • Loading branch information
@aarongarciah
aarongarciah committed Sep 12, 2024
1 parent c1c0d7c commit 61d78fe
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/data/material/experimental-api/pigment-css/pigment-css.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

<p class="description">Learn how to get started customizing your components using Pigment CSS.</p>

:::warning
Pigment CSS is currently in the early alpha stage of development. We're actively working on improving its performance and stability. If you find any problem, please open a [Github issue](https://github.com/mui/pigment-css/issues).

Check warning on line 6 in docs/data/material/experimental-api/pigment-css/pigment-css.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/material/experimental-api/pigment-css/pigment-css.md", "range": {"start": {"line": 6, "column": 67}}}, "severity": "WARNING"}

Check failure on line 6 in docs/data/material/experimental-api/pigment-css/pigment-css.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[MUI.CorrectReferenceAllCases] Use 'GitHub' instead of 'Github'

Raw Output:
{"message": "[MUI.CorrectReferenceAllCases] Use 'GitHub' instead of 'Github'", "location": {"path": "docs/data/material/experimental-api/pigment-css/pigment-css.md", "range": {"start": {"line": 6, "column": 174}}}, "severity": "ERROR"}
:::

<iframe width="100%" height="400" src="https://www.youtube.com/embed/UVeDpUey5Es?si=w8OtdStXHtWWIODa" title="YouTube video player: Getting Started with Pigment CSS" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

[Pigment CSS](https://github.com/mui/pigment-css) is a zero-runtime CSS-in-JS library that pre-compiles at build time, making it compatible with React Server Components and providing you with significant performance improvements over other styling engines.
Expand Down
4 changes: 4 additions & 0 deletions docs/data/material/migration/upgrade-to-v6/migrating-to-pigment-css.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

<p class="description">This guide helps you integrate Pigment CSS with Material UI v6.</p>

:::warning
Pigment CSS is currently in the early alpha stage of development. We're actively working on improving its performance and stability. If you find any problem, please open a [Github issue](https://github.com/mui/pigment-css/issues).

Check warning on line 6 in docs/data/material/migration/upgrade-to-v6/migrating-to-pigment-css.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/material/migration/upgrade-to-v6/migrating-to-pigment-css.md", "range": {"start": {"line": 6, "column": 67}}}, "severity": "WARNING"}

Check failure on line 6 in docs/data/material/migration/upgrade-to-v6/migrating-to-pigment-css.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[MUI.CorrectReferenceAllCases] Use 'GitHub' instead of 'Github'

Raw Output:
{"message": "[MUI.CorrectReferenceAllCases] Use 'GitHub' instead of 'Github'", "location": {"path": "docs/data/material/migration/upgrade-to-v6/migrating-to-pigment-css.md", "range": {"start": {"line": 6, "column": 174}}}, "severity": "ERROR"}
:::

Before going through this guide, make sure you have [upgraded to Material UI v6](/material-ui/migration/upgrade-to-v6/).

## Introduction
Expand Down

0 comments on commit 61d78fe

Please sign in to comment.