22
33This directory contains the Vale linting configuration for Mintlify documentation.
44
5- ## Philosophy
5+ ## Philosophy .
66
77Start simple and grow incrementally as needs emerge. The current setup uses:
88
99- Core Mintlify-specific vocabulary
1010- Customized rules from the Google developer documentation style guide
1111
1212## Vale files
13+
1314- ` .vale.ini ` - Main configuration file
1415- ` styles/config/vocabularies/Mintlify/ ` - Mintlify-specific terms
1516- ` styles/Google/ ` - Google developer documentation style rules customized for Mintlify docs
1617
1718## When to add vocabulary
19+
1820- ** Mintlify terms** - New components, features, platform-specific concepts
1921- ** Frequent false positives** - Any terms that repeatedly trigger spelling errors, but shouldn't
2022
2123### Discover new vocabulary
24+
2225Use the included script to find vocabulary candidates:
26+
2327``` bash
2428# Discover terms from all files
2529.vale/scripts/discover-vocabulary.sh
@@ -29,17 +33,21 @@ Use the included script to find vocabulary candidates:
2933```
3034
3135This script:
36+
32371 . Runs Vale on specified files
33382 . Extracts spelling error suggestions
34393 . Saves results to ` .vale/vocabulary-candidates.txt `
3540
3641## When to add new rules
42+
3743- ** Consistent patterns** - The same style issue appears frequently
3844- ** High-value, low-noise** - Rules that catch problems with minimal false positives
3945
4046### Testing new rules
47+
4148Before adding a new rule:
49+
42501 . Test locally: ` vale path/to/file.mdx `
43512 . Run on sample files: ` vale components/*.mdx `
44523 . Check false positive rate
45- 4 . Start with ` level: suggestion ` then promote to ` warning ` or ` error `
53+ 4 . Start with ` level: suggestion ` then promote to ` warning ` or ` error `
0 commit comments