Rendered from docs/how-to/README.md in the Headwater corpus. Every document on this half of the site is typed by the taxonomy the descriptor names: corpus.json.

How-to guides

The documents on this shelf, in the reading order this corpus derives.

  • Cut a release — Bump the version, push a v* or taxonomy tag, confirm the workflow each tag starts, and move the install text last. (asserted, and no human has accepted it)
  • Diagnose an isolation failure — Five questions separate a failure of your change from a failure of the checkout it ran in, and each one is one command. (asserted, and no human has accepted it)
  • Keep derived files from conflicting in parallel pull requests — Commit the derived files a person reads on the forge, compute the graph export where a build step reads it, and union the capture-cost store. (asserted, and no human has accepted it)
  • Mine the shadow-mode routing log — Join the shadow log to the session transcripts by prompt identifier, and read the deterministic route against the embedding path one prompt at a time. (asserted, and no human has accepted it)
  • Publish your corpus as a site — MkDocs builds a site from the navigation that headwater generate writes, and headwater site then holds the built site against the corpus. (asserted, and no human has accepted it)
  • Relocate a shelf — An overlay relocates a shelf with one override key, and the move breaks every relative link into the old path until you repair them.
  • Rotate or revoke the APT signing subkey — How a maintainer replaces or withdraws the subkey that signs the Headwater APT metadata, and what each adopter must download again (asserted, and no human has accepted it)
  • Wire headwater check into your own workflow — A composite action runs headwater check --strict against your own corpus, with the released binary alone: no clone, no Rust toolchain, no cargo. (asserted, and no human has accepted it)