Skip to content

Principle 1: Docs describe what exists

Document only the current state of main. Do not describe planned or in-progress work.

Live documentation

Code changes and docs ship together in every PR.

Core Rules

  • Keep facts in docs/. Speculation, roadmaps, and ideas belong outside the repo.
  • Do not write docs for a feature until the feature PR is ready to merge.
  • Update docs whenever code changes in the same PR.