|  | 
|  | 1 | +# Vale Configuration for Mintlify Docs | 
|  | 2 | + | 
|  | 3 | +This directory contains the Vale linting configuration for Mintlify documentation. | 
|  | 4 | + | 
|  | 5 | +## Philosophy | 
|  | 6 | + | 
|  | 7 | +Start simple and grow incrementally as needs emerge. The current setup uses: | 
|  | 8 | + | 
|  | 9 | +- Core Mintlify-specific vocabulary | 
|  | 10 | +- Customized rules from the Google developer documentation style guide | 
|  | 11 | + | 
|  | 12 | +## Vale files | 
|  | 13 | +- `.vale.ini` - Main configuration file | 
|  | 14 | +- `styles/config/vocabularies/Mintlify/` - Mintlify-specific terms | 
|  | 15 | +- `styles/Google/` - Google developer documentation style rules customized for Mintlify docs | 
|  | 16 | + | 
|  | 17 | +## When to add vocabulary | 
|  | 18 | +- **Mintlify terms** - New components, features, platform-specific concepts | 
|  | 19 | +- **Frequent false positives** - Any terms that repeatedly trigger spelling errors, but shouldn't | 
|  | 20 | + | 
|  | 21 | +### Discover new vocabulary | 
|  | 22 | +Use the included script to find vocabulary candidates: | 
|  | 23 | +```bash | 
|  | 24 | +# Discover terms from all files | 
|  | 25 | +.vale/scripts/discover-vocabulary.sh | 
|  | 26 | + | 
|  | 27 | +# Discover from specific files | 
|  | 28 | +.vale/scripts/discover-vocabulary.sh "components/*.mdx" | 
|  | 29 | +``` | 
|  | 30 | + | 
|  | 31 | +This script: | 
|  | 32 | +1. Runs Vale on specified files | 
|  | 33 | +2. Extracts spelling error suggestions | 
|  | 34 | +3. Saves results to `.vale/vocabulary-candidates.txt` | 
|  | 35 | + | 
|  | 36 | +## When to add new rules | 
|  | 37 | +- **Consistent patterns** - The same style issue appears frequently | 
|  | 38 | +- **High-value, low-noise** - Rules that catch problems with minimal false positives | 
|  | 39 | + | 
|  | 40 | +### Testing new rules | 
|  | 41 | +Before adding a new rule: | 
|  | 42 | +1. Test locally: `vale path/to/file.mdx` | 
|  | 43 | +2. Run on sample files: `vale components/*.mdx` | 
|  | 44 | +3. Check false positive rate | 
|  | 45 | +4. Start with `level: suggestion` then promote to `warning` or `error` | 
0 commit comments