eblume/blumeops
1
1
Fork 0
Code Issues Pull requests Projects Releases 83 Packages Wiki Activity Actions

Add docs-review task with last-reviewed frontmatter tracking (#129)

Browse source 
## Summary
- New `docs-review` mise task replaces `docs-review-random` — sorts docs by `last-reviewed` frontmatter field (never-reviewed first, then oldest)
- Updated review-documentation how-to to explain the new workflow and how to mark cards as reviewed
- Updated ai-assistance-guide task table to reference `docs-review`

## Test plan
- [x] `mise run docs-review` runs and shows staleness table + most stale doc
- [x] `mise run docs-review -- --limit 5` respects the limit flag
- [x] All pre-commit checks pass (links, index, filenames)

Reviewed-on: https://forge.ops.eblu.me/eblume/blumeops/pulls/129
This commit is contained in:
Erich Blume 2026-02-09 07:29:45 -08:00
commit 9e361cf38f
6 changed files with 214 additions and 132 deletions
Download patch file Download diff file Expand all files Collapse all files

37
docs/how-to/knowledgebase/review-documentation.md
View file

@ -10,15 +10,36 @@ tags:
How to periodically review and maintain the BlumeOps knowledge base.
## Quick Random Review
## Review by Staleness
Select a random documentation card for review:
Show docs sorted by when they were last reviewed (most stale first):
```bash
mise run docs-review-random
mise run docs-review
```
This displays a random card with a review checklist to guide your assessment.
This reads the `last-reviewed` frontmatter field from each card. Cards without the field are treated as never-reviewed and appear at the top. The script shows a staleness table and then displays the most stale card with a review checklist.
To show more entries in the table:
```bash
mise run docs-review -- --limit 30
```
### Marking a Card as Reviewed
After reviewing a card, add or update the `last-reviewed` field in its frontmatter:
```yaml
---
title: Some Card
last-reviewed: 2026-02-09
tags:
- reference
---
```
Commit this change alongside any fixes you make during the review.
## Review Checklist
@ -72,14 +93,6 @@ cd pulumi/gandi && pulumi preview
If changes are pending, investigate whether docs or infrastructure is stale.
## When to Review
Consider running `mise run docs-review-random` during:
- Start of work sessions (quick maintenance)
- After major infrastructure changes (verify docs reflect reality)
- When learning the system (random exploration)
## Making Changes
If a card needs updates: