Erich Blume 124ffb60d7 Add doc-random mise task for documentation review

- New mise task selects a random doc card for periodic review
- Add how-to/knowledgebase section with review-documentation guide
- Clean up obsolete zk/ directory references from doc-links

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

2026-02-03 21:08:49 -08:00

1.4 KiB

Raw Blame History

title

Review Documentation

How to periodically review and maintain the BlumeOps knowledge base.

Quick Random Review

Select a random documentation card for review:

mise run doc-random

This displays a random card with a review checklist to guide your assessment.

Review Checklist

When reviewing a documentation card, consider:

Check	Description
Accuracy	Is the information current and correct?
Links	Are wiki-links working? Should more be added?
Scope	Is the card appropriately sized (not too large/small)?
Category	Is it in the right section (reference/how-to/tutorial/explanation)?
Frontmatter	Are title and tags appropriate?
Related	Should it link to related cards?

When to Review

Consider running mise run doc-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:

Create a feature branch
Make the edits
Run mise run doc-links to verify links
Create a PR for review

See update-documentation for publishing changes.

update-documentation - Publishing documentation changes
exploring-the-docs - Navigating the documentation

1.4 KiB Raw Blame History