docs/.vale.ini at main · ArcadeAI/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# Vale configuration for Arcade docs
# Using Google Developer Documentation Style Guide as base

StylesPath = styles

MinAlertLevel = suggestion

# Downloaded via `vale sync` - these go to styles/<Package>/
Packages = Google, write-good, alex

# Project-specific vocabulary (committed to repo)
Vocab = Arcade

[*.mdx]
BasedOnStyles = Google, write-good, alex, Arcade

# Ignore code blocks, inline code, and className/class attributes
BlockIgnores = (?s)```[\s\S]*?```
TokenIgnores = (`[^`]+`|className="[^"]*"|className='[^']*'|class="[^"]*"|class='[^']*')

# --- Disable noisy/unhelpful rules ---

# Code-related false positives
Google.Parens = NO
Google.Spacing = NO
Google.Quotes = NO

# JSX className attributes cause false positives (e.g., my-4, mx-2)
Google.FirstPerson = NO

# Use Arcade.WordList instead (handles sentence-initial capitalization better)
Google.WordList = NO

# Too strict for technical docs
write-good.E-Prime = NO
write-good.TooWordy = NO
Google.Contractions = NO
Google.Will = NO

# "execute" etc. flagged as profanity - not useful for tech docs
alex.ProfanityUnlikely = NO

# "disabled" is valid in tech contexts (disabled buttons, disabled features)
alex.Ablist = NO

# Ellipses are valid in code examples and UI text
Google.Ellipses = NO

# Acronyms like API, SDK, MCP are standard in our docs
Google.Acronyms = NO

# Disable duplicate passive voice rule (Google.Passive covers this)
write-good.Passive = NO

# --- Keep enabled ---
# Passive voice: Google.Passive
# Toxic/harmful language checks (important!)
# Good style rules (WordList, FirstPerson, We, Ellipses, Exclamation)

[*.md]
BasedOnStyles = Google, write-good, alex, Arcade

# Ignore code blocks, inline code, and className/class attributes
BlockIgnores = (?s)```[\s\S]*?```
TokenIgnores = (`[^`]+`|className="[^"]*"|className='[^']*'|class="[^"]*"|class='[^']*')

# Same rules for .md files
Google.Parens = NO
Google.Spacing = NO
Google.Quotes = NO
Google.FirstPerson = NO
Google.WordList = NO  # Use Arcade.WordList instead
write-good.E-Prime = NO
write-good.TooWordy = NO
Google.Contractions = NO
Google.Will = NO
alex.ProfanityUnlikely = NO
alex.Ablist = NO
Google.Ellipses = NO
Google.Acronyms = NO
write-good.Passive = NO