Rename doc-* mise tasks to docs-check-* / docs-review-* (#113)
## Summary - Rename 4 automated-check tasks: `doc-titles` → `docs-check-titles`, `doc-filenames` → `docs-check-filenames`, `doc-links` → `docs-check-links`, `doc-index` → `docs-check-index` - Rename 3 interactive-review tasks: `doc-random` → `docs-review-random`, `doc-tags` → `docs-review-tags`, `doc-stale` → `docs-review-stale` - Update all references in `.pre-commit-config.yaml`, `ai-assistance-guide.md`, and `review-documentation.md` - Historical changelog entries left as-is ## Test plan - [x] `mise run docs-check-titles` exits 0 - [x] `mise run docs-check-links` exits 0 - [x] `mise run docs-review-tags` exits 0 - [x] `mise run doc-titles` fails with "no task found" - [x] All pre-commit hooks pass (including renamed hook IDs) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Reviewed-on: https://forge.ops.eblu.me/eblume/blumeops/pulls/113
This commit is contained in:
parent
060c7a24e3
commit
cb343a2e35
11 changed files with 30 additions and 29 deletions
|
|
@ -92,27 +92,27 @@ repos:
|
|||
# Documentation validation
|
||||
- repo: local
|
||||
hooks:
|
||||
- id: doc-titles
|
||||
name: doc-titles
|
||||
entry: mise run doc-titles
|
||||
- id: docs-check-titles
|
||||
name: docs-check-titles
|
||||
entry: mise run docs-check-titles
|
||||
language: system
|
||||
files: ^docs/.*\.md$
|
||||
pass_filenames: false
|
||||
- id: doc-filenames
|
||||
name: doc-filenames
|
||||
entry: mise run doc-filenames
|
||||
- id: docs-check-filenames
|
||||
name: docs-check-filenames
|
||||
entry: mise run docs-check-filenames
|
||||
language: system
|
||||
files: ^docs/.*\.md$
|
||||
pass_filenames: false
|
||||
- id: doc-links
|
||||
name: doc-links
|
||||
entry: mise run doc-links
|
||||
- id: docs-check-links
|
||||
name: docs-check-links
|
||||
entry: mise run docs-check-links
|
||||
language: system
|
||||
files: ^docs/.*\.md$
|
||||
pass_filenames: false
|
||||
- id: doc-index
|
||||
name: doc-index
|
||||
entry: mise run doc-index
|
||||
- id: docs-check-index
|
||||
name: docs-check-index
|
||||
entry: mise run docs-check-index
|
||||
language: system
|
||||
files: ^docs/.*\.md$
|
||||
pass_filenames: false
|
||||
|
|
|
|||
1
docs/changelog.d/rename-doc-tasks.misc.md
Normal file
1
docs/changelog.d/rename-doc-tasks.misc.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
Rename `doc-*` mise tasks to `docs-check-*` / `docs-review-*` for clearer naming convention.
|
||||
|
|
@ -15,7 +15,7 @@ How to periodically review and maintain the BlumeOps knowledge base.
|
|||
Select a random documentation card for review:
|
||||
|
||||
```bash
|
||||
mise run doc-random
|
||||
mise run docs-review-random
|
||||
```
|
||||
|
||||
This displays a random card with a review checklist to guide your assessment.
|
||||
|
|
@ -74,7 +74,7 @@ If changes are pending, investigate whether docs or infrastructure is stale.
|
|||
|
||||
## When to Review
|
||||
|
||||
Consider running `mise run doc-random` during:
|
||||
Consider running `mise run docs-review-random` during:
|
||||
|
||||
- Start of work sessions (quick maintenance)
|
||||
- After major infrastructure changes (verify docs reflect reality)
|
||||
|
|
@ -86,7 +86,7 @@ If a card needs updates:
|
|||
|
||||
1. Create a feature branch
|
||||
2. Make the edits
|
||||
3. Run `mise run doc-links` to verify links
|
||||
3. Run `mise run docs-check-links` to verify links
|
||||
4. Create a PR for review
|
||||
|
||||
See [[update-documentation]] for publishing changes.
|
||||
|
|
|
|||
|
|
@ -94,13 +94,13 @@ BlumeOps operations are driven by mise tasks. Run `mise tasks` to list all avail
|
|||
| `dns-up` | Apply DNS changes via Pulumi |
|
||||
| `tailnet-preview` | Preview Tailscale ACL changes |
|
||||
| `tailnet-up` | Apply Tailscale ACL changes via Pulumi |
|
||||
| `doc-links` | Validate wiki-links in documentation (includes orphan detection) |
|
||||
| `doc-index` | Check every doc is referenced in its category index |
|
||||
| `doc-titles` | Check for duplicate doc titles |
|
||||
| `doc-filenames` | Check for duplicate doc filenames |
|
||||
| `doc-stale` | Report docs by last-modified date, highlight stale ones |
|
||||
| `doc-tags` | Print frontmatter tag inventory across all docs |
|
||||
| `doc-random` | Select a random doc card for review |
|
||||
| `docs-check-links` | Validate wiki-links in documentation (includes orphan detection) |
|
||||
| `docs-check-index` | Check every doc is referenced in its category index |
|
||||
| `docs-check-titles` | Check for duplicate doc titles |
|
||||
| `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 |
|
||||
| `indri-runner-logs` | View Forgejo workflow logs from local runner |
|
||||
|
||||
For ArgoCD operations, use the `argocd` CLI directly:
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ cause wiki-link resolution issues.
|
|||
With Quartz, wiki-links like [[filename]] resolve by filename,
|
||||
so filenames must be unique across the documentation.
|
||||
|
||||
Usage: mise run doc-filenames
|
||||
Usage: mise run docs-check-filenames
|
||||
"""
|
||||
|
||||
import sys
|
||||
|
|
@ -14,7 +14,7 @@ target (e.g., alloy.md is matched by [[alloy]]) in the category index.
|
|||
|
||||
Index files are excluded from the self-check.
|
||||
|
||||
Usage: mise run doc-index
|
||||
Usage: mise run docs-check-index
|
||||
"""
|
||||
|
||||
import re
|
||||
|
|
@ -17,7 +17,7 @@ Wiki-link formats supported:
|
|||
Path-based links (containing '/') are NOT supported to ensure all
|
||||
filenames are unique and links work correctly in obsidian.nvim.
|
||||
|
||||
Usage: mise run doc-links
|
||||
Usage: mise run docs-check-links
|
||||
"""
|
||||
|
||||
import re
|
||||
|
|
@ -15,7 +15,7 @@ so titles must be:
|
|||
- Unique across the documentation
|
||||
- Lowercase with hyphens (no spaces or uppercase)
|
||||
|
||||
Usage: mise run doc-titles
|
||||
Usage: mise run docs-check-titles
|
||||
"""
|
||||
|
||||
import re
|
||||
|
|
@ -11,7 +11,7 @@ changelog.d/), selects one at random, and displays it for review.
|
|||
|
||||
Useful for periodic knowledge base maintenance and verification.
|
||||
|
||||
Usage: mise run doc-random
|
||||
Usage: mise run docs-review-random
|
||||
"""
|
||||
|
||||
import random
|
||||
|
|
@ -12,7 +12,7 @@ threshold (default 180 days) are highlighted as stale.
|
|||
|
||||
This is informational only — it always exits 0.
|
||||
|
||||
Usage: mise run doc-stale [-- --threshold 90]
|
||||
Usage: mise run docs-review-stale [-- --threshold 90]
|
||||
"""
|
||||
|
||||
import subprocess
|
||||
|
|
@ -12,7 +12,7 @@ docs use each tag.
|
|||
|
||||
This is informational only — it always exits 0.
|
||||
|
||||
Usage: mise run doc-tags
|
||||
Usage: mise run docs-review-tags
|
||||
"""
|
||||
|
||||
import sys
|
||||
Loading…
Add table
Add a link
Reference in a new issue