Building docs that ship with the code

Every PR gets a README diff Documentation changes live alongside code changes. No separate tickets, no lag between release and reference.

Markdown is the single source of truth No wiki. No Confluence. No stale PDF exports. The repo holds one canonical file that renders everywhere.

CI fails if the examples break Code fences in the README are tested in every pipeline. A broken snippet blocks the merge — not a bug report three weeks later.

Badges surface health at a glance Build status, coverage, version, license — four shields replace four paragraphs. Contributors see project state in two seconds.