Add doc-random task and documentation improvements #98

Merged
eblume merged 3 commits from feature/random-doc-review into main 2026-02-03 21:17:59 -08:00
2 changed files with 44 additions and 1 deletions
Showing only changes of commit 07777212ec - Show all commits

Add deployment verification prompts to doc-random

- Add "Verify Deployed State" section to review checklist
- Expand how-to with commands for ArgoCD, Ansible, and Pulumi verification

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Erich Blume 2026-02-03 21:16:50 -08:00

View file

@ -33,6 +33,45 @@ When reviewing a documentation card, consider:
| **Frontmatter** | Are title and tags appropriate? |
| **Related** | Should it link to related cards? |
## Verify Deployed State
For service reference cards, verify the documentation matches reality:
### ArgoCD Apps (Kubernetes services)
Check if the app is synced and healthy:
```bash
argocd app get <app-name>
argocd app diff <app-name> # Show pending changes
```
If out of sync, either the docs are stale or a deployment is pending.
### Ansible Roles (indri services)
Check if the role applies idempotently (no changes needed):
```bash
mise run provision-indri -- --tags <role> --check --diff
```
If changes would be made, either the docs are stale or the host has drifted.
### Pulumi (Tailscale ACLs, DNS)
Check for drift:
```bash
# Tailscale ACLs
cd pulumi/tailscale && pulumi preview
# DNS (Gandi)
cd pulumi/gandi && pulumi preview
```
If changes are pending, investigate whether docs or infrastructure is stale.
## When to Review
Consider running `mise run doc-random` during:

View file

@ -72,7 +72,11 @@ def main() -> int:
"• Is the card too large and should be split?\n"
"• Is the card too small and should be merged?\n"
"• Does the frontmatter (tags, title) make sense?\n"
"• Is the card in the correct category (reference/how-to/etc)?",
"• Is the card in the correct category (reference/how-to/etc)?\n\n"
"[bold]Verify Deployed State:[/bold]\n\n"
"• If ArgoCD app: is it synced? (argocd app get <app>)\n"
"• If Ansible role: does it apply idempotently? (--check --diff)\n"
"• If Pulumi: is there drift? (pulumi preview)",
title="[bold yellow]Review Guidance[/bold yellow]",
border_style="yellow",
))