From 44bb08750d8e2f58c937e1f9a2cda61aa7713e91 Mon Sep 17 00:00:00 2001 From: alexandre Date: Mon, 19 Feb 2024 11:24:49 +0100 Subject: [PATCH 1/8] [docs-infra] Share vale-config --- .github/styles/Vocab/accept.txt | 0 .github/styles/Vocab/reject.txt | 0 .gitignore | 3 +-- .vale.ini | 14 ++------------ docs/writing-rules/.vale.ini | 10 ++++++++++ .../writing-rules/writing-rules}/BrandName.yml | 0 .../writing-rules/writing-rules}/ComposedWords.yml | 0 .../writing-rules}/NamingConventions.yml | 0 .../writing-rules/writing-rules}/NoCompanyName.yml | 0 .../writing-rules/writing-rules}/Typos.yml | 0 10 files changed, 13 insertions(+), 14 deletions(-) delete mode 100644 .github/styles/Vocab/accept.txt delete mode 100644 .github/styles/Vocab/reject.txt create mode 100644 docs/writing-rules/.vale.ini rename {.github/styles/Blog => docs/writing-rules/writing-rules}/BrandName.yml (100%) rename {.github/styles/Blog => docs/writing-rules/writing-rules}/ComposedWords.yml (100%) rename {.github/styles/Blog => docs/writing-rules/writing-rules}/NamingConventions.yml (100%) rename {.github/styles/Blog => docs/writing-rules/writing-rules}/NoCompanyName.yml (100%) rename {.github/styles/Blog => docs/writing-rules/writing-rules}/Typos.yml (100%) diff --git a/.github/styles/Vocab/accept.txt b/.github/styles/Vocab/accept.txt deleted file mode 100644 index e69de29bb2d1d6..00000000000000 diff --git a/.github/styles/Vocab/reject.txt b/.github/styles/Vocab/reject.txt deleted file mode 100644 index e69de29bb2d1d6..00000000000000 diff --git a/.gitignore b/.gitignore index f1ddd44449467c..1e7a18dca293e9 100644 --- a/.gitignore +++ b/.gitignore @@ -39,6 +39,5 @@ package-lock.json size-snapshot.json docs/public/static/blog/feed/* # vale downloaded config -.github/styles/Google -.github/styles/write-good +.github/styles/ .nx/cache diff --git a/.vale.ini b/.vale.ini index d4d101e0960108..693f023cbfc0b1 100644 --- a/.vale.ini +++ b/.vale.ini @@ -2,20 +2,10 @@ StylesPath = .github/styles MinAlertLevel = suggestion -Packages = Google +Packages = Google, docs/writing-rules/ [*.md] -# Ignore code injection which start with {{... -BlockIgnores = {{.* - -# Custom syle -# BasedOnStyles = Blog - -Blog.ComposedWords = YES -Blog.NamingConventions = YES -Blog.Typos = YES -Blog.BrandName = YES -Blog.NoCompanyName = YES +BasedOnStyles = writing-rules # Google: Google.FirstPerson = YES # Avoid first-person pronouns such as I, me, ...'. diff --git a/docs/writing-rules/.vale.ini b/docs/writing-rules/.vale.ini new file mode 100644 index 00000000000000..79558efad55796 --- /dev/null +++ b/docs/writing-rules/.vale.ini @@ -0,0 +1,10 @@ + +# Config vale. More information at https://docs.errata.ai/vale/config +StylesPath = . +MinAlertLevel = suggestion + +[*.md] +# Ignore code injection which start with {{... +BlockIgnores = {{.* + +BasedOnStyles = writing-rules \ No newline at end of file diff --git a/.github/styles/Blog/BrandName.yml b/docs/writing-rules/writing-rules/BrandName.yml similarity index 100% rename from .github/styles/Blog/BrandName.yml rename to docs/writing-rules/writing-rules/BrandName.yml diff --git a/.github/styles/Blog/ComposedWords.yml b/docs/writing-rules/writing-rules/ComposedWords.yml similarity index 100% rename from .github/styles/Blog/ComposedWords.yml rename to docs/writing-rules/writing-rules/ComposedWords.yml diff --git a/.github/styles/Blog/NamingConventions.yml b/docs/writing-rules/writing-rules/NamingConventions.yml similarity index 100% rename from .github/styles/Blog/NamingConventions.yml rename to docs/writing-rules/writing-rules/NamingConventions.yml diff --git a/.github/styles/Blog/NoCompanyName.yml b/docs/writing-rules/writing-rules/NoCompanyName.yml similarity index 100% rename from .github/styles/Blog/NoCompanyName.yml rename to docs/writing-rules/writing-rules/NoCompanyName.yml diff --git a/.github/styles/Blog/Typos.yml b/docs/writing-rules/writing-rules/Typos.yml similarity index 100% rename from .github/styles/Blog/Typos.yml rename to docs/writing-rules/writing-rules/Typos.yml From 6df3f464da676467b416931b2d9a8d224bef762c Mon Sep 17 00:00:00 2001 From: alexandre Date: Mon, 19 Feb 2024 12:13:38 +0100 Subject: [PATCH 2/8] add relesae script --- .github/workflows/vale-release.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/workflows/vale-release.yml diff --git a/.github/workflows/vale-release.yml b/.github/workflows/vale-release.yml new file mode 100644 index 00000000000000..e86dcd1bfef2b3 --- /dev/null +++ b/.github/workflows/vale-release.yml @@ -0,0 +1,25 @@ +name: Release + +on: + pull_request: + paths: + - 'docs/writing-rules/**' + +jobs: + publish: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - run: zip -r "writing-rules.zip" docs/writing-rules + + - name: Upload style to release + uses: svenstaro/upload-release-action@v2 + if: startsWith(github.ref, 'refs/tags/') + with: + repo_token: ${{ secrets.GITHUB_TOKEN }} + file_glob: true + file: writing-rules.zip \ No newline at end of file From 8e4299fa5fff99e42fa15374022b155db3e8fb31 Mon Sep 17 00:00:00 2001 From: alexandre Date: Tue, 20 Feb 2024 15:50:17 +0100 Subject: [PATCH 3/8] save zip in the github --- .github/workflows/vale-release.yml | 25 ------------------ docs/writing-rules.zip | Bin 0 -> 3550 bytes .../ComponentNameConventions.yml | 12 +++++++++ package.json | 1 + 4 files changed, 13 insertions(+), 25 deletions(-) delete mode 100644 .github/workflows/vale-release.yml create mode 100644 docs/writing-rules.zip create mode 100644 docs/writing-rules/writing-rules/ComponentNameConventions.yml diff --git a/.github/workflows/vale-release.yml b/.github/workflows/vale-release.yml deleted file mode 100644 index e86dcd1bfef2b3..00000000000000 --- a/.github/workflows/vale-release.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: Release - -on: - pull_request: - paths: - - 'docs/writing-rules/**' - -jobs: - publish: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - - run: zip -r "writing-rules.zip" docs/writing-rules - - - name: Upload style to release - uses: svenstaro/upload-release-action@v2 - if: startsWith(github.ref, 'refs/tags/') - with: - repo_token: ${{ secrets.GITHUB_TOKEN }} - file_glob: true - file: writing-rules.zip \ No newline at end of file diff --git a/docs/writing-rules.zip b/docs/writing-rules.zip new file mode 100644 index 0000000000000000000000000000000000000000..ca1d03beed381b5b95bcd366442d89e471d88504 GIT binary patch literal 3550 zcma)8c|26>A3kF+7&DeEDMTn_8IpBWmh4d&+%jd?Ow5R3j6}9ZMX4b~lCmT%t|dZJ zxROL%xt2oKN@Pv8d!~M$pOLxc%;!C4&OhJhe4qDupYL}|GRAf zL;*LVtDiF27e~SoJQaQYz1;njF}9olRHvlXoxc17;Q)kn7zzO2ZwLNgY}={T#Uz;* zV^SLSsMTEqTue#}fM3S({X0>DB3>=vn*#&@RM%75l4wBm_HiaqESQ0yYaSVd!>m$p>g!XX6~n`TWa zyW$=~ODrsr(%aQ*u}`5bQ?Jk`9q)ItJ^|aJaiv46M`&qjBsy_2mR!!BcIdV4IV13iudkW}=WUdc} zGu6uUomrue40o*21gVo}0RW}-(5LU~OmJHdb>3EGgl8!3u0=uC@U4nXwPm#)^-Z^T zT}>!Hb~r~tWa~AxP#W=hVuJ6ae3M@K1u|M(czop6MH-+V-J59{c~pt?L`r>%+yAMP zWY1o11bdFD$QY|5Fv7|1dDp)C2zHPizHL{Fs(ek6YR2?NnCHDl5+Iyj+$-| zg!kxPK=sr~d^yiD%n@Lx9!$6Eos^c>t7m<$C2!7dO$*-OZlp z>*n`6d3(p1)Az`5b~jsC`gqpaS#4uwiNi69t^5c?!mWqO14584k_=v)x+g?-2r$l( zQp5i(TWZezHCgNwN2~?S&Cns^weAP~M<~HFmmOy{>uhNU-!+Ww83}`9s?j#fXVP5M zD|ucvFC`KNHs8NcA|QuNEf7dU=Ve~0?>_4@yIH0(%yzfdGx;Wr8D7w6i|EU(RTCCB z-8|kS#-ub4*=m$Hm&_$7JFutlM$`+9hK1aX=_R$76#0o2?M&Tnn&Q^!Sy?|ho7fla zT&@w8X13h7$9HPkHmAo=Co*5CMSMBjesS{(p{k%2b;}lpZ3fAl2bcPK1P^K*v^)bM zA;6tL!Vw88q;3JdiN1dFC;x+0gr_L(irF0sH_pB|HdZQ$?2J>FOxWUMW24%kc@DdA z{#&U96mgbzbm48mB>y+-b9Xi4^7#2NWvc2zajw41CdH=fE3i=(sB+o{CV z)>oCm<|0O%`4Mxp21&!6PVn-w)E61qQqxFT&&GYjTRkUai(RP|2UMV1&fyT+>4~t6 zc8>NF;#qu%Vx;z98>ua#s;ky&Y5<9x$u)Jvh~;Nn&tP60kslDqi%vUv89$@^zOYdc zxKdN)JL%y=i3qZk-c7wV!*S*#T-{|p`ar3D8#&er-FMyJ`>R>r7QQ21!@2hm_Xy*z zlbcg|E=gn#Rk66XMYU58P8FiO-5(3jm*tEkqZB z+UBAA&w94PmI6xqcbdjnst{Nuxj#{&GHncD6)9?S94EhO3Ow2Isp940ZjbXOw>@fI zFH%F|jf7aW)SGjucH;MFCi0QvHRFR&?M%p$0lHPvOb)t7X>nvzMUG@sDjKU8vAvtt ze!DTE3(;?(GgSze4Q=5yKMi~Jn7=rlkIS!EH%0HE>ty0JJD$kw4@w)~@7TpP5tBT| zpD>G;_(qWaGIM_}h>CQ&+4i+MD)?%aiTbNF9yXy7b-g_jyoqRpPIirFA9 z9pDmW&WlojvzNOPj)40@QfZ=q;XJI zw#ub`uS-jmmVgEE;IS&MSrv4(vsD@*&BY~tJbGlmyo!WeK<@SO+aJ|CyfkI3Ri&p% zIita6?ku5);5h1GHJ{55CR3;Cbm#Ra-e@(_czW!T$tS6T;*Lo!>cuu+o(FtJTx&-b zSX+zU`dZt(5gL1OrU>oJC*%N8i!ars${ZPvGn6Uu|8`}OK@{h~<`Z4E>i2_<2ZN%} zW#0VisPNtJ2;kYI4<%;Dv=%&~a%@Sj3_K73wyE zG}A9$U{R0$WE%0h^xhOzXp3J^2|isbI+dEhdv3@O#{~1CkN9opl|! z|1mB>Y$l`fhm2NuUOf>Qv0d5Mfz2=5{R`9L925Wm literal 0 HcmV?d00001 diff --git a/docs/writing-rules/writing-rules/ComponentNameConventions.yml b/docs/writing-rules/writing-rules/ComponentNameConventions.yml new file mode 100644 index 00000000000000..72d25774783f4a --- /dev/null +++ b/docs/writing-rules/writing-rules/ComponentNameConventions.yml @@ -0,0 +1,12 @@ +extends: substitution +message: To be consistent with component name, consider using '%s' instead of '%s'. +level: error +ignorecase: true +# swap maps tokens in form of bad: good +# for more information: https://vale.sh/docs/topics/styles/#substitution +swap: + 'Heat map': Heatmap + 'Tree map': Treemap + 'Sparkline Chart': Sparkline + 'Gauge Chart': Gauge + 'Treemap Chart': Treemap diff --git a/package.json b/package.json index 21587fee30f237..f876243cb19f17 100644 --- a/package.json +++ b/package.json @@ -34,6 +34,7 @@ "docs:typescript:check": "pnpm --filter docs typescript", "docs:typescript:formatted": "tsx ./docs/scripts/formattedTSDemos", "docs:mdicons:synonyms": "cross-env BABEL_ENV=development babel-node --extensions \".tsx,.ts,.js,.mjs\" ./docs/scripts/updateIconSynonyms && pnpm prettier", + "docs:zipRules": "zip -r docs/writing-rules.zip docs/writing-rules", "extract-error-codes": "cross-env MUI_EXTRACT_ERROR_CODES=true lerna run --concurrency 8 build:modern", "rsc:build": "tsx ./packages/rsc-builder/buildRsc.ts", "template:screenshot": "cross-env BABEL_ENV=development babel-node --extensions \".tsx,.ts,.js\" ./docs/scripts/generateTemplateScreenshots", From bd93c4bfcbf82df721e32f3f71b4761333ff7d96 Mon Sep 17 00:00:00 2001 From: alexandre Date: Tue, 20 Feb 2024 15:51:11 +0100 Subject: [PATCH 4/8] prettier --- packages/mui-material/src/Select/Select.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/mui-material/src/Select/Select.d.ts b/packages/mui-material/src/Select/Select.d.ts index e62fed42ba5f97..cbf55494ba697f 100644 --- a/packages/mui-material/src/Select/Select.d.ts +++ b/packages/mui-material/src/Select/Select.d.ts @@ -184,8 +184,8 @@ export type SelectProps< (Variant extends 'filled' ? FilledSelectProps : Variant extends 'standard' - ? StandardSelectProps - : OutlinedSelectProps); + ? StandardSelectProps + : OutlinedSelectProps); /** * From 2d7d2e3f8893c1a38b94c4d84172eedc3d3ed228 Mon Sep 17 00:00:00 2001 From: alexandre Date: Tue, 20 Feb 2024 16:06:59 +0100 Subject: [PATCH 5/8] fix script --- docs/writing-rules.zip | Bin 3550 -> 3460 bytes package.json | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/writing-rules.zip b/docs/writing-rules.zip index ca1d03beed381b5b95bcd366442d89e471d88504..c29c45d533d176721ded4f2f0ce07a5c240b3d74 100644 GIT binary patch delta 911 zcmca7-6Cxs;LXg!#Q*}D4IvR=29)4qkYOk<$}GvuOV=$b%}FiR4-MgDVBWXyO6tCS z6K$kL&^5>aHB2l}G=-?Rl3H59&A`a=f|-E0h-MLw#h(LGUqao7s1HDpbOS0 zGx50?8$|D9X2y45a!XfXlZ2T?USikqJk?vBlNOu>v`r9Cf`Cp`rkxF2EQ z$GH>`Z}0%l%ru#xP$uB4jpn%FBX337;msASG% zphF@U85oRUdM8h0mYH}%j16M@#4qo_O3S%pj#>bfX)!S{=pieeEXmE!33u#fEv8^b zu!f$O$&;P}&EAh@wh`3e#V45=C5?a{xT~?HQ5vY|HxQelnEabt9AvUQ(9QC@HcPUa zK}_CVw8dr%&}4p)b5JzYv++SqpFElEyyQ`!=@-+l=q?8;z6HcGaK-k#k|2|fc3(*~ z+CBLl$1X)?77?Hd4u)=^p6N+SPEUZm8lVNXa6JcktU!8>0bQfHd-6{9?{17ta?H45 zRRX9V1OyoVI)Z4dam)&eXu%kg10wY<73G7seHq^*P*47S8r7&&!NS0y7 zG_tN6EC^jPlYetdG07u5hZ^6=+LGCjwbiq6BUy+U`N%q}* Date: Tue, 20 Feb 2024 16:32:36 +0100 Subject: [PATCH 6/8] update --- .vale.ini | 6 +++++- docs/writing-rules.zip | Bin 3460 -> 2767 bytes docs/writing-rules/.vale.ini | 10 ---------- .../{writing-rules => }/BrandName.yml | 0 .../ComponentNameConventions.yml | 0 .../{writing-rules => }/ComposedWords.yml | 0 .../{writing-rules => }/NamingConventions.yml | 0 .../{writing-rules => }/NoCompanyName.yml | 0 .../{writing-rules => }/Typos.yml | 0 9 files changed, 5 insertions(+), 11 deletions(-) delete mode 100644 docs/writing-rules/.vale.ini rename docs/writing-rules/{writing-rules => }/BrandName.yml (100%) rename docs/writing-rules/{writing-rules => }/ComponentNameConventions.yml (100%) rename docs/writing-rules/{writing-rules => }/ComposedWords.yml (100%) rename docs/writing-rules/{writing-rules => }/NamingConventions.yml (100%) rename docs/writing-rules/{writing-rules => }/NoCompanyName.yml (100%) rename docs/writing-rules/{writing-rules => }/Typos.yml (100%) diff --git a/.vale.ini b/.vale.ini index 693f023cbfc0b1..d1720b276aac71 100644 --- a/.vale.ini +++ b/.vale.ini @@ -2,9 +2,13 @@ StylesPath = .github/styles MinAlertLevel = suggestion -Packages = Google, docs/writing-rules/ +# The docs/writing-rules.zip is generated by `pnpm docs:zipRules` +Packages = Google, docs/writing-rules.zip [*.md] +# Ignore code injection which start with {{... +BlockIgnores = {{.* + BasedOnStyles = writing-rules # Google: diff --git a/docs/writing-rules.zip b/docs/writing-rules.zip index c29c45d533d176721ded4f2f0ce07a5c240b3d74..ede893135cba84f1166718ab32ad29f21a5a93bd 100644 GIT binary patch delta 578 zcmZpXJ}=4>;LXg!#Q*}6npsW@X1A{bB#bj=7Sx!y{W{9fIT1>%=V0Aq&lP5g| znzSEk(&YKfFryZqWQM4@tFfg~8Yur8h?PNRz2#O#GE0)x45Ds#(H5I6K(qLP>cm0n z3fW|!&YC=#?L64N=}AgXPk?G_fNHcrYR>cMAk3P)ll?mnBa<96%Gn{0Fo0=DYCMH{0LW%8VtzlOMu#dfug{Kq#89akX17>169vw zMmHWcWRNx3vj8=`<<>wp9yNTBRc~hnsxD-cL~}iAU?FSR!v@rFo<|>Kd@QddA3Fm( N!&YEavv7by1OVl*jPC#d delta 1293 zcmX>v+9J&p;LXg!#Q*}D4HJ1(>-X)uk_y7572FJrEH9WD7{COwvXBU{dMF{oAj42z zlv$FQm#$k>nv+_rkID-T;bdUOW2y+y91fu6ArS_mk~vbBf!qj21_oUWV<)DmutCh3 zIN_ZVNJBYy%ux%VS}i7^>oL?%e$64v3AcOm4#r?cu&$n$$&;P}ZP}02mdWzWFl!cj zGDCFS)!5P~4OIObhz&9A*~qDiWKTDX8KVoxb-RnU*lYpX!w=M@ilGZNkU}a8@{9E< zb90bFYw~y2^I!*0Pf~Jv0yL-wXpjYlL6dK>=|jV1GC%wGdS(_xh+a&;qPrZZ^A-?` zW9ZZ?OUy~t%goC}vJ@lYReKG&4;cu!eg7@Wp2vDQwqS!_)1n6&eC}1tmK#odk~8sN z<>j(Jay9P{a(y?nIg(iKKaY1_Qqq(U9WQ;g3>7rXR?XkD^0nEm91GPTBbBcuE8f<$ zt^Q~8oIA5U+N5C8hR<`poUr}v^y#|gxyk$w!e*9Nw~NZf%t$iZ7X0yK**o63H~2OO z1<5S=aqOZ5b8r8*tu{r1ViAlcQ+C?6tH!;U;G(*t^w+e%>;c}4OmfUz3~WHJ0#nmu zAr51vefuW!a*BJyk~ey~l>jLP0s)450i>$X8m{rmA$}=mnqB Date: Tue, 20 Feb 2024 17:22:53 +0100 Subject: [PATCH 7/8] add client/server side --- docs/writing-rules.zip | Bin 2767 -> 2790 bytes docs/writing-rules/ComposedWords.yml | 2 ++ 2 files changed, 2 insertions(+) diff --git a/docs/writing-rules.zip b/docs/writing-rules.zip index ede893135cba84f1166718ab32ad29f21a5a93bd..2ad5d9de800afe005c1f0942cc6e4880922474e3 100644 GIT binary patch delta 375 zcmX>v`b=~KH#6^ru8@d_l6D1u7#JA-PK+0wtjjD`fBfQ=R1hw$;AUWCdBM!U048!L zI_9+)@VI`TbLi5Fq~NyNa~HW;9yP8|aoc!!%l7rWmnUYVi`LuMTNi%tHefG1P@2#g zq#BebWb~U;wnl)5Lpil?O)JxP4dW9%0TWnXY&+g~Y}S-2I9*nAX;LxczTcvg;w4+`3^$iGNKZ|XWs{fjadCWY z!tQzY6z}`+0)y@~Z+_K%=8mg;_qFW~_u4@IY42Hg?w=Ev^EifiTU*|eEkW15zlp9~ zwSUU_8B@2UVO=lp1HbCGmmaK&i}#4UQhI*-7&MgHxusaeeaAg``Z;? zbAtUJ<7Ru7*DR>vHQAiglIi%x$-JD3lP7aZF@{ZE$C<%+Zn8L64D)3+hRHYCbSE$8 QkeIxii;qp30~o>#0Ag~Z4gdfE delta 357 zcmV-r0h<2i70(s03j+;c0^@R0002LkzW;){{{t0^@R0002LlTHaalOhQpli&yh zld1_C0Y8()31|VglP(He0=x#3VF?wJ1P2+D?FkqZ1qJ{B000L72LQDK000CC00000 DtYMVB diff --git a/docs/writing-rules/ComposedWords.yml b/docs/writing-rules/ComposedWords.yml index 149dc0bd6ab30f..8d41db7534f630 100644 --- a/docs/writing-rules/ComposedWords.yml +++ b/docs/writing-rules/ComposedWords.yml @@ -11,3 +11,5 @@ swap: 'sub components': subcomponents 'use-case': 'use case' 'usecase': 'use case' + 'client side': 'client-side' + 'server side': 'server-side' From 702d39b933289984f1d63c21d8ec7005f87a0ce0 Mon Sep 17 00:00:00 2001 From: alexandre Date: Wed, 21 Feb 2024 10:06:51 +0100 Subject: [PATCH 8/8] add instruction --- docs/writing-rules/BrandName.yml | 4 ++++ docs/writing-rules/ComponentNameConventions.yml | 4 ++++ docs/writing-rules/ComposedWords.yml | 4 ++++ docs/writing-rules/NamingConventions.yml | 4 ++++ docs/writing-rules/NoCompanyName.yml | 5 +++++ docs/writing-rules/Typos.yml | 4 ++++ 6 files changed, 25 insertions(+) diff --git a/docs/writing-rules/BrandName.yml b/docs/writing-rules/BrandName.yml index b95387c58510b3..56ea998e7dcd2c 100644 --- a/docs/writing-rules/BrandName.yml +++ b/docs/writing-rules/BrandName.yml @@ -14,3 +14,7 @@ swap: MUI Core: MUI Core MUI Toolpad: MUI Toolpad MUI Connect: MUI Connect +# Don't forget to run the following command to generate the package writing-rules.zip file +# Vale uses that ZIP file and not the YAML files. +# +# pnpm docs:zipRules diff --git a/docs/writing-rules/ComponentNameConventions.yml b/docs/writing-rules/ComponentNameConventions.yml index 72d25774783f4a..df3c31e4984702 100644 --- a/docs/writing-rules/ComponentNameConventions.yml +++ b/docs/writing-rules/ComponentNameConventions.yml @@ -10,3 +10,7 @@ swap: 'Sparkline Chart': Sparkline 'Gauge Chart': Gauge 'Treemap Chart': Treemap +# Don't forget to run the following command to generate the package writing-rules.zip file +# Vale uses that ZIP file and not the YAML files. +# +# pnpm docs:zipRules diff --git a/docs/writing-rules/ComposedWords.yml b/docs/writing-rules/ComposedWords.yml index 8d41db7534f630..0821b0025a92a3 100644 --- a/docs/writing-rules/ComposedWords.yml +++ b/docs/writing-rules/ComposedWords.yml @@ -13,3 +13,7 @@ swap: 'usecase': 'use case' 'client side': 'client-side' 'server side': 'server-side' +# Don't forget to run the following command to generate the package writing-rules.zip file +# Vale uses that ZIP file and not the YAML files. +# +# pnpm docs:zipRules diff --git a/docs/writing-rules/NamingConventions.yml b/docs/writing-rules/NamingConventions.yml index ac0e3668f9fc45..1a1842788b78c4 100644 --- a/docs/writing-rules/NamingConventions.yml +++ b/docs/writing-rules/NamingConventions.yml @@ -17,3 +17,7 @@ swap: Css: CSS NPM: npm # https://css-tricks.com/start-sentence-npm/ Github: GitHub +# Don't forget to run the following command to generate the package writing-rules.zip file +# Vale uses that ZIP file and not the YAML files. +# +# pnpm docs:zipRules diff --git a/docs/writing-rules/NoCompanyName.yml b/docs/writing-rules/NoCompanyName.yml index a60b3c3bc2d78f..19e4d50efe0a1a 100644 --- a/docs/writing-rules/NoCompanyName.yml +++ b/docs/writing-rules/NoCompanyName.yml @@ -12,3 +12,8 @@ exceptions: - 'MUI Toolpad' - 'MUI Connect' - 'MUI organization' # valid use of a regular space + +# Don't forget to run the following command to generate the package writing-rules.zip file +# Vale uses that ZIP file and not the YAML files. +# +# pnpm docs:zipRules diff --git a/docs/writing-rules/Typos.yml b/docs/writing-rules/Typos.yml index 9397f615325054..c0f85dc4bacf4a 100644 --- a/docs/writing-rules/Typos.yml +++ b/docs/writing-rules/Typos.yml @@ -9,3 +9,7 @@ swap: eg: e.g. eg.: e.g. 'e.g ': 'e.g. ' +# Don't forget to run the following command to generate the package writing-rules.zip file +# Vale uses that ZIP file and not the YAML files. +# +# pnpm docs:zipRules