- At the AGM we formed an ad-hoc documentation working group.
- One of our ideas was that we should have a last reviewed date for
documentation, so that we can periodically implement a review
mechanism (GitHub Actions posts to Slack for a regular documentation
outdatedness check?) to track how old docs are and ensure they're
still relevant.
- This is a first step towards that goal, by adding a `last_review_date`
to the metadata of all docs with a date of earlier than Homebrew's
inception because everything needs reviewing so that we start from a
good base!
- 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).
