Skip to content

Bring the contributor docs up to date with the repo ​

The v0.2.0 site review found contributor docs describing an earlier repo. Each item below was checked against the file it names:

  • docs/development/README.md says "Informs Q7" and calls the design doc pending ("once adopted"). Q7 shipped in #20 and the design doc was adopted in #14.
  • docs/development/kubernetes-conventions.md calls itself the spec "until they land". Those patterns landed in internal/controller/metrics.go and observability.go.
  • docs/development/documentation-standards.md says the project is in early development and names a docs/operations/ directory that never existed. technical-debt.md uses the same path in an example.
  • CONTRIBUTING.md lists six of make check's targets and says it mirrors CI, which it does not. It also says make manifests generate where verify-helm-sync needs helm-sync too, and never mentions make vendor.
  • docs/development/releasing.md does not mention the meta description a news post needs in website/.vitepress/config.mjs.
  • docs/development/kind-iteration.md never says how the Deployment gets the new image.
  • CLAUDE.md names four CI workflows; eight run.

One docs PR can clear all of them.