
Your Docs Are Likely Obsolete
Every codebase I've worked on has had the same problem: documentation that was accurate when it was written but slowly drifted out of sync with the code. Someone adds a new enum variant or config option, the PR gets reviewed, tests pass, it ships - and nobody remembers to update the README. Three months later a new hire follows the docs and nothing works. Code reviews are supposed to catch this, but in practice "did you update the docs?" is one of the first things to slip through. It's tedious to check, easy to forget, and there's no tooling to enforce it. So I built BlockWatch — a linter that creates explicit, machine-enforced links between code and its documentation. What it does BlockWatch uses HTML-like tags inside your existing comments to define "blocks" with validation rules. The most useful rule is affects : it creates a dependency between two blocks across files, so changing one will fail the linter until you update the other. Here's what that looks like in practice. Say you h
Continue reading on Dev.to
Opens in a new tab


