Skip to content

docs(helm): document supported values and add usage examples#280

Open
chihkang wants to merge 2 commits intoopenabdev:mainfrom
chihkang:docs/helm-values-reference
Open

docs(helm): document supported values and add usage examples#280
chihkang wants to merge 2 commits intoopenabdev:mainfrom
chihkang:docs/helm-values-reference

Conversation

@chihkang
Copy link
Copy Markdown

Summary

This PR improves the Helm chart documentation by adding several supported but currently undocumented values to the values reference and README.

Users can already rely on these options in practice, but today they are difficult to discover unless they inspect the chart templates directly. This change makes the chart easier to use and reduces trial-and-error during deployment.

Closes #163.

Changes

  • add fullnameOverride to values.yaml
  • add nameOverride to values.yaml
  • document envFrom in values.yaml comments and chart docs
  • document agentsMd usage with --set-file
  • document the discord.allowedChannels --set-string requirement more prominently
  • add a chart-level Helm values reference with practical examples
  • link the main README Helm install section to the chart values reference

Why

The chart already supports these configuration paths, but they are not clearly documented. That creates unnecessary friction for users, especially for:

  • multi-instance deployments
  • secret-based environment injection
  • large AGENTS.md configurations
  • Discord channel ID configuration

Notes

This PR is documentation-focused and does not change chart behavior. It only makes existing supported options easier to discover and use.

Testing

  • reviewed chart templates to confirm the documented values are already supported
  • documentation change only; helm CLI was not available in the local environment for helm lint

@chihkang chihkang requested a review from thepagent as a code owner April 13, 2026 07:29
@thepagent thepagent added the p3 Low — nice to have label Apr 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

p3 Low — nice to have

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add Helm values reference with undocumented options

2 participants