fix: use Mintlify MDX components in helm chart docs templates#871
Merged
Conversation
Add mintlify.install and mintlify.customCA template overrides so the Mintlify output uses <Steps>, <Note>, <Info>, <Warning> and <ParamField> components while the plain markdown README stays unchanged. - Replace numbered lists with <Steps>/<Step> in install and customCA sections - Replace blockquotes with <Note>, <Info>, <Warning> callouts - Remove backticks from section headings (customCA, extraVolumes, etc.) - Auto sentence-case ParamField descriptions (capitalize first word, add period) - Escape angle brackets in values.yaml descriptions to avoid JSX parse errors
Contributor
|
Claude finished @dangrondahl's task in 2m 48s —— View job PR Review: fix: use Mintlify MDX components in helm chart docs templates
Static AnalysisAll checks pass: SummaryClean, well-structured PR. The approach of creating dedicated What works well:
One observation (not a blocker):
No bugs, security issues, or correctness concerns found. LGTM. |
mbevc1
approved these changes
May 8, 2026
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.
Summary
mintlify.installandmintlify.customCAtemplate overrides in_mintlify_templates.gotmplso the Mintlify output uses<Steps>,<Note>,<Info>,<Warning>components while the plain markdown README stays unchanged<ParamField>descriptions (capitalize first word, ensure trailing period)values.yamldescriptions (<instance_name>→INSTANCE_NAME) to prevent JSX parse errors in MDXCloses #853
Test plan
cd charts/k8s-reporter && helm-docs --template-files README.md.gotmpl,_templates.gotmpland verify README.md has no Mintlify componentscd charts/k8s-reporter && helm-docs --template-files MINTLIFY.md.gotmpl,_templates.gotmpl,_mintlify_templates.gotmpland copy output to docs repo ashelm/k8s_reporter.mdx