Add a last_reviewed_date to docs metadata

[issyl0]

• Have you followed the guidelines in our Contributing document?
• Have you checked to ensure there aren't other open Pull Requests for the same change?
• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new tests for your changes? Here's an example.
• Have you successfully run brew style with your changes locally?
• Have you successfully run brew typecheck with your changes locally?
• Have you successfully run brew tests with your changes locally?

---

• 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!

[colindean]

👍

[carlocab]

Can we add a linter that checks that new docs have the last_reviewed_date attribute?

[carlocab]

Can we add a linter that checks that new docs have the last_reviewed_date attribute?

And preferably one that insists you bump the date whenever the document is modified too.

[MikeMcQuaid]

Can we hold off adding this review date until we've actually (re-)reviewed these documents?

[issyl0]

I thought this was a good "if it's 1970 then it needs review", and gets the metadata used. (We can make a list of docs that need re-review and put it in an issue.)

[MikeMcQuaid]

I think ideally we'd go with "if it's blank" or "if it's false" or something: we need to review. The 1970 date is a little confusing and harder to "scan" than those.

[issyl0]

Can we add a linter that checks that new docs have the last_reviewed_date attribute?

Yes, I'll add one!

And preferably one that insists you bump the date whenever the document is modified too.

I'm personally against this because you might want to add some information but not feel qualified enough and/or have time to review the whole thing. It's not "last edited", but "last reviewed for accuracy".