Skip to content

April 12: Doc Drift Cleanup

Single-PR day — went through the 10 reference files the doc-drift hook had been nagging about and brought them current with the code.

Developer Journal

Stale documentation across 10 reference files (#1150)

The post-edit-doc-drift hook had been warning about the same ten-ish reference files for weeks. Some were easy (method signatures that had drifted after a refactor), some had whole sections about features that no longer existed, a couple referenced file paths that had been renamed in the Phase 4 reorganization.

Went through each systematically — read the referenced code, reconciled the doc against it, removed dead content, updated the parts that had drifted. No behavior changes, just reality-alignment. The hook should quiet down for a while.

Files touched:

  • docs/architecture/processing-engine.md — composite pipeline now reflects the staged refactor from #1091
  • docs/architecture/backend-api.md — exception hierarchy and error envelope from #983
  • docs/quick-reference.md — removed dead endpoints, added the composite unsharp_* fields
  • docs/key-files.md — updated service file paths
  • docs/standards/ — several files with stale examples
  • Four more scattered across the architecture views

What shipped

PR Title
#1150 docs: update stale documentation across 10 reference files