Skip to content

Commit 702d39b

Browse files
committed
add instruction
1 parent f0982e0 commit 702d39b

6 files changed

+25
-0
lines changed

docs/writing-rules/BrandName.yml

+4
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,7 @@ swap:
1414
MUI Core: MUI Core
1515
MUI Toolpad: MUI Toolpad
1616
MUI Connect: MUI Connect
17+
# Don't forget to run the following command to generate the package writing-rules.zip file
18+
# Vale uses that ZIP file and not the YAML files.
19+
#
20+
# pnpm docs:zipRules

docs/writing-rules/ComponentNameConventions.yml

+4
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,7 @@ swap:
1010
'Sparkline Chart': Sparkline
1111
'Gauge Chart': Gauge
1212
'Treemap Chart': Treemap
13+
# Don't forget to run the following command to generate the package writing-rules.zip file
14+
# Vale uses that ZIP file and not the YAML files.
15+
#
16+
# pnpm docs:zipRules

docs/writing-rules/ComposedWords.yml

+4
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,7 @@ swap:
1313
'usecase': 'use case'
1414
'client side': 'client-side'
1515
'server side': 'server-side'
16+
# Don't forget to run the following command to generate the package writing-rules.zip file
17+
# Vale uses that ZIP file and not the YAML files.
18+
#
19+
# pnpm docs:zipRules

docs/writing-rules/NamingConventions.yml

+4
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,7 @@ swap:
1717
Css: CSS
1818
NPM: npm # https://css-tricks.com/start-sentence-npm/
1919
Github: GitHub
20+
# Don't forget to run the following command to generate the package writing-rules.zip file
21+
# Vale uses that ZIP file and not the YAML files.
22+
#
23+
# pnpm docs:zipRules

docs/writing-rules/NoCompanyName.yml

+5
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,8 @@ exceptions:
1212
- 'MUI Toolpad'
1313
- 'MUI Connect'
1414
- 'MUI organization' # valid use of a regular space
15+
16+
# Don't forget to run the following command to generate the package writing-rules.zip file
17+
# Vale uses that ZIP file and not the YAML files.
18+
#
19+
# pnpm docs:zipRules

docs/writing-rules/Typos.yml

+4
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,7 @@ swap:
99
eg: e.g.
1010
eg.: e.g.
1111
'e.g ': 'e.g. '
12+
# Don't forget to run the following command to generate the package writing-rules.zip file
13+
# Vale uses that ZIP file and not the YAML files.
14+
#
15+
# pnpm docs:zipRules

0 commit comments

Comments
 (0)