[docs-infra] Add vale for style-guide lint on docs (#3178)

Signed-off-by: Bharat Kashyap <[email protected]>
Co-authored-by: Jan Potoms <[email protected]>
Co-authored-by: Sam Sycamore <[email protected]>

.github/workflows/vale-action.yml

@@ -0,0 +1,23 @@
+name: Vale action
+
+on: [pull_request]
+
+permissions: {}
+
+jobs:
+  vale:
+    name: runner / vale
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - uses: errata-ai/vale-action@c4213d4de3d5f718b8497bd86161531c78992084 # v2.0.1
+        with:
+          reporter: github-pr-review
+          files: docs/data
+        env:
+          # Required, set by GitHub actions automatically:
+          # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -60,3 +60,5 @@ test-results
 .yarn-playwright-cache
 
 /test/regressions/screenshots/**
+
+.github/styles/

.vale.ini

@@ -0,0 +1,29 @@
+#Config vale. More information at https://docs.errata.ai/vale/config
+StylesPath = .github/styles
+MinAlertLevel = suggestion
+
+# To update writing-rules 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/master/docs/writing-rules.zip
+
+[*.md]
+# Ignore code injections that start with {{...
+BlockIgnores = {{.*
+
+# Custom syle
+BasedOnStyles = writing-rules
+
+
+
+# Google:
+Google.FirstPerson = YES # Avoid first-person pronouns such as I, me, ...'.
+Google.GenderBias = YES # Avoid gendered profession
+Google.OxfordComma = YES # Add a comma before the final item in a series
+Google.Quotes = YES # Commas and periods go inside quotation marks
+Google.Spelling = YES # In general, use American spelling (word ending with 'nised' or 'logue')
+Google.We = YES # Try to avoid using first-person plural
+Google.Latin = YES # Try to avoid latin expressions e.g. and i.e.
+