Document All Helm Values

This rule applies to files matching the patterns above.

# Document All Helm Values

## Rule
Every value in values.yaml MUST have a comment describing its purpose. Use the `# --` prefix for helm-docs compatibility. Group related values with section headers.

## Format
```yaml
# -- Description of what this value controls
key: defaultValue
```

## Good Examples
```yaml
# -- Number of pod replicas
replicaCount: 1

image:
  # -- Container image repository
  repository: myapp/api
  # -- Image pull policy [Always, IfNotPresent, Never]
  pullPolicy: IfNotPresent
  # -- Image tag (defaults to chart appVersion if empty)
  tag: ""

resources:
  requests:
    # -- CPU request per pod
    cpu: 100m
    # -- Memory request per pod
    memory: 128Mi
  limits:
    # -- Memory limit per pod (no CPU limit recommended)
    memory: 256Mi

autoscaling:
  # -- Enable Horizontal Pod Autoscaler
  enabled: false
  # -- Minimum replica count
  # @default -- 2
  minReplicas: 2
  # -- Maximum replica count
  maxReplicas: 10
```

## Bad Examples
```yaml
# BAD: No comments at all
replicaCount: 1
image:
  repository: myapp/api
  pullPolicy: IfNotPresent
  tag: ""

# BAD: Comments that don't explain anything
# replicaCount
replicaCount: 1
# image
image:
  # repository
  repository: myapp/api
```

## Generating Documentation
```bash
# Install helm-docs
brew install norwoodj/tap/helm-docs

# Generate README from values.yaml comments
helm-docs --chart-search-root ./charts
```

## Enforcement
- helm-docs in CI to verify README is up to date
- Code review: reject undocumented values
- JSON schema alongside values.yaml for type validation