- I added these all the way back in December 2019 in #6826, but only
today realised that things have been failing unnoticeably because
"warning" level exits with status code 0, so doesn't fail CI.
- Upgrading to "error" level will enable us to see the style errors in
our docs and fix them faster.
- My editor also auto-formatted the YAML to have double quotes instead
of single.
Anywhere we can use `blob/master` we can use `blob/HEAD` instead. This
will make life easier if we ever rename our default branch in future
(once/if Git and GitHub provides the necessary tooling to do so).
- I noticed that another open source project had taken the Homebrew
style guide and made it into [Vale linting
rules](https://github.com/testthedocs/vale-styles/tree/master/Homebrew).
This copies them into here, so that we can make use of them. Thanks!
- What use is a style guide if our own docs don't at least try to
adhere to it? This aims to make the rules more visible to all
contributors.
- In order for these to do anything, you'll have to `brew install vale`
and run `vale` in the root of this repo. It will look for Markdown
files.
- A next step would be adding this as a pre-commit hook, or...
- The GitHub Action would have been really good, but [it doesn't support
forks](https://github.com/errata-ai/vale-action#limitations).
