Keep docs, examples, setup instructions, and generated contract guidance honest with the codebase.
README.md
docs/**
AGENTS.md
setup and contributor guidance tied to live workflows
route accuracy
quickstart correctness
CLI and SDK example freshness
documenting known broken checks clearly
stale /v1 assumptions
/v1
stale docs around auth ownership and request payloads
docs implying broken lint/test flows are reliable
compare prose directly to mounted routes and commands
run npm run generate-types when contract docs intentionally move
npm run generate-types
trust code over prose when they conflict
do not preserve stale docs for appearance
update docs in the same change window when behavior changes
Last updated 6 hours ago