docs(helm): add helm-docs annotations and generate chart README#641
Merged
bodji merged 1 commit intoroot-gg:masterfrom Feb 25, 2026
Merged
docs(helm): add helm-docs annotations and generate chart README#641bodji merged 1 commit intoroot-gg:masterfrom
bodji merged 1 commit intoroot-gg:masterfrom
Conversation
bodji
force-pushed
the
docs/helm-chart-readme
branch
3 times, most recently
from
4dc4b12 to
3e12255
Compare
Add helm-docs `# --` annotations to all values in values.yaml. Create README.md.gotmpl template with installation instructions and quick-start examples. Generate README.md with a complete values reference table. Add `make helm-docs` target and integrate it as a dependency of `make helm`. Document the values reference in kubernetes.md. Add helm-docs CI job to tests.yaml that catches forgotten regeneration by checking for uncommitted changes after running make helm-docs.
bodji
force-pushed
the
docs/helm-chart-readme
branch
from
3e12255 to
a09b98e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Add helm-docs support to the Plik Helm chart with a fully generated values reference.
Why
The chart had no README and values lacked structured documentation, making it hard for users to discover and configure available options.
Changes
charts/plik/values.yaml— Added# --helm-docs annotations to all ~90 configurable valuescharts/plik/README.md.gotmpl— Template with installation instructions, quick-start examples, and architecture linkcharts/plik/README.md— Auto-generated values reference tableMakefile— Newmake helm-docstarget;make helmnow depends on it for auto-regenerationdocs/guide/kubernetes.md— Added Values Reference section linking to the chart READMETesting
helm-docs --chart-search-root ./chartsgenerates the README successfullymake helm-docstarget tested