docs: Add Vale documentation linting with custom brand guidelines - #4228
jackzampolin wants to merge 1 commit into
Conversation
- Configures Vale 3.x with DefraDB custom style rules - Creates 11 custom rules based on brand messaging guidelines - Integrates with Makefile (lint:docs target) - Adds GitHub Actions workflow for PR documentation linting - Includes vocabulary files with 60+ approved technical terms - Provides comprehensive setup and usage documentation Vale enforces: - Product name consistency (DefraDB, SourceHub, Orbis, LensVM) - Technical terminology (edge-first, Edge AI, open source) - Voice and tone (developer-focused, direct language) - Removal of corporate buzzwords and weak language 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
VALE_SETUP_SUMMARY.md|1 col 38| [Google.Exclamation] Don't use exclamation points in text.
VALE_SETUP_SUMMARY.md|3 col 10| [write-good.E-Prime] Try to avoid using 'been'.
VALE_SETUP_SUMMARY.md|5 col 4| [Google.Headings] '📦 What Was Created' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|5 col 11| [Google.Passive] In general, use active voice instead of passive voice ('Was Created').
VALE_SETUP_SUMMARY.md|5 col 11| [write-good.Passive] 'Was Created' may be passive voice. Use active voice if you can.
VALE_SETUP_SUMMARY.md|5 col 11| [write-good.E-Prime] Try to avoid using 'Was'.
VALE_SETUP_SUMMARY.md|7 col 5| [Google.Headings] 'Configuration Files' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|9 col 71| [DefraDB.Acronyms] Define acronym 'PR' on first use in this document
VALE_SETUP_SUMMARY.md|12 col 5| [Google.Headings] 'Custom DefraDB Style Rules (11 rules)' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|12 col 32| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|14 col 6| [Google.Headings] '🔴 Error Level (Branding & Consistency)' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|14 col 20| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|16 col 83| [DefraDB.Acronyms] Define acronym 'AI' on first use in this document
VALE_SETUP_SUMMARY.md|18 col 6| [Google.Headings] '🟡 Warning Level (Style & Voice)' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|18 col 22| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|19 col 45| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|19 col 46| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'leverage' - be specific and direct instead
VALE_SETUP_SUMMARY.md|19 col 46| [Vale.Avoid] Avoid using 'leverage'.
VALE_SETUP_SUMMARY.md|19 col 56| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'synergistic' - be specific and direct instead
VALE_SETUP_SUMMARY.md|19 col 56| [Vale.Avoid] Avoid using 'synergistic'.
VALE_SETUP_SUMMARY.md|19 col 69| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'cutting-edge' - be specific and direct instead
VALE_SETUP_SUMMARY.md|20 col 57| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|20 col 58| [Google.Quotes] Commas and periods go inside quotation marks.
VALE_SETUP_SUMMARY.md|20 col 59| [DefraDB.GrandioseClaims] Avoid unsupported claim 'the best' - provide specific evidence or proof instead
VALE_SETUP_SUMMARY.md|21 col 55| [DefraDB.SourceStack] Use 'Source stack' instead of 'Source stack' - Source is a stack, not a platform
VALE_SETUP_SUMMARY.md|24 col 6| [Google.Headings] '🔵 Suggestion Level (Writing Quality)' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|24 col 25| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|25 col 44| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|25 col 45| [Vale.Avoid] Avoid using 'simply'.
VALE_SETUP_SUMMARY.md|25 col 45| [DefraDB.Hedging] Remove hedging word 'simply' - be direct and confident
VALE_SETUP_SUMMARY.md|25 col 53| [Vale.Avoid] Avoid using 'just'.
VALE_SETUP_SUMMARY.md|25 col 53| [DefraDB.Hedging] Remove hedging word 'just' - be direct and confident
VALE_SETUP_SUMMARY.md|25 col 59| [Vale.Avoid] Avoid using 'easily'.
VALE_SETUP_SUMMARY.md|25 col 59| [DefraDB.Hedging] Remove hedging word 'easily' - be direct and confident
VALE_SETUP_SUMMARY.md|31 col 5| [Google.Headings] 'Vocabulary Files' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|38 col 5| [Vale.Spelling] Did you really mean 'Makefile'?
VALE_SETUP_SUMMARY.md|42 col 42| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|44 col 4| [Google.Headings] '🎯 Current Status' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|47 col 18| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|48 col 19| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|49 col 22| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|51 col 1| [write-good.Passive] 'is expected' may be passive voice. Use active voice if you can.
VALE_SETUP_SUMMARY.md|51 col 1| [Google.Passive] In general, use active voice instead of passive voice ('is expected').
VALE_SETUP_SUMMARY.md|51 col 1| [Google.Exclamation] Don't use exclamation points in text.
VALE_SETUP_SUMMARY.md|51 col 6| [write-good.E-Prime] Try to avoid using 'is'.
VALE_SETUP_SUMMARY.md|51 col 37| [write-good.E-Prime] Try to avoid using 'is'.
VALE_SETUP_SUMMARY.md|53 col 4| [Google.Headings] '🚀 Quick Start' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|55 col 5| [Google.Headings] '1. Run Vale Locally' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|71 col 5| [Google.Headings] '2. Understand Output' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|84 col 5| [Google.Headings] '3. Fix Issues Gradually' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|86 col 13| [Google.Colons] ': F' should be in lowercase.
VALE_SETUP_SUMMARY.md|86 col 28| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|92 col 13| [Google.Colons] ': F' should be in lowercase.
VALE_SETUP_SUMMARY.md|93 col 13| [Google.Colons] ': C' should be in lowercase.
VALE_SETUP_SUMMARY.md|95 col 5| [Google.Headings] '4. Disable Rules When Needed' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|107 col 6| [DefraDB.Acronyms] Define acronym 'CI' on first use in this document
VALE_SETUP_SUMMARY.md|107 col 9| [DefraDB.Acronyms] Define acronym 'CD' on first use in this document
VALE_SETUP_SUMMARY.md|109 col 41| [write-good.TooWordy] 'modify' is too wordy.
VALE_SETUP_SUMMARY.md|111 col 26| [DefraDB.Acronyms] Define acronym 'PR' on first use in this document
VALE_SETUP_SUMMARY.md|112 col 34| [Google.Passive] In general, use active voice instead of passive voice ('are violated').
VALE_SETUP_SUMMARY.md|112 col 34| [write-good.Passive] 'are violated' may be passive voice. Use active voice if you can.
VALE_SETUP_SUMMARY.md|112 col 34| [write-good.E-Prime] Try to avoid using 'are'.
VALE_SETUP_SUMMARY.md|113 col 46| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|116 col 4| [Google.Headings] '📝 Rule Examples from Brand Guidelines' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|118 col 5| [Google.Headings] 'Product Names (Error)' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|118 col 19| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|127 col 5| [Google.Headings] 'Tech Terms (Error)' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|127 col 16| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|136 col 5| [Google.Headings] 'Corporate Speak (Warning)' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|136 col 21| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|145 col 5| [Google.Headings] 'Hedging Language (Suggestion)' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|145 col 22| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|154 col 5| [Google.Headings] 'Voice (Suggestion)' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|154 col 11| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|160 col 4| [Google.Headings] '📊 Next Steps' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|162 col 5| [Google.Headings] '1. Triage Issues (Recommended Approach)' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|162 col 22| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|164 col 9| [Google.Colons] ': F' should be in lowercase.
VALE_SETUP_SUMMARY.md|169 col 11| [Google.Colons] ': A' should be in lowercase.
VALE_SETUP_SUMMARY.md|175 col 9| [Google.Colons] ': R' should be in lowercase.
VALE_SETUP_SUMMARY.md|180 col 5| [Google.Headings] '2. Update Vocabulary' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|187 col 5| [Google.Headings] '3. Refine Rules' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|189 col 11| [write-good.E-Prime] Try to avoid using 'is'.
VALE_SETUP_SUMMARY.md|191 col 19| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|195 col 5| [Google.Headings] '4. Integrate into Workflow' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|195 col 5| [DefraDB.Headings] Headings should use title case: '4. Integrate into Workflow'
VALE_SETUP_SUMMARY.md|198 col 28| [Vale.Spelling] Did you really mean 'VSCode'?
VALE_SETUP_SUMMARY.md|203 col 5| [Google.Headings] 'Add New Rules' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|205 col 12| [DefraDB.Acronyms] Define acronym 'YAML' on first use in this document
VALE_SETUP_SUMMARY.md|218 col 5| [Google.Headings] 'Adjust Severity' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|221 col 22| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|222 col 26| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|223 col 34| [Google.Parens] Use parentheses judiciously.
VALE_SETUP_SUMMARY.md|225 col 5| [Google.Headings] 'Update Vocabulary' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|236 col 5| [DefraDB.Headings] Headings should use title case: '"Package not found"'
VALE_SETUP_SUMMARY.md|241 col 5| [DefraDB.Headings] Headings should use title case: 'Too many errors initially'
VALE_SETUP_SUMMARY.md|250 col 5| [DefraDB.Headings] Headings should use title case: 'False positives'
VALE_SETUP_SUMMARY.md|262 col 4| [Google.Headings] '🎉 Success Metrics' should use sentence-style capitalization.
VALE_SETUP_SUMMARY.md|269 col 35| [DefraDB.Acronyms] Define acronym 'CI' on first use in this document
VALE_SETUP_SUMMARY.md|277 col 7| [Google.Exclamation] Don't use exclamation points in text.
Makefile|137 col 3| [Google.Parens] Use parentheses judiciously.
Makefile|137 col 9| [DefraDB.Acronyms] Define acronym 'YAML' on first use in this document
Makefile|137 col 22| [Vale.Spelling] Did you really mean 'yamllint'?
Makefile|138 col 1| [Vale.Spelling] Did you really mean 'endif'?
Makefile|140 col 2| [Google.Acronyms] Spell out 'PHONY', if it's unfamiliar to the audience.
Makefile|140 col 2| [DefraDB.Acronyms] Define acronym 'PHONY' on first use in this document
Makefile|142 col 1| [Vale.Spelling] Did you really mean 'ifeq'?
Makefile|142 col 6| [Google.Parens] Use parentheses judiciously.
Makefile|143 col 3| [Google.Parens] Use parentheses judiciously.
Makefile|143 col 77| [Google.Ellipses] In general, don't use an ellipsis.
Makefile|144 col 1| [Vale.Spelling] Did you really mean 'ifeq'?
Makefile|144 col 6| [Google.Parens] Use parentheses judiciously.
Makefile|146 col 6| [Vale.Spelling] Did you really mean 'ifeq'?
Makefile|146 col 11| [Google.Parens] Use parentheses judiciously.
Makefile|147 col 3| [Google.Parens] Use parentheses judiciously.
Makefile|149 col 3| [Google.Parens] Use parentheses judiciously.
Makefile|150 col 1| [Vale.Spelling] Did you really mean 'endif'?
Makefile|152 col 3| [Google.Parens] Use parentheses judiciously.
Makefile|153 col 1| [Vale.Spelling] Did you really mean 'endif'?
Makefile|155 col 2| [Google.Acronyms] Spell out 'PHONY', if it's unfamiliar to the audience.
Makefile|155 col 2| [DefraDB.Acronyms] Define acronym 'PHONY' on first use in this document
Makefile|159 col 2| [DefraDB.Acronyms] Define acronym 'PHONY' on first use in this document
Makefile|159 col 2| [Google.Acronyms] Spell out 'PHONY', if it's unfamiliar to the audience.
Makefile|161 col 4| [Google.Parens] Use parentheses judiciously.
Makefile|161 col 5| [DefraDB.Acronyms] Define acronym 'MAKE' on first use in this document
Makefile|161 col 5| [Google.Acronyms] Spell out 'MAKE', if it's unfamiliar to the audience.
Makefile|162 col 3| [Google.Parens] Use parentheses judiciously.
Makefile|162 col 4| [Google.Acronyms] Spell out 'MAKE', if it's unfamiliar to the audience.
Makefile|162 col 4| [DefraDB.Acronyms] Define acronym 'MAKE' on first use in this document
Makefile|163 col 3| [Google.Parens] Use parentheses judiciously.
Makefile|163 col 4| [Google.Acronyms] Spell out 'MAKE', if it's unfamiliar to the audience.
Makefile|163 col 4| [DefraDB.Acronyms] Define acronym 'MAKE' on first use in this document
Makefile|165 col 2| [Google.Acronyms] Spell out 'PHONY', if it's unfamiliar to the audience.
Makefile|165 col 2| [DefraDB.Acronyms] Define acronym 'PHONY' on first use in this document
Makefile|415 col 2| [Google.Acronyms] Spell out 'PHONY', if it's unfamiliar to the audience.
Makefile|415 col 2| [DefraDB.Acronyms] Define acronym 'PHONY' on first use in this document
Makefile|417 col 2| [Vale.Spelling] Did you really mean 'rg'?
Makefile|417 col 6| [Vale.Spelling] Did you really mean 'nolint'?
Makefile|419 col 2| [Google.Acronyms] Spell out 'PHONY', if it's unfamiliar to the audience.
Makefile|419 col 2| [DefraDB.Acronyms] Define acronym 'PHONY' on first use in this document
Makefile|423 col 2| [Google.Acronyms] Spell out 'PHONY', if it's unfamiliar to the audience.
Makefile|423 col 2| [DefraDB.Acronyms] Define acronym 'PHONY' on first use in this document
Makefile|425 col 42| [Google.Ellipses] In general, don't use an ellipsis.
Makefile|427 col 40| [DefraDB.Acronyms] Define acronym 'README' on first use in this document
Makefile|429 col 2| [DefraDB.Acronyms] Define acronym 'PHONY' on first use in this document
Makefile|429 col 2| [Google.Acronyms] Spell out 'PHONY', if it's unfamiliar to the audience.
Makefile|431 col 43| [Google.Parens] Use parentheses judiciously.
Makefile|431 col 56| [Google.Ellipses] In general, don't use an ellipsis.
Makefile|433 col 35| [DefraDB.Acronyms] Define acronym 'README' on first use in this document
docs/vale-setup.md|1 col 3| [Google.Headings] 'Vale Documentation Linting' should use sentence-style capitalization.
docs/vale-setup.md|5 col 4| [Google.Headings] 'Quick Start' should use sentence-style capitalization.
docs/vale-setup.md|7 col 5| [Google.Headings] 'Install Vale' should use sentence-style capitalization.
docs/vale-setup.md|27 col 5| [Google.Headings] 'Sync Style Packages' should use sentence-style capitalization.
docs/vale-setup.md|29 col 35| [Google.Parens] Use parentheses judiciously.
docs/vale-setup.md|37 col 5| [Google.Headings] 'Run Vale' should use sentence-style capitalization.
docs/vale-setup.md|44 col 21| [Google.Parens] Use parentheses judiciously.
docs/vale-setup.md|59 col 4| [Google.Headings] 'Understanding Vale Output' should use sentence-style capitalization.
docs/vale-setup.md|63 col 61| [Google.Parens] Use parentheses judiciously.
docs/vale-setup.md|64 col 58| [Google.Parens] Use parentheses judiciously.
docs/vale-setup.md|65 col 53| [Google.Parens] Use parentheses judiciously.
docs/vale-setup.md|80 col 4| [Google.Headings] 'Vale Rules' should use sentence-style capitalization.
docs/vale-setup.md|84 col 5| [Google.Headings] 'Branding & Terminology (Errors)' should use sentence-style capitalization.
docs/vale-setup.md|84 col 28| [Google.Parens] Use parentheses judiciously.
docs/vale-setup.md|87 col 81| [DefraDB.Acronyms] Define acronym 'AI' on first use in this document
docs/vale-setup.md|89 col 5| [Google.Headings] 'Style & Voice (Warnings)' should use sentence-style capitalization.
docs/vale-setup.md|89 col 19| [Google.Parens] Use parentheses judiciously.
docs/vale-setup.md|91 col 43| [Google.Parens] Use parentheses judiciously.
docs/vale-setup.md|91 col 44| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'leverage' - be specific and direct instead
docs/vale-setup.md|91 col 44| [Vale.Avoid] Avoid using 'leverage'.
docs/vale-setup.md|91 col 54| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'synergistic' - be specific and direct instead
docs/vale-setup.md|91 col 54| [Vale.Avoid] Avoid using 'synergistic'.
docs/vale-setup.md|91 col 67| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'cutting-edge' - be specific and direct instead
docs/vale-setup.md|92 col 55| [Google.Parens] Use parentheses judiciously.
docs/vale-setup.md|92 col 56| [Google.Quotes] Commas and periods go inside quotation marks.
docs/vale-setup.md|92 col 57| [DefraDB.GrandioseClaims] Avoid unsupported claim 'the best' - provide specific evidence or proof instead
docs/vale-setup.md|93 col 53| [DefraDB.SourceStack] Use 'Source stack' instead of 'Source stack' - Source is a stack, not a platform
docs/vale-setup.md|96 col 5| [Google.Headings] 'Writing Quality (Suggestions)' should use sentence-style capitalization.
docs/vale-setup.md|96 col 21| [Google.Parens] Use parentheses judiciously.
docs/vale-setup.md|98 col 42| [Google.Parens] Use parentheses judiciously.
docs/vale-setup.md|98 col 43| [DefraDB.Hedging] Remove hedging word 'simply' - be direct and confident
docs/vale-setup.md|98 col 43| [Vale.Avoid] Avoid using 'simply'.
docs/vale-setup.md|98 col 51| [DefraDB.Hedging] Remove hedging word 'just' - be direct and confident
docs/vale-setup.md|98 col 51| [Vale.Avoid] Avoid using 'just'.
docs/vale-setup.md|98 col 57| [DefraDB.Hedging] Remove hedging word 'easily' - be direct and confident
docs/vale-setup.md|98 col 57| [Vale.Avoid] Avoid using 'easily'.
docs/vale-setup.md|104 col 4| [Google.Headings] 'Disabling Rules' should use sentence-style capitalization.
docs/vale-setup.md|106 col 5| [DefraDB.Headings] Headings should use title case: 'Disable for a section'
docs/vale-setup.md|116 col 5| [DefraDB.Headings] Headings should use title case: 'Disable specific rule'
docs/vale-setup.md|126 col 5| [DefraDB.Headings] Headings should use title case: 'Disable entire style'
docs/vale-setup.md|138 col 5| [Google.Headings] 'VS Code' should use sentence-style capitalization.
docs/vale-setup.md|138 col 5| [DefraDB.Acronyms] Define acronym 'VS' on first use in this document
docs/vale-setup.md|140 col 22| [Vale.Spelling] Did you really mean 'VSCode'?
docs/vale-setup.md|141 col 9| [Google.Will] Avoid using 'will'.
docs/vale-setup.md|143 col 5| [Vale.Spelling] Did you really mean 'Neovim'?
docs/vale-setup.md|154 col 5| [Google.Headings] 'Other Editors' should use sentence-style capitalization.
docs/vale-setup.md|156 col 15| [Google.Acronyms] Spell out 'LSP', if it's unfamiliar to the audience.
docs/vale-setup.md|156 col 15| [DefraDB.Acronyms] Define acronym 'LSP' on first use in this document
docs/vale-setup.md|158 col 4| [DefraDB.Acronyms] Define acronym 'CI' on first use in this document
docs/vale-setup.md|158 col 7| [DefraDB.Acronyms] Define acronym 'CD' on first use in this document
docs/vale-setup.md|160 col 51| [write-good.TooWordy] 'modify' is too wordy.
docs/vale-setup.md|164 col 53| [write-good.E-Prime] Try to avoid using 'are'.
docs/vale-setup.md|164 col 53| [write-good.Passive] 'are violated' may be passive voice. Use active voice if you can.
docs/vale-setup.md|164 col 53| [Google.Passive] In general, use active voice instead of passive voice ('are violated').
docs/vale-setup.md|165 col 46| [Google.Parens] Use parentheses judiciously.
docs/vale-setup.md|171 col 1| [Google.Parens] Use parentheses judiciously.
docs/vale-setup.md|172 col 1| [Google.Parens] Use parentheses judiciously.
docs/vale-setup.md|176 col 26| [Google.Parens] Use parentheses judiciously.
docs/vale-setup.md|176 col 27| [Google.WordList] Use 'regular expression' instead of 'regex'.
docs/vale-setup.md|181 col 5| [DefraDB.Headings] Headings should use title case: '"Package not found" error'
docs/vale-setup.md|187 col 5| [DefraDB.Headings] Headings should use title case: 'Vale not finding .vale.ini'
docs/vale-setup.md|189 col 8| [write-good.E-Prime] Try to avoid using 'you're'.
docs/vale-setup.md|189 col 65| [Vale.Spelling] Did you really mean 'config'?
docs/vale-setup.md|195 col 5| [DefraDB.Headings] Headings should use title case: 'False positives'
docs/vale-setup.md|198 col 13| [write-good.E-Prime] Try to avoid using 'it's'.
docs/vale-setup.md|198 col 47| [write-good.E-Prime] Try to avoid using 'be'.
docs/vale-setup.md|202 col 5| [DefraDB.Headings] Headings should use title case: 'Performance issues'
docs/vale-setup.md|204 col 12| [write-good.E-Prime] Try to avoid using 'be'.
docs/vale-setup.md|204 col 23| [DefraDB.Hedging] Remove hedging word 'very' - be direct and confident
docs/vale-setup.md|204 col 23| [write-good.Weasel] 'very' is a weasel word!
docs/vale-setup.md|204 col 23| [Vale.Avoid] Avoid using 'very'.
docs/vale-setup.md|215 col 35| [Google.Parens] Use parentheses judiciously.
styles/DefraDB/Acronyms.yml|4 col 40| [Vale.Terms] Use 'DefraDB' instead of 'defradb'.
styles/DefraDB/Acronyms.yml|4 col 61| [DefraDB.Acronyms] Define acronym 'CONTRIBUTING' on first use in this document
styles/DefraDB/Acronyms.yml|6 col 1| [Vale.Spelling] Did you really mean 'ignorecase'?
styles/DefraDB/Acronyms.yml|7 col 11| [Google.Parens] Use parentheses judiciously.
styles/DefraDB/Acronyms.yml|8 col 10| [Google.Parens] Use parentheses judiciously.
styles/DefraDB/Acronyms.yml|26 col 5| [Google.Acronyms] Spell out 'UDP', if it's unfamiliar to the audience.
styles/DefraDB/Acronyms.yml|28 col 5| [Google.Acronyms] Spell out 'DNS', if it's unfamiliar to the audience.
styles/DefraDB/CorporateSpeak.yml|2 col 43| [write-good.E-Prime] Try to avoid using 'be'.
styles/DefraDB/CorporateSpeak.yml|4 col 40| [Vale.Terms] Use 'DefraDB' instead of 'defradb'.
styles/DefraDB/CorporateSpeak.yml|4 col 61| [DefraDB.Acronyms] Define acronym 'CONTRIBUTING' on first use in this document
styles/DefraDB/CorporateSpeak.yml|5 col 1| [Vale.Spelling] Did you really mean 'ignorecase'?
styles/DefraDB/CorporateSpeak.yml|9 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'leverage' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|9 col 5| [Vale.Avoid] Avoid using 'leverage'.
styles/DefraDB/CorporateSpeak.yml|10 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'leveraging' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|11 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'synergy' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|11 col 5| [Vale.Avoid] Avoid using 'synergy'.
styles/DefraDB/CorporateSpeak.yml|12 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'synergistic' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|12 col 5| [Vale.Avoid] Avoid using 'synergistic'.
styles/DefraDB/CorporateSpeak.yml|13 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'synergies' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|14 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'cutting-edge' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|15 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'revolutionary' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|16 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'revolutionize' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|17 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'unparalleled' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|18 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'best-in-class' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|18 col 5| [Vale.Avoid] Avoid using 'best-in-class'.
styles/DefraDB/CorporateSpeak.yml|19 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'world-class' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|19 col 5| [Vale.Avoid] Avoid using 'world-class'.
styles/DefraDB/CorporateSpeak.yml|20 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'paradigm shift' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|20 col 5| [Vale.Avoid] Avoid using 'paradigm shift'.
styles/DefraDB/CorporateSpeak.yml|21 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'next-generation' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|22 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'enterprise-grade' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|23 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'mission-critical' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|24 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'turnkey' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|25 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'seamlessly' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|26 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'holistic' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|27 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'robust solution' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|28 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'comprehensive solution' - be specific and direct instead
styles/DefraDB/CorporateSpeak.yml|29 col 5| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'end-to-end solution' - be specific and direct instead
styles/DefraDB/GrandioseClaims.yml|4 col 40| [Vale.Terms] Use 'DefraDB' instead of 'defradb'.
styles/DefraDB/GrandioseClaims.yml|4 col 61| [DefraDB.Acronyms] Define acronym 'CONTRIBUTING' on first use in this document
styles/DefraDB/GrandioseClaims.yml|5 col 1| [Vale.Spelling] Did you really mean 'ignorecase'?
styles/DefraDB/GrandioseClaims.yml|7 col 1| [Vale.Spelling] Did you really mean 'nonword'?
styles/DefraDB/GrandioseClaims.yml|9 col 5| [DefraDB.GrandioseClaims] Avoid unsupported claim 'the best' - provide specific evidence or proof instead
styles/DefraDB/GrandioseClaims.yml|10 col 5| [DefraDB.GrandioseClaims] Avoid unsupported claim 'the leading' - provide specific evidence or proof instead
styles/DefraDB/GrandioseClaims.yml|11 col 5| [DefraDB.GrandioseClaims] Avoid unsupported claim 'the most secure' - provide specific evidence or proof instead
styles/DefraDB/GrandioseClaims.yml|12 col 5| [DefraDB.GrandioseClaims] Avoid unsupported claim 'the fastest' - provide specific evidence or proof instead
styles/DefraDB/GrandioseClaims.yml|13 col 5| [DefraDB.GrandioseClaims] Avoid unsupported claim 'the only' - provide specific evidence or proof instead
styles/DefraDB/GrandioseClaims.yml|14 col 5| [DefraDB.GrandioseClaims] Avoid unsupported claim 'the ultimate' - provide specific evidence or proof instead
styles/DefraDB/GrandioseClaims.yml|15 col 5| [DefraDB.GrandioseClaims] Avoid unsupported claim 'the perfect' - provide specific evidence or proof instead
styles/DefraDB/GrandioseClaims.yml|16 col 5| [DefraDB.GrandioseClaims] Avoid unsupported claim 'the ideal' - provide specific evidence or proof instead
styles/DefraDB/GrandioseClaims.yml|17 col 5| [DefraDB.GrandioseClaims] Avoid unsupported claim 'industry-leading' - provide specific evidence or proof instead
styles/DefraDB/GrandioseClaims.yml|18 col 5| [DefraDB.GrandioseClaims] Avoid unsupported claim 'market-leading' - provide specific evidence or proof instead
styles/DefraDB/GrandioseClaims.yml|19 col 5| [DefraDB.GrandioseClaims] Avoid unsupported claim 'award-winning' - provide specific evidence or proof instead
styles/DefraDB/GrandioseClaims.yml|20 col 5| [DefraDB.GrandioseClaims] Avoid unsupported claim 'groundbreaking' - provide specific evidence or proof instead
styles/DefraDB/GrandioseClaims.yml|21 col 6| [DefraDB.GrandioseClaims] Avoid unsupported claim 'number one' - provide specific evidence or proof instead
styles/DefraDB/GrandioseClaims.yml|22 col 6| [DefraDB.GrandioseClaims] Avoid unsupported claim '#1' - provide specific evidence or proof instead
styles/DefraDB/Headings.yml|4 col 40| [Vale.Terms] Use 'DefraDB' instead of 'defradb'.
styles/DefraDB/Headings.yml|4 col 61| [DefraDB.Acronyms] Define acronym 'CONTRIBUTING' on first use in this document
styles/DefraDB/Headings.yml|7 col 8| [DefraDB.Acronyms] Define acronym 'AP' on first use in this document
styles/DefraDB/Hedging.yml|2 col 38| [write-good.E-Prime] Try to avoid using 'be'.
styles/DefraDB/Hedging.yml|4 col 40| [Vale.Terms] Use 'DefraDB' instead of 'defradb'.
styles/DefraDB/Hedging.yml|4 col 61| [DefraDB.Acronyms] Define acronym 'CONTRIBUTING' on first use in this document
styles/DefraDB/Hedging.yml|5 col 1| [Vale.Spelling] Did you really mean 'ignorecase'?
styles/DefraDB/Hedging.yml|9 col 5| [DefraDB.Hedging] Remove hedging word 'simply' - be direct and confident
styles/DefraDB/Hedging.yml|9 col 5| [Vale.Avoid] Avoid using 'simply'.
styles/DefraDB/Hedging.yml|10 col 5| [DefraDB.Hedging] Remove hedging word 'just' - be direct and confident
styles/DefraDB/Hedging.yml|10 col 5| [Vale.Avoid] Avoid using 'just'.
styles/DefraDB/Hedging.yml|11 col 5| [DefraDB.Hedging] Remove hedging word 'easily' - be direct and confident
styles/DefraDB/Hedging.yml|11 col 5| [Vale.Avoid] Avoid using 'easily'.
styles/DefraDB/Hedging.yml|12 col 5| [DefraDB.Hedging] Remove hedging word 'easy' - be direct and confident
styles/DefraDB/Hedging.yml|13 col 5| [write-good.Weasel] 'obviously' is a weasel word!
styles/DefraDB/Hedging.yml|13 col 5| [DefraDB.Hedging] Remove hedging word 'obviously' - be direct and confident
styles/DefraDB/Hedging.yml|13 col 5| [Vale.Avoid] Avoid using 'obviously'.
styles/DefraDB/Hedging.yml|14 col 5| [write-good.Weasel] 'clearly' is a weasel word!
styles/DefraDB/Hedging.yml|14 col 5| [DefraDB.Hedging] Remove hedging word 'clearly' - be direct and confident
styles/DefraDB/Hedging.yml|14 col 5| [Vale.Avoid] Avoid using 'clearly'.
styles/DefraDB/Hedging.yml|15 col 5| [DefraDB.Hedging] Remove hedging word 'basically' - be direct and confident
styles/DefraDB/Hedging.yml|15 col 5| [Vale.Avoid] Avoid using 'basically'.
styles/DefraDB/Hedging.yml|16 col 5| [DefraDB.Hedging] Remove hedging word 'actually' - be direct and confident
styles/DefraDB/Hedging.yml|17 col 5| [Vale.Avoid] Avoid using 'really'.
styles/DefraDB/Hedging.yml|17 col 5| [DefraDB.Hedging] Remove hedging word 'really' - be direct and confident
styles/DefraDB/Hedging.yml|18 col 5| [DefraDB.Hedging] Remove hedging word 'very' - be direct and confident
styles/DefraDB/Hedging.yml|18 col 5| [write-good.Weasel] 'very' is a weasel word!
styles/DefraDB/Hedging.yml|18 col 5| [Vale.Avoid] Avoid using 'very'.
styles/DefraDB/Hedging.yml|19 col 5| [Vale.Avoid] Avoid using 'quite'.
styles/DefraDB/Hedging.yml|19 col 5| [DefraDB.Hedging] Remove hedging word 'quite' - be direct and confident
styles/DefraDB/Hedging.yml|19 col 5| [write-good.Weasel] 'quite' is a weasel word!
styles/DefraDB/Hedging.yml|20 col 5| [Vale.Avoid] Avoid using 'rather'.
styles/DefraDB/Hedging.yml|20 col 5| [DefraDB.Hedging] Remove hedging word 'rather' - be direct and confident
styles/DefraDB/Hedging.yml|21 col 5| [Vale.Avoid] Avoid using 'somewhat'.
styles/DefraDB/Hedging.yml|21 col 5| [DefraDB.Hedging] Remove hedging word 'somewhat' - be direct and confident
styles/DefraDB/Hedging.yml|22 col 5| [Vale.Avoid] Avoid using 'fairly'.
styles/DefraDB/Hedging.yml|22 col 5| [write-good.Weasel] 'fairly' is a weasel word!
styles/DefraDB/Hedging.yml|22 col 5| [DefraDB.Hedging] Remove hedging word 'fairly' - be direct and confident
styles/DefraDB/Hedging.yml|23 col 5| [DefraDB.Hedging] Remove hedging word 'kind of' - be direct and confident
styles/DefraDB/Hedging.yml|24 col 5| [DefraDB.Hedging] Remove hedging word 'sort of' - be direct and confident
styles/DefraDB/Hedging.yml|26 col 12| [Vale.Avoid] Avoid using 'just'.
styles/DefraDB/Hedging.yml|26 col 12| [DefraDB.Hedging] Remove hedging word 'just' - be direct and confident
styles/DefraDB/Hedging.yml|27 col 5| [Vale.Avoid] Avoid using 'just'.
styles/DefraDB/Hedging.yml|27 col 5| [DefraDB.Hedging] Remove hedging word 'just' - be direct and confident
styles/DefraDB/Hedging.yml|28 col 5| [DefraDB.Hedging] Remove hedging word 'just' - be direct and confident
styles/DefraDB/Hedging.yml|28 col 5| [Vale.Avoid] Avoid using 'just'.
styles/DefraDB/Hedging.yml|29 col 5| [DefraDB.Hedging] Remove hedging word 'just' - be direct and confident
styles/DefraDB/Hedging.yml|29 col 5| [Vale.Avoid] Avoid using 'just'.
styles/DefraDB/Hedging.yml|30 col 12| [DefraDB.Hedging] Remove hedging word 'simply' - be direct and confident
styles/DefraDB/Hedging.yml|30 col 12| [Vale.Avoid] Avoid using 'simply'.
styles/DefraDB/Hedging.yml|31 col 5| [DefraDB.Hedging] Remove hedging word 'simply' - be direct and confident
styles/DefraDB/Hedging.yml|31 col 5| [Vale.Avoid] Avoid using 'simply'.
styles/DefraDB/Hedging.yml|32 col 5| [write-good.TooWordy] 'put simply' is too wordy.
styles/DefraDB/Hedging.yml|32 col 9| [DefraDB.Hedging] Remove hedging word 'simply' - be direct and confident
styles/DefraDB/Hedging.yml|32 col 9| [Vale.Avoid] Avoid using 'simply'.
styles/DefraDB/NoteFormat.yml|4 col 40| [Vale.Terms] Use 'DefraDB' instead of 'defradb'.
styles/DefraDB/NoteFormat.yml|4 col 61| [DefraDB.Acronyms] Define acronym 'CONTRIBUTING' on first use in this document
styles/DefraDB/NoteFormat.yml|5 col 1| [Vale.Spelling] Did you really mean 'ignorecase'?
styles/DefraDB/NoteFormat.yml|7 col 1| [Vale.Spelling] Did you really mean 'nonword'?
styles/DefraDB/NoteFormat.yml|10 col 6| [DefraDB.Acronyms] Define acronym 'NOTE' on first use in this document
styles/DefraDB/NoteFormat.yml|12 col 8| [DefraDB.Acronyms] Define acronym 'NOTE' on first use in this document
styles/DefraDB/NoteFormat.yml|15 col 7| [DefraDB.Acronyms] Define acronym 'NOTE' on first use in this document
styles/DefraDB/NoteFormat.yml|17 col 9| [DefraDB.Acronyms] Define acronym 'NOTE' on first use in this document
styles/DefraDB/PreferredTerms.yml|4 col 40| [Vale.Terms] Use 'DefraDB' instead of 'defradb'.
styles/DefraDB/PreferredTerms.yml|4 col 61| [DefraDB.Acronyms] Define acronym 'CONTRIBUTING' on first use in this document
styles/DefraDB/PreferredTerms.yml|5 col 1| [Vale.Spelling] Did you really mean 'ignorecase'?
styles/DefraDB/PreferredTerms.yml|9 col 3| [DefraDB.PreferredTerms] Consider using 'allow list' instead of 'whitelist' for brand consistency
styles/DefraDB/PreferredTerms.yml|10 col 3| [DefraDB.PreferredTerms] Consider using 'deny list' instead of 'blacklist' for brand consistency
styles/DefraDB/PreferredTerms.yml|11 col 3| [DefraDB.PreferredTerms] Consider using 'primary|main' instead of 'master' for brand consistency
styles/DefraDB/PreferredTerms.yml|12 col 3| [DefraDB.PreferredTerms] Consider using 'replica|secondary' instead of 'slave' for brand consistency
styles/DefraDB/PreferredTerms.yml|15 col 3| [DefraDB.PreferredTerms] Consider using 'database' instead of 'db' for brand consistency
styles/DefraDB/PreferredTerms.yml|16 col 3| [DefraDB.PreferredTerms] Consider using 'NoSQL database' instead of 'NoSQL' for brand consistency
styles/DefraDB/PreferredTerms.yml|16 col 10| [DefraDB.PreferredTerms] Consider using 'NoSQL database' instead of 'NoSQL' for brand consistency
styles/DefraDB/PreferredTerms.yml|19 col 3| [write-good.TooWordy] 'utilize' is too wordy.
styles/DefraDB/PreferredTerms.yml|19 col 3| [DefraDB.PreferredTerms] Consider using 'use' instead of 'utilize' for brand consistency
styles/DefraDB/PreferredTerms.yml|20 col 3| [DefraDB.PreferredTerms] Consider using 'uses' instead of 'utilizes' for brand consistency
styles/DefraDB/PreferredTerms.yml|21 col 3| [DefraDB.PreferredTerms] Consider using 'use' instead of 'utilization' for brand consistency
styles/DefraDB/PreferredTerms.yml|21 col 3| [write-good.TooWordy] 'utilization' is too wordy.
styles/DefraDB/PreferredTerms.yml|22 col 3| [write-good.TooWordy] 'facilitate' is too wordy.
styles/DefraDB/PreferredTerms.yml|22 col 3| [DefraDB.PreferredTerms] Consider using 'help|enable' instead of 'facilitate' for brand consistency
styles/DefraDB/PreferredTerms.yml|23 col 3| [DefraDB.PreferredTerms] Consider using 'helps|enables' instead of 'facilitates' for brand consistency
styles/DefraDB/ProductNames.yml|4 col 40| [Vale.Terms] Use 'DefraDB' instead of 'defradb'.
styles/DefraDB/ProductNames.yml|4 col 61| [DefraDB.Acronyms] Define acronym 'CONTRIBUTING' on first use in this document
styles/DefraDB/ProductNames.yml|5 col 1| [Vale.Spelling] Did you really mean 'ignorecase'?
styles/DefraDB/ProductNames.yml|8 col 3| [DefraDB.ProductNames] Use 'DefraDB' instead of 'defraDB' for correct product branding
styles/DefraDB/ProductNames.yml|8 col 3| [Vale.Terms] Use 'DefraDB' instead of 'defraDB'.
styles/DefraDB/ProductNames.yml|8 col 3| [Vale.Avoid] Avoid using 'defraDB'.
styles/DefraDB/ProductNames.yml|9 col 3| [Vale.Spelling] Did you really mean 'defra'?
styles/DefraDB/ProductNames.yml|9 col 3| [DefraDB.ProductNames] Use 'DefraDB' instead of 'defra DB' for correct product branding
styles/DefraDB/ProductNames.yml|9 col 3| [Vale.Avoid] Avoid using 'defra DB'.
styles/DefraDB/ProductNames.yml|9 col 9| [DefraDB.Acronyms] Define acronym 'DB' on first use in this document
styles/DefraDB/ProductNames.yml|9 col 9| [DefraDB.PreferredTerms] Consider using 'database' instead of 'DB' for brand consistency
styles/DefraDB/ProductNames.yml|10 col 3| [DefraDB.ProductNames] Use 'DefraDB' instead of 'defra' for correct product branding
styles/DefraDB/ProductNames.yml|11 col 3| [Vale.Avoid] Avoid using 'Source Hub'.
styles/DefraDB/ProductNames.yml|11 col 3| [DefraDB.ProductNames] Use 'SourceHub' instead of 'Source Hub' for correct product branding
styles/DefraDB/ProductNames.yml|12 col 3| [Vale.Terms] Use 'SourceHub' instead of 'Sourcehub'.
styles/DefraDB/ProductNames.yml|12 col 3| [Vale.Avoid] Avoid using 'Sourcehub'.
styles/DefraDB/ProductNames.yml|12 col 3| [DefraDB.ProductNames] Use 'SourceHub' instead of 'Sourcehub' for correct product branding
styles/DefraDB/ProductNames.yml|13 col 3| [Vale.Avoid] Avoid using 'source hub'.
styles/DefraDB/ProductNames.yml|13 col 3| [DefraDB.ProductNames] Use 'SourceHub' instead of 'source hub' for correct product branding
styles/DefraDB/ProductNames.yml|16 col 3| [DefraDB.ProductNames] Use 'MongoDB' instead of 'Mongodb' for correct product branding
styles/DefraDB/ProductNames.yml|16 col 3| [Vale.Terms] Use 'MongoDB' instead of 'Mongodb'.
styles/DefraDB/ProductNames.yml|17 col 3| [DefraDB.ProductNames] Use 'MongoDB' instead of 'mongo' for correct product branding
styles/DefraDB/ProductNames.yml|18 col 3| [DefraDB.ProductNames] Use 'MongoDB' instead of 'mongo db' for correct product branding
styles/DefraDB/ProductNames.yml|18 col 9| [DefraDB.PreferredTerms] Consider using 'database' instead of 'db' for brand consistency
styles/DefraDB/ProductNames.yml|19 col 3| [DefraDB.ProductNames] Use 'PostgreSQL' instead of 'Postgres' for correct product branding
styles/DefraDB/ProductNames.yml|19 col 3| [Vale.Spelling] Did you really mean 'Postgres'?
styles/DefraDB/ProductNames.yml|20 col 3| [DefraDB.ProductNames] Use 'PostgreSQL' instead of 'postgres' for correct product branding
styles/DefraDB/ProductNames.yml|20 col 3| [Vale.Spelling] Did you really mean 'postgres'?
styles/DefraDB/ProductNames.yml|21 col 3| [Vale.Spelling] Did you really mean 'postgres'?
styles/DefraDB/ProductNames.yml|21 col 3| [DefraDB.ProductNames] Use 'PostgreSQL' instead of 'postgres sql' for correct product branding
styles/DefraDB/ProductNames.yml|21 col 12| [Vale.Terms] Use 'SQL' instead of 'sql'.
styles/DefraDB/ProductNames.yml|22 col 3| [DefraDB.ProductNames] Use 'GraphQL' instead of 'Graphql' for correct product branding
styles/DefraDB/ProductNames.yml|22 col 3| [Vale.Terms] Use 'GraphQL' instead of 'Graphql'.
styles/DefraDB/ProductNames.yml|23 col 3| [Vale.Terms] Use 'GraphQL' instead of 'graphql'.
styles/DefraDB/ProductNames.yml|23 col 3| [DefraDB.ProductNames] Use 'GraphQL' instead of 'graphql' for correct product branding
styles/DefraDB/ProductNames.yml|24 col 3| [DefraDB.ProductNames] Use 'TypeScript' instead of 'Typescript' for correct product branding
styles/DefraDB/ProductNames.yml|24 col 3| [Vale.Terms] Use 'TypeScript' instead of 'Typescript'.
styles/DefraDB/ProductNames.yml|25 col 3| [DefraDB.ProductNames] Use 'TypeScript' instead of 'typescript' for correct product branding
styles/DefraDB/ProductNames.yml|25 col 3| [Vale.Terms] Use 'TypeScript' instead of 'typescript'.
styles/DefraDB/ProductNames.yml|26 col 3| [DefraDB.ProductNames] Use 'JavaScript' instead of 'Javascript' for correct product branding
styles/DefraDB/ProductNames.yml|26 col 3| [Vale.Terms] Use 'JavaScript' instead of 'Javascript'.
styles/DefraDB/ProductNames.yml|27 col 3| [DefraDB.ProductNames] Use 'JavaScript' instead of 'javascript' for correct product branding
styles/DefraDB/ProductNames.yml|27 col 3| [Vale.Terms] Use 'JavaScript' instead of 'javascript'.
styles/DefraDB/SourceStack.yml|2 col 55| [write-good.E-Prime] Try to avoid using 'is'.
styles/DefraDB/SourceStack.yml|4 col 40| [Vale.Terms] Use 'DefraDB' instead of 'defradb'.
styles/DefraDB/SourceStack.yml|4 col 61| [DefraDB.Acronyms] Define acronym 'CONTRIBUTING' on first use in this document
styles/DefraDB/SourceStack.yml|5 col 1| [Vale.Spelling] Did you really mean 'ignorecase'?
styles/DefraDB/SourceStack.yml|7 col 3| [DefraDB.SourceStack] Use 'Source stack' instead of 'Source stack' - Source is a stack, not a platform
styles/DefraDB/SourceStack.yml|8 col 3| [DefraDB.SourceStack] Use 'Source stack' instead of 'the Source stack' - Source is a stack, not a platform
styles/DefraDB/SourceStack.yml|9 col 3| [DefraDB.SourceStack] Use 'Source stack' instead of 'our stack' - Source is a stack, not a platform
styles/DefraDB/SourceStack.yml|9 col 3| [Google.We] Try to avoid using first-person plural like 'our'.
styles/DefraDB/SourceStack.yml|9 col 17| [Google.We] Try to avoid using first-person plural like 'our'.
styles/DefraDB/SourceStack.yml|10 col 3| [DefraDB.SourceStack] Use 'Source stack' instead of 'the stack' - Source is a stack, not a platform
styles/DefraDB/TechTerms.yml|4 col 40| [Vale.Terms] Use 'DefraDB' instead of 'defradb'.
styles/DefraDB/TechTerms.yml|4 col 61| [DefraDB.Acronyms] Define acronym 'CONTRIBUTING' on first use in this document
styles/DefraDB/TechTerms.yml|5 col 1| [Vale.Spelling] Did you really mean 'ignorecase'?
styles/DefraDB/TechTerms.yml|7 col 26| [Google.Parens] Use parentheses judiciously.
styles/DefraDB/TechTerms.yml|7 col 32| [write-good.E-Prime] Try to avoid using 'be'.
styles/DefraDB/TechTerms.yml|9 col 3| [DefraDB.TechTerms] Use 'edge-first software' instead of 'Edge-First Software' for correct technical terminology
styles/DefraDB/TechTerms.yml|9 col 3| [Vale.Terms] Use '[Ee]dge-first' instead of 'Edge-First'.
styles/DefraDB/TechTerms.yml|11 col 3| [DefraDB.TechTerms] Use 'local-first software' instead of 'Local-First Software' for correct technical terminology
styles/DefraDB/TechTerms.yml|11 col 3| [Vale.Terms] Use '[Ll]ocal-first' instead of 'Local-First'.
styles/DefraDB/TechTerms.yml|13 col 3| [Vale.Terms] Use '[Ee]dge compute' instead of 'Edge Compute'.
styles/DefraDB/TechTerms.yml|13 col 3| [DefraDB.TechTerms] Use 'edge compute' instead of 'Edge Compute' for correct technical terminology
styles/DefraDB/TechTerms.yml|15 col 3| [Vale.Terms] Use 'open source' instead of 'Open Source'.
styles/DefraDB/TechTerms.yml|15 col 3| [DefraDB.TechTerms] Use 'open source' instead of 'Open Source' for correct technical terminology
styles/DefraDB/TechTerms.yml|16 col 3| [Vale.Terms] Use 'open web' instead of 'Open Web'.
styles/DefraDB/TechTerms.yml|16 col 3| [DefraDB.TechTerms] Use 'open web' instead of 'Open Web' for correct technical terminology
styles/DefraDB/TechTerms.yml|18 col 23| [Google.Passive] In general, use active voice instead of passive voice ('be capitalized').
styles/DefraDB/TechTerms.yml|18 col 23| [write-good.Passive] 'be capitalized' may be passive voice. Use active voice if you can.
styles/DefraDB/TechTerms.yml|18 col 23| [write-good.E-Prime] Try to avoid using 'be'.
styles/DefraDB/TechTerms.yml|19 col 3| [DefraDB.TechTerms] Use 'Edge AI' instead of 'edge ai' for correct technical terminology
styles/DefraDB/TechTerms.yml|19 col 3| [Vale.Terms] Use '[Ee]dge AI' instead of 'edge ai'.
styles/DefraDB/TechTerms.yml|19 col 17| [DefraDB.Acronyms] Define acronym 'AI' on first use in this document
styles/DefraDB/TechTerms.yml|20 col 3| [DefraDB.TechTerms] Use 'Internet of Things' instead of 'internet of things' for correct technical terminology
styles/DefraDB/TechTerms.yml|20 col 3| [Vale.Terms] Use 'Internet of Things' instead of 'internet of things'.
styles/DefraDB/TechTerms.yml|21 col 3| [Vale.Terms] Use 'Big Tech' instead of 'big tech'.
styles/DefraDB/TechTerms.yml|21 col 3| [DefraDB.TechTerms] Use 'Big Tech' instead of 'big tech' for correct technical terminology
styles/DefraDB/TechTerms.yml|24 col 3| [Vale.Terms] Use 'Dweb' instead of 'dweb'.
styles/DefraDB/TechTerms.yml|24 col 3| [DefraDB.TechTerms] Use 'Dweb' instead of 'dweb' for correct technical terminology
styles/DefraDB/TechTerms.yml|25 col 3| [Vale.Terms] Use 'Dweb' instead of 'DWeb'.
styles/DefraDB/TechTerms.yml|25 col 3| [DefraDB.TechTerms] Use 'Dweb' instead of 'DWeb' for correct technical terminology
styles/DefraDB/Voice.yml|2 col 17| [DefraDB.Acronyms] Define acronym 'TO' on first use in this document
styles/DefraDB/Voice.yml|2 col 31| [Google.Parens] Use parentheses judiciously.
styles/DefraDB/Voice.yml|2 col 51| [Google.Acronyms] Spell out 'ABOUT', if it's unfamiliar to the audience.
styles/DefraDB/Voice.yml|2 col 51| [DefraDB.Acronyms] Define acronym 'ABOUT' on first use in this document
styles/DefraDB/Voice.yml|4 col 40| [Vale.Terms] Use 'DefraDB' instead of 'defradb'.
styles/DefraDB/Voice.yml|4 col 61| [DefraDB.Acronyms] Define acronym 'CONTRIBUTING' on first use in this document
styles/DefraDB/Voice.yml|5 col 1| [Vale.Spelling] Did you really mean 'ignorecase'?
styles/DefraDB/Voice.yml|8 col 6| [Google.Parens] Use parentheses judiciously.
styles/DefraDB/Voice.yml|8 col 30| [Google.Will] Avoid using 'will'.
styles/DefraDB/Voice.yml|9 col 6| [Google.Parens] Use parentheses judiciously.
styles/DefraDB/Voice.yml|9 col 25| [Google.Will] Avoid using 'will'.
styles/DefraDB/Voice.yml|10 col 14| [Google.Parens] Use parentheses judiciously.
styles/DefraDB/Voice.yml|11 col 15| [Google.Parens] Use parentheses judiciously.
styles/config/vocabularies/DefraDB/accept.txt|2 col 15| [write-good.Passive] 'are considered' may be passive voice. Use active voice if you can.
styles/config/vocabularies/DefraDB/accept.txt|2 col 15| [Google.Passive] In general, use active voice instead of passive voice ('are considered').
styles/config/vocabularies/DefraDB/accept.txt|2 col 15| [write-good.E-Prime] Try to avoid using 'are'.
styles/config/vocabularies/DefraDB/accept.txt|2 col 42| [Google.Will] Avoid using 'will'.
styles/config/vocabularies/DefraDB/accept.txt|2 col 42| [Google.Contractions] Use 'won't' instead of 'will not'.
styles/config/vocabularies/DefraDB/accept.txt|2 col 51| [write-good.E-Prime] Try to avoid using 'be'.
styles/config/vocabularies/DefraDB/accept.txt|2 col 51| [write-good.Passive] 'be flagged' may be passive voice. Use active voice if you can.
styles/config/vocabularies/DefraDB/accept.txt|2 col 51| [Google.Passive] In general, use active voice instead of passive voice ('be flagged').
styles/config/vocabularies/DefraDB/accept.txt|2 col 68| [Google.Spacing] 'e.T' should have one space.
styles/config/vocabularies/DefraDB/accept.txt|3 col 25| [write-good.E-Prime] Try to avoid using 'are'.
styles/config/vocabularies/DefraDB/accept.txt|4 col 18| [Google.Passive] In general, use active voice instead of passive voice ('are supported').
styles/config/vocabularies/DefraDB/accept.txt|4 col 18| [write-good.E-Prime] Try to avoid using 'are'.
styles/config/vocabularies/DefraDB/accept.txt|4 col 18| [write-good.Passive] 'are supported' may be passive voice. Use active voice if you can.
styles/config/vocabularies/DefraDB/accept.txt|21 col 21| [Vale.Terms] Use '[Ee]dge computing' instead of 'Edge Computing'.
styles/config/vocabularies/DefraDB/accept.txt|24 col 9| [DefraDB.Acronyms] Define acronym 'AI' on first use in this document
styles/config/vocabularies/DefraDB/reject.txt|2 col 22| [write-good.E-Prime] Try to avoid using 'be'.
styles/config/vocabularies/DefraDB/reject.txt|2 col 22| [Google.Passive] In general, use active voice instead of passive voice ('be avoided').
styles/config/vocabularies/DefraDB/reject.txt|2 col 22| [write-good.Passive] 'be avoided' may be passive voice. Use active voice if you can.
styles/config/vocabularies/DefraDB/reject.txt|2 col 37| [Google.Will] Avoid using 'will'.
styles/config/vocabularies/DefraDB/reject.txt|2 col 42| [write-good.Passive] 'be flagged' may be passive voice. Use active voice if you can.
styles/config/vocabularies/DefraDB/reject.txt|2 col 42| [write-good.E-Prime] Try to avoid using 'be'.
styles/config/vocabularies/DefraDB/reject.txt|2 col 42| [Google.Passive] In general, use active voice instead of passive voice ('be flagged').
styles/config/vocabularies/DefraDB/reject.txt|3 col 25| [write-good.E-Prime] Try to avoid using 'are'.
styles/config/vocabularies/DefraDB/reject.txt|6 col 1| [Vale.Avoid] Avoid using 'Defra'.
styles/config/vocabularies/DefraDB/reject.txt|6 col 6| [Google.Parens] Use parentheses judiciously.
styles/config/vocabularies/DefraDB/reject.txt|6 col 9| [DefraDB.Acronyms] Define acronym 'DB' on first use in this document
styles/config/vocabularies/DefraDB/reject.txt|6 col 9| [DefraDB.PreferredTerms] Consider using 'database' instead of 'DB' for brand consistency
styles/config/vocabularies/DefraDB/reject.txt|7 col 1| [Vale.Avoid] Avoid using 'defraDB'.
styles/config/vocabularies/DefraDB/reject.txt|7 col 1| [Vale.Terms] Use 'DefraDB' instead of 'defraDB'.
styles/config/vocabularies/DefraDB/reject.txt|7 col 1| [DefraDB.ProductNames] Use 'DefraDB' instead of 'defraDB' for correct product branding
styles/config/vocabularies/DefraDB/reject.txt|8 col 1| [DefraDB.ProductNames] Use 'DefraDB' instead of 'defra DB' for correct product branding
styles/config/vocabularies/DefraDB/reject.txt|8 col 1| [Vale.Avoid] Avoid using 'defra DB'.
styles/config/vocabularies/DefraDB/reject.txt|8 col 1| [Vale.Spelling] Did you really mean 'defra'?
styles/config/vocabularies/DefraDB/reject.txt|8 col 7| [DefraDB.PreferredTerms] Consider using 'database' instead of 'DB' for brand consistency
styles/config/vocabularies/DefraDB/reject.txt|8 col 7| [DefraDB.Acronyms] Define acronym 'DB' on first use in this document
styles/config/vocabularies/DefraDB/reject.txt|9 col 1| [DefraDB.ProductNames] Use 'SourceHub' instead of 'Source Hub' for correct product branding
styles/config/vocabularies/DefraDB/reject.txt|9 col 1| [Vale.Avoid] Avoid using 'Source Hub'.
styles/config/vocabularies/DefraDB/reject.txt|10 col 1| [Vale.Avoid] Avoid using 'Sourcehub'.
styles/config/vocabularies/DefraDB/reject.txt|10 col 1| [DefraDB.ProductNames] Use 'SourceHub' instead of 'Sourcehub' for correct product branding
styles/config/vocabularies/DefraDB/reject.txt|10 col 1| [Vale.Terms] Use 'SourceHub' instead of 'Sourcehub'.
styles/config/vocabularies/DefraDB/reject.txt|11 col 1| [Vale.Avoid] Avoid using 'source hub'.
styles/config/vocabularies/DefraDB/reject.txt|11 col 1| [DefraDB.ProductNames] Use 'SourceHub' instead of 'source hub' for correct product branding
styles/config/vocabularies/DefraDB/reject.txt|13 col 20| [Google.Parens] Use parentheses judiciously.
styles/config/vocabularies/DefraDB/reject.txt|14 col 1| [Vale.Avoid] Avoid using 'simply'.
styles/config/vocabularies/DefraDB/reject.txt|14 col 1| [DefraDB.Hedging] Remove hedging word 'simply' - be direct and confident
styles/config/vocabularies/DefraDB/reject.txt|15 col 1| [DefraDB.Hedging] Remove hedging word 'just' - be direct and confident
styles/config/vocabularies/DefraDB/reject.txt|15 col 1| [Vale.Avoid] Avoid using 'just'.
styles/config/vocabularies/DefraDB/reject.txt|16 col 1| [DefraDB.Hedging] Remove hedging word 'easily' - be direct and confident
styles/config/vocabularies/DefraDB/reject.txt|16 col 1| [Vale.Avoid] Avoid using 'easily'.
styles/config/vocabularies/DefraDB/reject.txt|17 col 1| [Vale.Avoid] Avoid using 'obviously'.
styles/config/vocabularies/DefraDB/reject.txt|17 col 1| [write-good.Weasel] 'obviously' is a weasel word!
styles/config/vocabularies/DefraDB/reject.txt|17 col 1| [DefraDB.Hedging] Remove hedging word 'obviously' - be direct and confident
styles/config/vocabularies/DefraDB/reject.txt|18 col 1| [write-good.Weasel] 'clearly' is a weasel word!
styles/config/vocabularies/DefraDB/reject.txt|18 col 1| [Vale.Avoid] Avoid using 'clearly'.
styles/config/vocabularies/DefraDB/reject.txt|18 col 1| [DefraDB.Hedging] Remove hedging word 'clearly' - be direct and confident
styles/config/vocabularies/DefraDB/reject.txt|19 col 1| [Vale.Avoid] Avoid using 'basically'.
styles/config/vocabularies/DefraDB/reject.txt|19 col 1| [DefraDB.Hedging] Remove hedging word 'basically' - be direct and confident
styles/config/vocabularies/DefraDB/reject.txt|22 col 1| [Vale.Avoid] Avoid using 'very'.
styles/config/vocabularies/DefraDB/reject.txt|22 col 1| [DefraDB.Hedging] Remove hedging word 'very' - be direct and confident
styles/config/vocabularies/DefraDB/reject.txt|22 col 1| [write-good.Weasel] 'very' is a weasel word!
styles/config/vocabularies/DefraDB/reject.txt|23 col 1| [DefraDB.Hedging] Remove hedging word 'really' - be direct and confident
styles/config/vocabularies/DefraDB/reject.txt|23 col 1| [Vale.Avoid] Avoid using 'really'.
styles/config/vocabularies/DefraDB/reject.txt|24 col 1| [DefraDB.Hedging] Remove hedging word 'quite' - be direct and confident
styles/config/vocabularies/DefraDB/reject.txt|24 col 1| [write-good.Weasel] 'quite' is a weasel word!
styles/config/vocabularies/DefraDB/reject.txt|24 col 1| [Vale.Avoid] Avoid using 'quite'.
styles/config/vocabularies/DefraDB/reject.txt|25 col 1| [Vale.Avoid] Avoid using 'rather'.
styles/config/vocabularies/DefraDB/reject.txt|25 col 1| [DefraDB.Hedging] Remove hedging word 'rather' - be direct and confident
styles/config/vocabularies/DefraDB/reject.txt|26 col 1| [Vale.Avoid] Avoid using 'somewhat'.
styles/config/vocabularies/DefraDB/reject.txt|26 col 1| [DefraDB.Hedging] Remove hedging word 'somewhat' - be direct and confident
styles/config/vocabularies/DefraDB/reject.txt|27 col 1| [write-good.Weasel] 'fairly' is a weasel word!
styles/config/vocabularies/DefraDB/reject.txt|27 col 1| [DefraDB.Hedging] Remove hedging word 'fairly' - be direct and confident
styles/config/vocabularies/DefraDB/reject.txt|27 col 1| [Vale.Avoid] Avoid using 'fairly'.
styles/config/vocabularies/DefraDB/reject.txt|29 col 23| [Google.Parens] Use parentheses judiciously.
styles/config/vocabularies/DefraDB/reject.txt|30 col 1| [Vale.Avoid] Avoid using 'leverage'.
styles/config/vocabularies/DefraDB/reject.txt|30 col 1| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'leverage' - be specific and direct instead
styles/config/vocabularies/DefraDB/reject.txt|31 col 1| [Vale.Avoid] Avoid using 'synergy'.
styles/config/vocabularies/DefraDB/reject.txt|31 col 1| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'synergy' - be specific and direct instead
styles/config/vocabularies/DefraDB/reject.txt|32 col 1| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'synergistic' - be specific and direct instead
styles/config/vocabularies/DefraDB/reject.txt|32 col 1| [Vale.Avoid] Avoid using 'synergistic'.
styles/config/vocabularies/DefraDB/reject.txt|33 col 1| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'paradigm shift' - be specific and direct instead
styles/config/vocabularies/DefraDB/reject.txt|33 col 1| [Vale.Avoid] Avoid using 'paradigm shift'.
styles/config/vocabularies/DefraDB/reject.txt|34 col 1| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'best-in-class' - be specific and direct instead
styles/config/vocabularies/DefraDB/reject.txt|34 col 1| [Vale.Avoid] Avoid using 'best-in-class'.
styles/config/vocabularies/DefraDB/reject.txt|35 col 1| [DefraDB.CorporateSpeak] Avoid corporate buzzword 'world-class' - be specific and direct instead
styles/config/vocabularies/DefraDB/reject.txt|35 col 1| [Vale.Avoid] Avoid using 'world-class'.
| @@ -0,0 +1,65 @@ | |||
| # Copyright 2025 Democratized Data Foundation | |||
| # | |||
| # Use of this software is governed by the Business Source License | |||
There was a problem hiding this comment.
[write-good.Passive] 'is governed' may be passive voice. Use active voice if you can.
| @@ -0,0 +1,65 @@ | |||
| # Copyright 2025 Democratized Data Foundation | |||
| # | |||
| # Use of this software is governed by the Business Source License | |||
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[write-good.E-Prime] Try to avoid using 'is'.
| @@ -0,0 +1,65 @@ | |||
| # Copyright 2025 Democratized Data Foundation | |||
| # | |||
| # Use of this software is governed by the Business Source License | |||
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is governed').
| # Copyright 2025 Democratized Data Foundation | ||
| # | ||
| # Use of this software is governed by the Business Source License | ||
| # included in the file licenses/BSL.txt. |
There was a problem hiding this comment.
[DefraDB.Acronyms] Define acronym 'BSL' on first use in this document
| # Copyright 2025 Democratized Data Foundation | ||
| # | ||
| # Use of this software is governed by the Business Source License | ||
| # included in the file licenses/BSL.txt. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Acronyms] Spell out 'BSL', if it's unfamiliar to the audience.
| styles/alex/ | ||
| .vale-cache/ | ||
|
|
||
| # Ignore VS Code files. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
| [docs/website/references/**/*.md] | ||
| DefraDB.Hedging = suggestion | ||
|
|
||
| [docs/website/references/cli/*.md] |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'CLI' instead of 'cli'.
| DefraDB.Hedging = suggestion | ||
|
|
||
| [docs/website/references/cli/*.md] | ||
| Google.Headings = suggestion |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Google.Spacing] 'e.H' should have one space.
| Google.Headings = suggestion | ||
|
|
||
| [docs/data_format_changes/*.md] | ||
| DefraDB.Voice = NO |
There was a problem hiding this comment.
[DefraDB.Acronyms] Define acronym 'NO' on first use in this document
| @@ -0,0 +1,277 @@ | |||
| # Vale Documentation Linting - Setup Complete! ✨ | |||
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Headings] 'Vale Documentation Linting - Setup Complete! ✨' should use sentence-style capitalization.
|
This probably makes more sense to have on the docs repo (or perhaps both here and the docs repo). The |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #4228 +/- ##
===========================================
+ Coverage 77.29% 77.40% +0.11%
===========================================
Files 482 484 +2
Lines 37261 37848 +587
===========================================
+ Hits 28800 29294 +494
- Misses 6192 6246 +54
- Partials 2269 2308 +39
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
|
Closing in favor of: sourcenetwork/docs.source.network#193 |
2 participants
Summary
Adds Vale documentation linting to DefraDB with custom style rules based on the Source brand messaging guidelines.
make lint:docs,make vale:sync)What Vale Enforces
Error Level (Branding)
Warning Level (Style)
Suggestion Level (Quality)
How to Use
Test Plan
make lint:docsruns without errorsDocumentation
docs/vale-setup.md- Complete usage guideVALE_SETUP_SUMMARY.md- Quick reference🤖 Generated with Claude Code