# Vale configuration for devx documentation
# https://vale.sh/docs/

StylesPath = .vale/styles

# Packages are downloaded via `vale sync`
Packages = write-good, Google, Readability

# Minimum alert level to display (suggestion, warning, error)
MinAlertLevel = warning

# Project vocabulary — terms not flagged as spelling errors
Vocab = devx

[*.{md}]
# Enable style guides
BasedOnStyles = Vale, write-good, Google, Readability, devx

# Google style — relax rules too strict for technical docs
Google.Contractions = NO
Google.WordList = NO
Google.Acronyms = NO
Google.We = NO
Google.Will = NO
Google.Colons = NO
Google.Headings = NO
Google.EmDash = NO
Google.Units = NO

# write-good — relax rules too strict for technical writing
write-good.E-Prime = NO
write-good.So = NO
write-good.ThereIs = NO
write-good.TooWordy = NO
write-good.Passive = NO

# Vale defaults — spelling catches too many technical terms
Vale.Terms = NO
Vale.Repetition = NO
Vale.Spelling = NO

# Readability — technical docs are naturally complex, downgrade to suggestions
Readability.FleschReadingEase = suggestion
Readability.FleschKincaid = suggestion
Readability.AutomatedReadability = suggestion
Readability.ColemanLiau = suggestion
Readability.LIX = suggestion
Readability.GunningFog = suggestion
Readability.SMOG = suggestion