- 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 wrote about the implications of (not) doing this in the PR
(https://github.com/Homebrew/brew/pull/6826#issuecomment-564273209),
but in summary:
- It looks like pretty much the only place we've ever adhered to the
sentence case rule is the Prose Guidelines itself.
- Correcting all these to sentence case would be a lot of work (and
sometimes not even make sense).
- Admittedly, some of the title case ones look a bit horrible, but
even with some allowed exceptions, but it's better than being
consistently inconsistent.
- Only lint for title case in h1 headings. H2s and H3s etc. can be
sentence case. There's not currently a lint for that.
This is a replacement for the rubydoc.info site that has been a bit
unreliable for us.
Also, note we're using the community Ruby style guide now rather than
the GitHub one.
