| # Vale configuration for kernel.org documentation |
| # https://vale.sh/docs/ |
| |
| StylesPath = .vale/styles |
| Vocab = korg |
| |
| MinAlertLevel = suggestion |
| |
| Packages = Google, write-good, proselint |
| |
| [*.rst] |
| BasedOnStyles = Vale, Google, write-good, proselint, korg |
| |
| # Disable E-Prime (avoiding "is/are/be") - too restrictive for technical docs |
| write-good.E-Prime = NO |
| |
| # Disable contraction suggestions - formal technical docs avoid contractions |
| Google.Contractions = NO |
| |
| # Disable rules that conflict with technical documentation style |
| Google.Acronyms = NO |
| Google.We = NO |
| Google.Will = NO |
| Google.FirstPerson = NO |
| |
| # Headings use command/term names, not sentences |
| Google.Headings = NO |
| |
| # Parentheses are common in technical docs for clarification |
| Google.Parens = NO |
| |
| # Passive voice is acceptable in technical documentation |
| Google.Passive = NO |
| write-good.Passive = NO |
| |
| # "There is/are" constructs are acceptable |
| write-good.ThereIs = NO |
| |
| # Relax wordiness checks - technical docs often need precision over brevity |
| write-good.TooWordy = suggestion |
| write-good.Weasel = suggestion |
| |
| # Allow e.g., i.e., etc. - common in technical documentation |
| Google.Latin = NO |
| |
| # Use custom GenderBias rule (korg.GenderBias) that excludes "mailman" (software name) |
| Google.GenderBias = NO |
| proselint.GenderBias = NO |
| |
| # Downgrade strict style rules to warnings |
| Google.Quotes = warning |
| Google.Exclamation = warning |
| |
| # Disable term case enforcement - technical terms appear in mixed contexts |
| # (e.g., "ssh" in commands vs "SSH" in prose) |
| Vale.Terms = NO |
