Skip to content
memex

Guide

Checking drift

Read the intent, read the code, and fix whichever is wrong, in the same change.

When to use it

When code has moved and its READMEs, headers or cases may no longer say what it does, or as a routine pass over one folder.

Why it matters: Drift.

Steps

  1. Run memex show <dir>, then read the code it describes.
  2. For each claim: does the code do it? Is there a cited case that proves it?
  3. Run memex audit <dir> for unresolved citations, missing headers and missing READMEs.
  4. Fix the README, header or collection doc in the same change, or, if it’s out of scope, log the mismatch to drift.

Log a mismatch

$ memex log drift --tag namer <<'EOF'
crates/namer/README.md claims collisions are kept apart; no case proves it
EOF

When you change code, update the header or README you invalidated in the same commit, put the id in each new test, then run memex audit <paths> and fix what it lists.

← All guides