diff --git a/.circleci/config.yml b/.circleci/config.yml index c10fe610fb550f..7d6bcd9d4eb56e 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -62,7 +62,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: diff --git a/.vale.ini b/.vale.ini index d1720b276aac71..b61c3be62bf326 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,28 +1,23 @@ -# 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 = warning -# The docs/writing-rules.zip is generated by `pnpm docs:zipRules` -Packages = Google, docs/writing-rules.zip +# The docs/mui-vale.zip is generated by `pnpm docs:zipRules` +Packages = Google,docs/mui-vale.zip [*.md] -# Ignore code injection which start with {{... +# Ignore code injections that start with {{... BlockIgnores = {{.* -BasedOnStyles = writing-rules +BasedOnStyles = MUI -# 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 -Google.Latin = YES # Try to avoid latin expressions e.g. and i.e. +# 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 -# 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 \ No newline at end of file +[CHANGELOG*.md] +MUI.CorrectReferenceAllCases = NO diff --git a/CHANGELOG.md b/CHANGELOG.md index ac0384bc25c34f..c3b4f3bae85e37 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,7 +8,7 @@ _Mar 13, 2024_ A big thanks to the 18 contributors who made this release possible. Here are some highights ✨ -- The Material UI free Checkout template got a design uplift (#41447) @zanivan +- The Material UI free Checkout template got a design uplift (#41447) @zanivan ### `@mui/material@5.15.13` @@ -69,21 +69,21 @@ A big thanks to the 18 contributors who made this release possible. Here are som ### Core -- [pigment] Make all Pigment CSS packages public (#41404) @brijeshb42 +- [pigment] Make all Pigment CSS packages public (#41404) @brijeshb42 - [pigment] Rename directories to match package names (#41453) @brijeshb42 - [pigment-css] Example fix leading spaces (#41439) @oliviertassinari - [code-infra] Add short note about e2e-website workflow schedule (#41355) @Janpot - [code-infra] Add alias for icon types (#41248) @Janpot - [code-infra] Reduce concurrency of typescript:ci further (#41392) @Janpot - [code-infra] Reduce concurrency for test_types ci job (#41385) @Janpot -- [code-infra] Adapt API code generator to Base UI repo needs (#41475) @michaldudak +- [code-infra] Adapt API code generator to Base UI repo needs (#41475) @michaldudak - [docs-infra] Don't generate preview files for the templates (#41379) @mnajdova -- [docs-infra] Fix pigment css apps path in the render mui demos script (#41476) @mnajdova +- [docs-infra] Fix Pigment CSS apps path in the render mui demos script (#41476) @mnajdova - [docs-infra] move feedback to ESM (#41381) @alexfauquette - [docs-infra] Improve color contrast throughout (#41387) @danilo-leal - [docs-infra] Simplify Algolia crawler config (#41312) @oliviertassinari - [docs-infra] Adjust the tabs and layout selection design (#41084) @danilo-leal -- [blog] Update the Base UI post with links to dedicated repo (#41358) @danilo-leal +- [blog] Update the Base UI post with links to dedicated repo (#41358) @danilo-leal - [website] Update the Careers page role (#41384) @danilo-leal - [website] Compress about images @oliviertassinari - [website] Improve color contrast on the homepage (#41465) @danilo-leal @@ -125,7 +125,7 @@ This release was mostly about 🐛 bug fixes and 📚 documentation improvements - [pigment-css] Rename zero-runtime to pigmentcss (#41317) @brijeshb42 - Fix createSpacing return type (#41318) @matystroia - [zero] Add support for styled tagged-template literals (#41268) @brijeshb42 -- [zero] Set up Material UI migration demos (#41267) @siriwatknp +- [zero] Set up Material UI migration demos (#41267) @siriwatknp - [zero] Move extendTheme to already existing @mui/zero-runtime/utils (#41254) @brijeshb42 - [zero] Remove `object` intersection from CSS Fallback (#41271) @siriwatknp - [zero] Minor wording changes in README (#41253) @brijeshb42 @@ -162,7 +162,7 @@ This release was mostly about 🐛 bug fixes and 📚 documentation improvements - [docs-infra] Fix missing non breaking spaces @oliviertassinari - [docs-infra] Add design customizations to the disclosure element (#41285) @danilo-leal - [docs-infra] Adjust headings dark mode color (#41292) @danilo-leal -- [docs-infra] Fix Stack Overflow breaking space @oliviertassinari +- [docs-infra] Fix Stack Overflow breaking space @oliviertassinari - [docs-infra] Fix product selector popup not closing on route change (#41166) @divyammadhok - [docs-infra] Improve fix blank links ad @oliviertassinari - [docs-infra] Support interfaces for X docs (#41069) @alexfauquette @@ -269,7 +269,7 @@ This release was mostly about 🐛 bug fixes and 📚 documentation improvements - [docs-infra] Reduce scrollbar width on ROC (#41148) @oliviertassinari - [docs-infra] Add external link arrow (#41129) @siriwatknp - [docs-infra] Fix external link arrow (#41181) @alexfauquette -- [docs-infra] Flag NPM and Github as wrong spellings @oliviertassinari +- [docs-infra] Flag npm and GitHub as wrong spellings @oliviertassinari - [docs-infra] Fix display when the default props is undefined (#41114) @oliviertassinari - [docs-infra] Remove random layout assignment (#40862) @alexfauquette - [docs-infra] Add spacing and contrast improvements (#41191) @danilo-leal @@ -317,7 +317,7 @@ This release was mostly about 🐛 bug fixes and 📚 documentation improvements - Fix 301 redirection to StackBlitz @oliviertassinari - Fix h1 on Joy UI templates @oliviertassinari - Have MUI workspace own the CodeSandbox @oliviertassinari -- Add notification for mui x v7 beta (#41001) @joserodolfofreitas +- Add notification for MUI X v7 beta (#41001) @joserodolfofreitas - Fix 301 links @oliviertassinari - Fix Next.js v13.5.1