Skip to content
Owner: @lop • archived

Quick-Run

Ship a docs change? Run this in under 10 minutes. Run the Quick-Run or Open the Proof Run.

Trigger

  • You edited or moved a Markdown file
  • CI passed but a reviewer flagged a broken link, asset, or embed
  • You need a receipt that the surface still works

Prep

  • pnpm install once per workstation
  • Keep rg available for link search/replace

Run it

  1. Open the edited page and scan for obvious regressions (links, images, embeds).
  2. Run the automated check that matches your change scope:
    • Single page → pnpm run guard --filter <file>
    • Multiple files → pnpm run guard
  3. Read the first failure. Fix that path before addressing the rest; it usually cascades.
  4. Search for ghosts. Use rg broken-slug to update every occurrence of the old link.
  5. Re-run the guard until it exits 0.
  6. Capture a receipt (terminal output or screenshot) and drop it in the PR or issue.

Receipt

  • Guard command exits 0
  • PR or issue contains the receipt screenshot or log
  • Reviewer can click the changed page without hitting errors

Stop rule

If you spend more than 10 minutes chasing failures or the guard stays red after two fixes, stop and escalate: run the Link drift Proof Run or open a kl,question issue with the failing slug.

Text © CC BY-NC 4.0 • Code samples MIT • Views are my own.