Documentation
¶
Overview ¶
Command gendocs renders docs/reference/configuration.md from the source of truth: the env-tagged fields on config.Config, their doc comments, and the deprecatedVars table.
The reference used to be a hand-maintained table in README.md. It drifted: twelve live knobs went undocumented, two defaults were simply wrong, and the twenty-one removed variables (two of which refuse the boot) were recorded nowhere at all. Generating the page removes the opportunity for that to happen again.
The generator is deliberately strict. It refuses to emit anything when a variable is missing from the group table or has no doc comment, so a new setting cannot reach a release without also reaching the docs. That is the specific failure it exists to prevent: MEMINI_STABILITY_K shipped a changed recall default that no document mentioned.
Source Files