Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions .vale/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,28 @@

This directory contains the Vale linting configuration for Mintlify documentation.

## Philosophy
## Philosophy .

Start simple and grow incrementally as needs emerge. The current setup uses:

- Core Mintlify-specific vocabulary
- Customized rules from the Google developer documentation style guide

## Vale files

- `.vale.ini` - Main configuration file
- `styles/config/vocabularies/Mintlify/` - Mintlify-specific terms
- `styles/Google/` - Google developer documentation style rules customized for Mintlify docs

## When to add vocabulary

- **Mintlify terms** - New components, features, platform-specific concepts
- **Frequent false positives** - Any terms that repeatedly trigger spelling errors, but shouldn't

### Discover new vocabulary

Use the included script to find vocabulary candidates:

```bash
# Discover terms from all files
.vale/scripts/discover-vocabulary.sh
Expand All @@ -29,17 +33,21 @@ Use the included script to find vocabulary candidates:
```

This script:

1. Runs Vale on specified files
2. Extracts spelling error suggestions
3. Saves results to `.vale/vocabulary-candidates.txt`

## When to add new rules

- **Consistent patterns** - The same style issue appears frequently
- **High-value, low-noise** - Rules that catch problems with minimal false positives

### Testing new rules

Before adding a new rule:

1. Test locally: `vale path/to/file.mdx`
2. Run on sample files: `vale components/*.mdx`
3. Check false positive rate
4. Start with `level: suggestion` then promote to `warning` or `error`
4. Start with `level: suggestion` then promote to `warning` or `error`
Loading