Source: https://phalanx.lsst.io/developers/helm-chart/values-yaml.html, which applies helm-docs
(github.com/norwoodj/helm-docs). Archived 2026-10-25 as a close summary (the fetch tool returns
summaries, not verbatim pages).
- Every setting gets a description comment directly above it, starting with
# --, written in
Markdown; it may span several lines.
- A blank line between settings, before the next
# -- comment.
- The generated docs show each setting's default automatically; a
# @default -- comment replaces it
(useful when the real default is a placeholder, or a long structure that would clutter the table -
then point readers to the file instead).
- Only settings that can differ between environments belong in the values file; fixed things belong in
the templates.
- Tooling reads only the
# -- form; comments in other shapes are dropped from the generated README
(Big Bang project notes), so one consistent marker matters if docs are ever generated from comments.