[docs] Fix some Vale errors (mui#12469)

.circleci/config.yml

@@ -52,7 +52,7 @@ commands:
       browsers:
         type: boolean
         default: false
-        description: 'Set to true if you intend to any browser (e.g. with playwright).'
+        description: 'Set to true if you intend to any browser (for example with playwright).'
 
     steps:
       - run:

.gitignore

@@ -20,5 +20,7 @@ dist
 node_modules
 size-snapshot.json
 performance-snapshot.json
+# vale downloaded config
 .github/styles/Google
-.github/styles/write-good
+.github/styles/MUI
+.github/styles/.vale-config

.vale.ini

@@ -1,33 +1,27 @@
-# Config vale. More information at https://docs.errata.ai/vale/config
+# Vale config. More information at https://vale.sh/docs/topics/config/
 StylesPath = .github/styles
-MinAlertLevel = suggestion
+MinAlertLevel = error
 
-Packages = Google
+# 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 injection which start with {{...
+# Ignore code injections that start with {{...
 BlockIgnores = {{.*
 
-# Custom syle
-# BasedOnStyles = Blog
+BasedOnStyles = MUI
 
-Blog.ComposedWords = YES
-Blog.NamingConventions = YES
-Blog.Typos = YES
-Blog.BrandName = YES
-Blog.NoCompanyName = YES
+# Google errors:
+Google.GenderBias = YES # No Gender bias
+# Google warings:
+Google.FirstPerson = YES # Avoid first-person
+Google.We = YES # Avoid first-person plural
+Google.Will = YES # Avoid future tense
+Google.OxfordComma = YES # Prefer Oxford comma
 
-# Google:
-Google.FirstPerson = YES # Avoid first-person pronouns such as I, me, ...'.
-Google.GenderBias = YES # Avoid gendered profession
-Google.OxfordComma = YES
-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
-
-# Those rules are not repected a lot
-# Google.Passive = YES # In general, use active voice instead of passive voice.
-# Google.Will = YES # Avoid using will
-
-# False positives with "1st" nearly no use in our doc
-# Google.Units = YES # Put a nonbreaking space between the number and the unit
+[CHANGELOG*.md]
+MUI.CorrectReferenceAllCases = NO

CHANGELOG.md

@@ -90,7 +90,7 @@ The `onNodeFocus` callback has been renamed to `onItemFocus` for consistency:
 - [docs] Add `legacy` bundle drop mention in migration pages (#12424) @LukasTy
 - [docs] Add missing luxon `Info` import (#12427) @LukasTy
 - [docs] Improve slots definitions for charts (#12408) @alexfauquette
-- [docs] Polish What's new in MUI X blog titles (#12309) @oliviertassinari
+- [docs] Polish What's new in MUI X blog titles (#12309) @oliviertassinari
 - [docs] Replace `rel="noreferrer"` by `rel="noopener"` @oliviertassinari
 - [docs] Update `date-fns` `weekStarsOn` overriding example (#12416) @LukasTy
 
@@ -252,7 +252,7 @@ Same changes as in `@mui/[email protected]`.
 ### Docs
 
 - [docs] Fix image layout shift when loading @oliviertassinari
-- [docs] Match Material UI repo comment for redirections @oliviertassinari
+- [docs] Match Material UI repo comment for redirections @oliviertassinari
 - [docs] Non breaking spaces @oliviertassinari
 - [docs] Polish the Date Picker playground (#11869) @zanivan
 - [docs] Standardize WAI-ARIA references @oliviertassinari
@@ -263,9 +263,9 @@ Same changes as in `@mui/[email protected]`.
 - [core] Remove grid folder from `getComponentInfo` RegExp (#12241) @flaviendelangle
 - [core] Remove `window.` reference for common globals @oliviertassinari
 - [core] Use runtime agnostic setTimeout type @oliviertassinari
-- [docs-infra] Fix Stack Overflow breaking space @oliviertassinari
+- [docs-infra] Fix Stack Overflow breaking space @oliviertassinari
 - [docs-infra] Fix missing non breaking spaces @oliviertassinari
-- [github] Update `no-response` workflow (#12193) @MBilalShafi
+- [infra] Update `no-response` workflow (#12193) @MBilalShafi
 - [infra] Fix missing permission reset @oliviertassinari
 
 ## 7.0.0-beta.4
@@ -282,7 +282,7 @@ We'd like to offer a big thanks to the 10 contributors who made this release pos
 
 ### Breaking changes
 
-- The support for IE11 has been removed from all MUI X packages. The `legacy` bundle that used to support old browsers like IE11 is no longer included.
+- The support for IE11 has been removed from all MUI X packages. The `legacy` bundle that used to support old browsers like IE11 is no longer included.
 
 ### Data Grid
 
@@ -392,7 +392,7 @@ These components are no longer exported from `@mui/x-charts`:
 ### Docs
 
 - [docs] Add recipe for hiding separator on non-resizable columns (#12134) @michelengelen
-- [docs] Add small improvements to the Gauge Chart page (#12076) @danilo-leal
+- [docs] Add small improvements to the Gauge page (#12076) @danilo-leal
 - [docs] Add the 'point' scaleType to the axis documentation (#12179) @alexfauquette
 - [docs] Clarify Pickers 'Component composition' section (#12097) @LukasTy
 - [docs] Fix "Licensing" page link (#12156) @LukasTy
@@ -975,7 +975,7 @@ Same changes as in `@mui/[email protected]`.
 
 - [charts] Do not propagate `innerRadius` and `outerRadius` to the DOM (#11689) @alexfauquette
 - [charts] Fix default `stackOffset` for `LineChart` (#11647) @alexfauquette
-- [charts] Remove a TS ignore (#11688) @alexfauquette
+- [charts] Remove a TypeScript ignore (#11688) @alexfauquette
 
 ### Tree View
 
@@ -1404,7 +1404,7 @@ Same changes as in `@mui/[email protected]`.
 - [core] Fix release changelog (#11496) @romgrk
 - [core] Fix use of ::before & ::after (#11515) @oliviertassinari
 - [core] Localize the issue template to MUI X (#11511) @oliviertassinari
-- [core] Regen api files (#11542) @flaviendelangle
+- [core] Regenerate API files (#11542) @flaviendelangle
 - [core] Remove issue emoji @oliviertassinari
 - [core] Sync the release instructions with MUI Core @oliviertassinari
 - [core] Yaml format match most common convention @oliviertassinari
@@ -1447,7 +1447,7 @@ We'd like to offer a big thanks to the 6 contributors who made this release poss
 
 - The `filterModel` now supports `Date` objects as values for `date` and `dateTime` column types.
   The `filterModel` still accepts strings as values for `date` and `dateTime` column types,
-  but all updates to the `filterModel` coming from the UI (e.g. filter panel) will set the value as a `Date` object.
+  but all updates to the `filterModel` coming from the UI (for example filter panel) will set the value as a `Date` object.
 
 #### `@mui/[email protected]`
 
@@ -1658,7 +1658,7 @@ Same changes as in `@mui/[email protected]`, plus:
 ### Core
 
 - [core] Automate cherry-pick of PRs from `next` -> `master` (#11382) @MBilalShafi
-- [github] Update `no-response` workflow (#11369) @MBilalShafi
+- [infra] Update `no-response` workflow (#11369) @MBilalShafi
 - [test] Fix flaky screenshots (#11388) @cherniavskii
 
 ## 7.0.0-alpha.4
@@ -1896,7 +1896,7 @@ Same changes as in `@mui/[email protected]`.
 
 - [charts] Adjusted `defaultizeValueFormatter` util to accept an optional `series.valueFormatter` value (#11144) @michelengelen
 - [charts] Apply `labelStyle` and `tickLabelStyle` props on `<ChartsYAxis />` (#11180) @akamfoad
-- [charts] Fix TS config (#11259) @alexfauquette
+- [charts] Fix TypeScript config (#11259) @alexfauquette
 - [charts] Fix error with empty dataset (#11063) @alexfauquette
 - [charts] Fix export strategy (#11235) @alexfauquette
 - [charts] Remove outdated prop-types (#11045) @alexfauquette

README.md

@@ -95,15 +95,15 @@ From community guidance to critical business support, we're here to help. Read t
 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 to MUI X is about more than just issues and pull requests!
-There are many other ways to [support MUI](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 MUI X](https://mui.com/material-ui/getting-started/faq/#mui-is-awesome-how-can-i-support-the-project) beyond contributing to the code base.
 
 ## Changelog
 
 The [changelog](https://github.com/mui/mui-x/releases) is regularly updated to reflect what's changed in each new release.
 
 ## Roadmap
 
-Future plans and high-priority features and enhancements can be found in our [roadmap](https://mui.com/x/introduction/roadmap/).
+Future plans and high-priority features and enhancements can be found in the [roadmap](https://mui.com/x/introduction/roadmap/).
 
 ## Security
 

changelogOld/CHANGELOG.v4.md

@@ -310,8 +310,8 @@ Big thanks to the 8 contributors who made this release possible. Here are some h
 
 - [docs] Add missing API docs (#2167) @ZeeshanTamboli
 - [docs] Describe how to export custom rendered cells (#2194) @m4theushw
-- [docs] Generate api doc for the GridExportCSVOptions interface (#2102) @flaviendelangle
-- [docs] Handle generics in api doc generation (#2210) @flaviendelangle
+- [docs] Generate API doc for the GridExportCSVOptions interface (#2102) @flaviendelangle
+- [docs] Handle generics in API doc generation (#2210) @flaviendelangle
 
 ### Core
 
@@ -1260,7 +1260,7 @@ Big thanks to the 8 contributors who made this release possible. Here are some h
 - [DataGrid] Rename `GridBaseComponentProps` type to `GridSlotComponentProps` (#1252) @DanailH
 - [DataGrid] Rename `useGridBaseComponentProps` hook to `useGridSlotComponentProps` (#1252) @DanailH
 - [DataGrid] Rename modules (#1292) @DanailH
-- [DataGrid] Rename all events related to column reordering, e.g. `GRID_COL_REORDER_START` -> `GRID_COLUMN_REORDER_START` (#1299) @m4theushw
+- [DataGrid] Rename all events related to column reordering, for example `GRID_COL_REORDER_START` -> `GRID_COLUMN_REORDER_START` (#1299) @m4theushw
 - [DataGrid] Methods `onColItemDragStart`, `onColHeaderDragOver`, `onColItemDragOver`, `onColItemDragEnter` removed from the grid API. Prefer listening to [column reordering events](https://mui.com/x/react-data-grid/column-ordering/) (#1299) @m4theushw
 - [DataGrid] Calling `apiRef.current.getColumnHeaderParams` returns a `GridColumnHeaderParams` instead of `GridColParams` (#1299) @m4theushw
 - [DataGrid] Events that follow the pattern `GRID_COLUMN_HEADER_xxx` will be called with a `GridColumnHeaderParams` instead of `GridColParams` (#1299) @m4theushw
@@ -1475,7 +1475,7 @@ Big thanks to the 4 contributors who made this release possible. Here are some h
 - [DataGrid] Fix process is not defined (EXPERIMENTAL_ENABLED) (#1027) @leontastic
 - [DataGrid] Fix scrollbar size on windows (#1061) @dtassone
 - [DataGrid] Fix warning with v5 (#1038) @oliviertassinari
-- [DataGrid] Resolve the api ref at the same time as any other ref (#990) @oliviertassinari
+- [DataGrid] Resolve the apiRef at the same time as any other ref (#990) @oliviertassinari
 - [DataGrid] Use the disableDensitySelector to disable the DensitySelector (#1031) @DanailH
 - [DataGrid] Fix passing [] or undefined in sortModel prop (#1035) @dtassone
 - [XGrid] Fix server-side multi filters (#1029) @dtassone
@@ -1501,7 +1501,7 @@ _Feb 5, 2021_
 Big thanks to the 5 contributors who made this release possible. Here are some highlights ✨:
 
 - 🎁 Add getRowId prop (#972) @dtassone
-- 🚀 Add streaming delete row api (#980) @dtassone
+- 🚀 Add streaming delete row API (#980) @dtassone
 - 💅 Fix autoHeight (#940) @oliviertassinari
 - 🙌 Enable the data grid to work under strict mode (#933) @dtassone
 - ⚡️ Add component slots for toolbar and preference panel (#971) @DanailH
@@ -1511,7 +1511,7 @@ Big thanks to the 5 contributors who made this release possible. Here are some h
 
 - [DataGrid] Add component slots for toolbar and preference panel (#971) @DanailH
 - [DataGrid] Add getRowId prop (#972) @dtassone
-- [DataGrid] Add streaming delete row api (#980) @dtassone
+- [DataGrid] Add streaming delete row API (#980) @dtassone
 - [DataGrid] Fix autoHeight (#940) @oliviertassinari
 - [DataGrid] Fix column reorder instability (#950) @dtassone
 - [DataGrid] Fix footer visual regression (#932) @dtassone
@@ -1525,7 +1525,7 @@ Big thanks to the 5 contributors who made this release possible. Here are some h
 ### docs
 
 - [docs] Add sorting page in datagrid docs (#931) @dtassone
-- [docs] Api page update with component slots (#969) @dtassone
+- [docs] API page update with component slots (#969) @dtassone
 - [docs] Catch leaks ahread of time (#979) @oliviertassinari
 - [docs] Fix immutability with filter operator demos (#975) @dtassone
 - [docs] Improve docs of DataGrid about filter operators (#973) @SaskiaKeil
@@ -1728,7 +1728,7 @@ Big thanks to the 4 contributors who made this release possible. Here are some h
 
 ### Docs
 
-- [docs] Add missing props to DataGrid and XGrid api pages (#721) @DanailH
+- [docs] Add missing props to DataGrid and XGrid API pages (#721) @DanailH
 - [docs] Fix wrong link anchor @oliviertassinari
 - [docs] Proxy production version @oliviertassinari
 
@@ -1853,7 +1853,7 @@ _Nov 20, 2020_
 
 ### Core
 
-- [core] Prepare work for a future public state api (#533) @dtassone
+- [core] Prepare work for a future public state API (#533) @dtassone
 - [core] Fix yarn prettier write @oliviertassinari
 - [test] Share karma setup (#576) @oliviertassinari
 
@@ -1974,7 +1974,7 @@ You can find the documentation at this address: https://mui.com/x/react-data-gri
 
 ### @material-ui/x-grid@v4.0.0-alpha.1 / @material-ui/data-grid@v4.0.0-alpha.1
 
-- [DataGrid] Add api pages for data-grid and x-grid (#289) @dtassone
+- [DataGrid] Add API pages for data-grid and x-grid (#289) @dtassone
 - [DataGrid] Add dark mode scrollbar (#282) @dtassone
 - [DataGrid] Better explain the limits of MIT vs commercial (#225) @oliviertassinari
 - [DataGrid] First v4 alpha version (#291) @dtassone