auto generate helm readme so that drift between document and code remains at minimum + beautify(fix formatting issues) YAML

[avirajkhare00]

Context

Also, should we clean up comments from values.yaml, otherwise there will always be documentation drift between two

Good point. For this PR, the values.yaml comment and README are consistent (both describe serviceMonitor as opt-in for Prometheus Operator users), so there's no immediate drift. But you're right that maintaining descriptions in both places long-term is fragile. The # -- comments in values.yaml follow the helm-docs convention -- the standard approach is to auto-generate the README parameter table from those comments so there's a single source of truth. That would be a nice follow-up but shouldn't block this PR. @avirajkhare00

Originally posted by @atharvalade in #2976 (comment)

Tool to use: https://github.com/norwoodj/helm-docs

Open to feedback for the same.

[avirajkhare00]

Please assign this issue to me. I can take this up.

[hubcio]

@avirajkhare00 assigned

[avirajkhare00]

Part of helm refactor. Will pick up today or tomm

[avirajkhare00]

Will fix yaml lint issues in same PR.