# norwoodj/helm-docs

A tool for automatically generating markdown documentation for helm charts

Repository: https://github.com/norwoodj/helm-docs
Canonical: https://ross.abutalabs.com/products/helm-docs
Language: Go
License: GPL-3.0
License Family: copyleft
Last push: 2026-06-22T09:25:43+00:00

## Health v2 (maintenance only)
Score: 62/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 88, release rhythm 8, longevity 100
- inputs: {"age_days": 2923, "days_push": 72, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1761, forks 218 (observed 2026-08-28T04:05:32.676961+00:00)

## What it is
helm-docs is a Go CLI tool that automatically generates markdown documentation for Helm charts. It parses chart metadata and values, extracting field descriptions from special comments, and renders them into README files via Go templates.

## Use cases
- generate readme documentation for helm charts
- document chart values tables automatically
- extract value descriptions from yaml comments
- keep helm chart docs in sync with values.yaml
- render chart docs from custom gotmpl templates

## When to choose
- you maintain helm charts and want auto-generated values documentation
- you want descriptions pulled from `# --` comments in values.yaml
- you need consistent README tables across many charts in CI

## When to avoid
- you don't use helm or kubernetes
- you need docs for non-chart yaml files
- you want HTML or non-markdown output

## Facets
- artifact type: cli-tool
- maturity: active
- function: documentation, cli, markdown, templating
- domain: developer-tools, documentation
- platform: windows, cli, cross-platform
- tags: helm, kubernetes, charts, readme-generation, go, devops, command-line, linux, macos

## Member repositories
- norwoodj/helm-docs (main) score 62

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:05:32.676961+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T03:27:11.772040+00:00, confidence not recorded.
  - readme: https://github.com/norwoodj/helm-docs (fetched 2026-08-28T04:05:32.676961+00:00, sha f43274c40d58)
- Data as of 2026-08-30T08:39:29.467469+00:00.