Repository navigation
Generate ToolHive Helm values references - #1226
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The generator flattens structured chart comments, and the reference omits supported values while being presented as complete.
3 open findings
What changed in this PR
Adds automated ToolHive Helm values references generated from pinned release sources and integrates them into the documentation site.
Changes:
- Adds and tests the Helm reference generator.
- Updates release automation with checksum-verified
helm-docs. - Adds generated references, navigation, and deployment-guide links.
| File | Description |
|---|---|
sidebars.ts |
Adds Helm references to Kubernetes navigation. |
scripts/upstream-release/helm-values.gotmpl |
Serializes Helm value metadata. |
scripts/upstream-release/generate-helm-reference.test.mjs |
Tests rendering and validation. |
scripts/upstream-release/generate-helm-reference.mjs |
Generates reference MDX. |
docs/toolhive/reference/index.mdx |
Adds grouped Helm reference cards. |
docs/toolhive/reference/helm/operator.mdx |
Provides generated operator values. |
docs/toolhive/reference/helm/operator-crds.mdx |
Provides generated CRD chart values. |
docs/toolhive/guides-k8s/deploy-operator.mdx |
Links deployment guidance to references. |
AGENTS.md |
Marks Helm references as generated. |
.github/workflows/upstream-release-docs.yml |
Installs and runs pinned helm-docs. |
.github/upstream-projects.yaml |
Configures Helm charts and output pages. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
3 tasks done
danbarr
enabled auto-merge (squash)
October 9, 2026 18:02
rdimitrov
approved these changes
Oct 9, 2026
This branch was successfully deployed
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
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.
Description
Generate Helm values references for the ToolHive operator, operator-CRDs, and Registry Server charts from their release checkouts using a pinned, checksum-verified helm-docs binary. Pages include field anchors, types, defaults, and upstream descriptions, with expandable YAML for large defaults. The website builds from checked-in MDX without a Go toolchain.
Preserve multiline source comments so YAML examples and lists remain readable. The references state their coverage of values declared in the default values.yaml, and normalize ToolHive spelling in prose while preserving code literals. Document the Registry Server's application config as a passthrough block with links to its configuration and database guides; the curated description lives in the generation configuration.
Add all three references to their product sidebars, deployment guides, and the grouped reference landing page. Release automation discovers chart inputs declaratively and refreshes generated pages before content sessions.
Type of change
Related issues/PRs
Addresses the ToolHive and Registry Server portions of #957. Enterprise reference generation remains a follow-up; upstream description coverage is addressed in stacklok/stacklok-enterprise-platform#4895.
Validation
npm run build,npm run prettier, andnpm run eslintpassed.$/.github/actions/setupreference, also present on the base branch.Submitter checklist
Content and formatting
Navigation
Reviewer checklist
Content