This directory contains the Vale linting configuration for Mintlify documentation.
Start simple and grow incrementally as needs emerge.
.vale.ini- Main configuration filestyles/config/vocabularies/Mintlify/- Mintlify-specific termsstyles/Mintlify/- Style rules derived from the Google developer documentation style and customized for Mintlify
- Mintlify terms - New components, features, platform-specific concepts
- Frequent false positives - Any terms that repeatedly trigger errors, but shouldn't
Use the included script to find vocabulary candidates:
# Discover terms from all files
.vale/scripts/discover-vocabulary.sh
# Discover from specific files
.vale/scripts/discover-vocabulary.sh "components/*.mdx"This script:
- Runs Vale on specified files
- Extracts spelling error suggestions
- Saves results to
.vale/vocabulary-candidates.txt
- Consistent patterns - The same style issue appears frequently
- High-value, low-noise - Rules that catch problems with minimal false positives
Before adding a new rule:
- Test locally:
vale path/to/file.mdx - Run on sample files:
vale components/*.mdx - Check false positive rate
- Start with
level: suggestionthen promote towarningorerror