docs: add Mintlify helm-docs template for k8s-reporter#854
Conversation
Add a second helm-docs template set that generates Mintlify-compatible
output with <ParamField> components for the configurations section and
an <Info> version callout. The prose sections (install, upgrade, customCA,
etc.) are shared with the existing README template to avoid duplication.
Also fix two Mintlify-compatibility issues in the shared templates:
- Remove {.command} Hugo attribute from shell code fences
- Wrap <instance_name> in backticks in values.yaml env description
Closes #853
|
Claude finished @dangrondahl's task in 2m 11s —— View job PR Review: Mintlify helm-docs template for k8s-reporter
Static AnalysisAll clean — Review SummaryClean, well-structured PR. The shared-template approach avoids prose duplication, the Detailed FeedbackGood patterns worth calling out
Minor observations
No issues found with
Verdict: Looks good to merge. No bugs or security issues. The template logic is correct and the approach is well-designed for maintainability. |
## Summary - Updates the `helm-docs` template files in the reference docs workflow to use Mintlify-specific templates (`MINTLIFY.md.gotmpl`, `_mintlify_templates.gotmpl`) instead of `README.md.gotmpl`. ## Blocked on - Waiting on kosli-dev/cli#854 to be merged first (adds the new template files to the CLI repo). ## Test plan - [ ] Merge kosli-dev/cli#854 - [ ] Trigger the `Update Reference Docs` workflow and verify helm docs generate correctly with the new templates.
Summary
MINTLIFY.md.gotmpl+_mintlify_templates.gotmpl) that generates Mintlify-compatible output with<ParamField>components and an<Info>version callout_templates.gotmplto avoid duplication{.command}Hugo attribute from shell code fences (Mintlify doesn't support it; GitHub ignores it)<instance_name>in backticks invalues.yamlso MDX parser won't treat it as an HTML tagHow it works
The docs repo workflow runs helm-docs twice with different template sets:
Once this lands and a chart version is released, the hand-crafted
helm/k8s_reporter.mdxin the docs repo can be deleted.Test plan
helm-docs --template-files README.md.gotmpl,_templates.gotmpl --dry-runand verify README output is unchanged except{.command}removalhelm-docs --template-files MINTLIFY.md.gotmpl,_templates.gotmpl,_mintlify_templates.gotmpl --dry-runand verify Mintlify output has<ParamField>components with correct descriptions and defaults<instance_name>is wrapped in backticks in both outputsCloses #853