Add docs-review task with last-reviewed frontmatter tracking
Replace docs-review-random with docs-review, which sorts docs by a last-reviewed frontmatter field (never-reviewed first, then oldest). Updated the review-documentation how-to to match. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
c6f8fcd346
commit
8cfd5c3dab
5 changed files with 196 additions and 101 deletions
|
|
@ -0,0 +1 @@
|
|||
Add `docs-review` mise task that sorts docs by `last-reviewed` frontmatter date, prioritizing never-reviewed cards. Updated the review-documentation how-to to match.
|
||||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -99,7 +99,7 @@ BlumeOps operations are driven by mise tasks. Run `mise tasks` to list all avail
|
|||
| `docs-check-filenames` | Check for duplicate doc filenames |
|
||||
| `docs-review-stale` | Report docs by last-modified date, highlight stale ones |
|
||||
| `docs-review-tags` | Print frontmatter tag inventory across all docs |
|
||||
| `docs-review-random` | Select a random doc card for review |
|
||||
| `docs-review` | Review the most stale doc by last-reviewed date |
|
||||
| `indri-runner-logs` | View Forgejo workflow logs from local runner |
|
||||
|
||||
For ArgoCD operations, use the `argocd` CLI directly:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue