[docs] Correctly configure Vale

mui · Sep 18, 2024 · e92a280 · e92a280
1 parent fd79e6b
commit e92a280
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 13 deletions.
diff --git a/.github/workflows/vale-action.yml b/.github/workflows/vale-action.yml
@@ -12,10 +12,14 @@ jobs:
       contents: read
       pull-requests: write
     steps:
-      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
       - uses: errata-ai/vale-action@38bf078c328061f59879b347ca344a718a736018 # v2.1.0
         continue-on-error: true # GitHub Action flag needed until https://github.com/errata-ai/vale-action/issues/89 is fixed
         with:
+          # Errors should be more visible
           fail_on_error: true
+          # The other reports don't work, not really https://github.com/reviewdog/reviewdog#reporters
           reporter: github-pr-check
+          # Required, set by GitHub actions automatically:
+          # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
           token: ${{secrets.GITHUB_TOKEN}}
diff --git a/.vale.ini b/.vale.ini
@@ -2,8 +2,12 @@
 StylesPath = .github/styles
 MinAlertLevel = warning
 
-# The docs/mui-vale.zip is generated by `pnpm docs:zipRules`
-Packages = Google, docs/mui-vale.zip
+# To update mui-vale package:
+# 1. Go to the docs folder in the material-ui repo
+# 2. Update/create YAML files
+# 3. Run `pnpm docs:zipRules` to generate the zip files
+# 4. You can test locally by replacing the url with the file path of the generated zip
+Packages = Google, https://github.com/mui/material-ui/raw/HEAD/docs/mui-vale.zip
 
 [*.md]
 # Ignore code injections that start with {{...
@@ -19,5 +23,5 @@ Google.We = YES # Avoid first-person plural
 Google.Will = YES # Avoid future tense
 Google.OxfordComma = YES # Prefer Oxford comma
 
-[*CHANGELOG*.md]
+[CHANGELOG*.md]
 MUI.CorrectReferenceAllCases = NO
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -43,11 +43,11 @@ A big thanks to the 2 contributors who made this release possible.
 
 ### Docs
 
-- [docs] Fix Stack Overflow issue canned response @oliviertassinari
+- [docs] Fix Stack Overflow issue canned response @oliviertassinari
 - [docs] Fix outdated link to support page @oliviertassinari
 - [docs] Keep contributing guide simple (#213) @oliviertassinari
 - [docs] Fix description of eslint-plugin-material-ui @oliviertassinari
-- [docs] Hide a bit the notion of MUI Core @oliviertassinari
+- [docs] Hide a bit the notion of MUI Core @oliviertassinari
 
 All contributors of this release in alphabetical order: @oliviertassinari, @siriwatknp
 
@@ -82,7 +82,7 @@ A big thanks to the 3 contributors who made this release possible.
 
 ### Core
 
-- &#8203;<!-- 7 -->[core] Temporarily fallback to v5 of Material UI (#198) @brijeshb42
+- &#8203;<!-- 7 -->[core] Temporarily fallback to v5 of Material UI (#198) @brijeshb42
 - &#8203;<!-- 5 -->[core] Fix event naming convention @oliviertassinari
 
 All contributors of this release in alphabetical order: @brijeshb42, @oliviertassinari, @siriwatknp
@@ -222,17 +222,17 @@ A big thanks to the 6 contributors who made this release possible. Here are some
 
 ### `@pigment-css/[email protected]`
 
-- Add `createExtendSxProp` for Material UI integration (#112) @siriwatknp
+- Add `createExtendSxProp` for Material UI integration (#112) @siriwatknp
 - Add `globalCss` processor (#31) @siriwatknp
 - Implement useTheme processor and runtime theme (#105) @brijeshb42
 - Implement variant matching parity (#111) @DiegoAndai
 - Ignore urls starting with # (#106) @brijeshb42
-- Make theme optional in Pigment CSS config (#108) @brijeshb42
+- Make theme optional in Pigment CSS config (#108) @brijeshb42
 
 ### Docs
 
 - Add logo to the README (#121) @danilo-leal
-- Add badges like in Material UI @oliviertassinari
+- Add badges like in Material UI @oliviertassinari
 - Fix styleOverrides usage in README (#110) @brijeshb42
 - Improve wording (#70) @aarongarciah
 - Fix roadmap link (#60) @oliviertassinari
@@ -323,7 +323,7 @@ Starting with this release, all packages are going to be released under the `lat
 
 ### Docs
 
-- [react] Add How Pigment CSS works guide (#18) @brijeshb42
+- [react] Add How Pigment CSS works guide (#18) @brijeshb42
 - Update creating a new issue link (#20) @ZeeshanTamboli
 - Fix wrong header hash in the README.md (#26) @mnajdova
 

diff --git a/README.md b/README.md
@@ -514,7 +514,7 @@ globalCss`
 `;
 ```
 
-The `globalCss` function should to be called at the top level of your javascript file, usually from the entry point of the application.
+The `globalCss` function should to be called at the top level of your JavaScript file, usually from the entry point of the application.
 
 Calling inside a function or a component will not work as expected. Also, the extraction of global styles will always take place regardless of conditional rendering.
 
@@ -725,7 +725,7 @@ declare module '@pigment-css/react/theme' {
 
 ## sx prop
 
-A special `sx` prop lets you apply styles directly to an element. When `sx` prop is specified on an element, Pigment CSS will replace it with `className` and `style` props at build time.
+A special `sx` prop lets you apply styles directly to an element. When `sx` prop is specified on an element, Pigment CSS will replace it with `className` and `style` props at build time.
 
 The `sx` prop works on any element, including HTML elements and 3rd-party custom components as long as it is JSX.