eblume/blumeops
1
1
Fork 0
Code Issues Pull requests Projects Releases 83 Packages Wiki Activity Actions

Add docs-preview task and visual preview step to doc review

Browse source 
New `mise run docs-preview <card>` task builds docs via Dagger and serves
them locally in the production quartz container (image parsed from ArgoCD
kustomization), opening the browser directly to the specified card.
Container auto-cleans after 1 hour.

Also updates docs-review checklist and review-documentation how-to to
reference the visual preview workflow.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Erich Blume 2026-03-11 18:04:01 -07:00
commit d01a165b91
4 changed files with 151 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/changelog.d/+docs-preview.feature.md Normal file
View file

@ -0,0 +1 @@
Add `docs-preview` mise task: builds docs with Dagger and serves them locally in the production quartz container, opening the browser directly to the specified card. Also adds visual preview hints to the `docs-review` checklist and the review-documentation how-to.

14
docs/how-to/knowledgebase/review-documentation.md
View file

@ -92,6 +92,20 @@ mise run dns-preview # DNS (Gandi)
If changes are pending, investigate whether docs or infrastructure is stale.
## Visual Preview
After reviewing and editing a card, visually verify the rendered output.
**Quick scan (agent):** Have the agent display the card with `bat` for a terminal-based visual check.
**Full rendered preview:** Build the entire Quartz docs site locally and open directly to the card:
```bash
mise run docs-preview how-to/knowledgebase/review-documentation
```
This builds the docs with Dagger, serves them on `localhost:8484`, and opens the browser to the specified card. Press Ctrl-C to stop. Accepts paths with or without the `.md` suffix.
## Making Changes
If a card needs updates, classify the change (see [[agent-change-process]]):