.vale.ini

StylesPath = .vale/styles
MinAlertLevel = warning

Packages = Google, write-good

Vocab = Smallstep

SkippedScopes = script, style, pre, figure, code
IgnoredScopes = code, tt, img, url, a

[*.{md,mdx}]
BasedOnStyles = Vale, Google, write-good, Smallstep

# Disable Vale.Terms - conflicts with case-variant vocabulary entries
Vale.Terms = NO

# Disable Google.Quotes - technical docs often place punctuation outside quotes for clarity
Google.Quotes = NO

# Disable rules that are too strict for technical documentation
write-good.Passive = NO
Google.Will = NO
Google.We = NO

# Disable overly aggressive write-good rules
# TooWordy flags common tech terms like "implement", "multiple", "additional", "obtain"
write-good.TooWordy = NO
# Weasel flags words like "usually", "various" which are often appropriate in docs
write-good.Weasel = NO

# Units rule requires spaces in durations like "168h" which doesn't match Go conventions
Google.Units = NO

# WordList substitutions like CLI→"command-line tool" and "application"→"app" don't fit tech docs
Google.WordList = NO

# FirstPerson rule doesn't fit docs with user-perspective examples ("I want to...", "My device...")
Google.FirstPerson = NO

# Exclamation points are sometimes appropriate for friendly/community content
Google.Exclamation = NO

# Slang like "TL;DR" is acceptable in developer-focused technical documentation
Google.Slang = NO

# "There is/There are" constructions are acceptable in technical documentation
write-good.ThereIs = NO

# DateFormat matches version numbers like "10.0.15063" incorrectly
Google.DateFormat = NO


TokenIgnores = (@smallstep/[a-zA-Z0-9-]+), \
               (_[a-zA-Z0-9_]+_), \
               ([a-zA-Z]+_[a-zA-Z_]+)

BlockIgnores = (?s)<Alert.*?</Alert>, \
               (?s)<CodeBlock.*?</CodeBlock>, \
               (?s)<Code>.*?</Code>, \
               (?s)^---\n.*?\n---