diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 438a742..77e49d8 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -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 diff --git a/docs/changelog.d/rename-doc-tasks.misc.md b/docs/changelog.d/rename-doc-tasks.misc.md new file mode 100644 index 0000000..141c940 --- /dev/null +++ b/docs/changelog.d/rename-doc-tasks.misc.md @@ -0,0 +1 @@ +Rename `doc-*` mise tasks to `docs-check-*` / `docs-review-*` for clearer naming convention. diff --git a/docs/how-to/knowledgebase/review-documentation.md b/docs/how-to/knowledgebase/review-documentation.md index e286e1b..4633cf5 100644 --- a/docs/how-to/knowledgebase/review-documentation.md +++ b/docs/how-to/knowledgebase/review-documentation.md @@ -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. diff --git a/docs/tutorials/ai-assistance-guide.md b/docs/tutorials/ai-assistance-guide.md index 06a259a..6b9dc86 100644 --- a/docs/tutorials/ai-assistance-guide.md +++ b/docs/tutorials/ai-assistance-guide.md @@ -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: diff --git a/mise-tasks/doc-filenames b/mise-tasks/docs-check-filenames similarity index 98% rename from mise-tasks/doc-filenames rename to mise-tasks/docs-check-filenames index fe626f0..9cb5db8 100755 --- a/mise-tasks/doc-filenames +++ b/mise-tasks/docs-check-filenames @@ -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 diff --git a/mise-tasks/doc-index b/mise-tasks/docs-check-index similarity index 99% rename from mise-tasks/doc-index rename to mise-tasks/docs-check-index index dcc8e9c..47695d6 100755 --- a/mise-tasks/doc-index +++ b/mise-tasks/docs-check-index @@ -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 diff --git a/mise-tasks/doc-links b/mise-tasks/docs-check-links similarity index 99% rename from mise-tasks/doc-links rename to mise-tasks/docs-check-links index 6477b36..3d62971 100755 --- a/mise-tasks/doc-links +++ b/mise-tasks/docs-check-links @@ -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 diff --git a/mise-tasks/doc-titles b/mise-tasks/docs-check-titles similarity index 99% rename from mise-tasks/doc-titles rename to mise-tasks/docs-check-titles index af33229..4f162fd 100755 --- a/mise-tasks/doc-titles +++ b/mise-tasks/docs-check-titles @@ -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 diff --git a/mise-tasks/doc-random b/mise-tasks/docs-review-random similarity index 98% rename from mise-tasks/doc-random rename to mise-tasks/docs-review-random index 05cad28..542b780 100755 --- a/mise-tasks/doc-random +++ b/mise-tasks/docs-review-random @@ -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 diff --git a/mise-tasks/doc-stale b/mise-tasks/docs-review-stale similarity index 98% rename from mise-tasks/doc-stale rename to mise-tasks/docs-review-stale index 7e1c279..819660f 100755 --- a/mise-tasks/doc-stale +++ b/mise-tasks/docs-review-stale @@ -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 diff --git a/mise-tasks/doc-tags b/mise-tasks/docs-review-tags similarity index 98% rename from mise-tasks/doc-tags rename to mise-tasks/docs-review-tags index 61022c9..a4712e4 100755 --- a/mise-tasks/doc-tags +++ b/mise-tasks/docs-review-tags @@ -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