Skip to content

chore: split Helm pages#993

Merged
mbevc1 merged 2 commits into
mainfrom
20260706_split_helm
Jul 6, 2026
Merged

chore: split Helm pages#993
mbevc1 merged 2 commits into
mainfrom
20260706_split_helm

Conversation

@mbevc1

@mbevc1 mbevc1 commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Split Helm Mintlify docs pages into subpages to make it more readable.

@claude

claude Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Claude finished @mbevc1's task in 2m 4s —— View job


Claude PR Review

  • Gather context (read all changed files)
  • Static analysis (N/A — docs-only, no Go changes)
  • Review templating changes
  • Post review

This PR splits the single Mintlify page into per-topic subpages (overview, prerequisites, installing, upgrading, uninstalling, tls-proxy, karpenter, configuration) with a CardGroup index on the overview. It's a well-executed, low-risk documentation change.

Verification

  • Template wiring is sound. Every entry point in mintlify/*.md.gotmpl calls a define that exists in _mintlify_templates.gotmpl, and each of those resolves its body.* / mintlify.* sub-templates. No dangling template references.
  • CardGroup links all resolve. The 7 <Card href=...> targets in mintlify.overviewBody each map to a file that was added (prerequisites, installing, upgrading, uninstalling, tls-proxy, karpenter, configuration). Cross-page links inside partials (e.g. mintlify.upgrading/helm/k8s_reporter/installing, mintlify.installing/helm/k8s_reporter/configuration) also point at real pages.
  • Link handling is consistent. mintlify.paramField rewrites https://docs.kosli.com// so the values.yaml doc links render as internal Mintlify links on the config page while staying absolute in the README. The values.yaml link updates (README-section → docs-page URLs) match the new page structure.

The prior duplication concern — largely addressed 👍

The earlier review flagged parallel mintlify.* copies of README prose. The second commit ("reuse partials") is a good response: shared prose now lives in body.* partials in _templates.gotmpl and is consumed by both the extra.* (README) and mintlify.* (docs) sides, with a clear header comment documenting the split. That's a real improvement.

Residual maintenance note (non-blocking)

The three large sections — mintlify.installing / mintlify.tlsProxy / mintlify.karpenter — are still full prose duplicates of their extra.install / extra.customCA / extra.karpenter counterparts. The fork is justified (the Mintlify versions use <Steps>, <Warning>, <Note> components and different heading levels, so they can't be shared verbatim), and you've documented it in the file header. The residual risk is that edits to, say, the multi-environment install YAML example in one place won't propagate to the other. Worth keeping in mind, but no action needed now — the body.* extraction already captured the parts that could be shared cleanly.

Summary

No bugs, no broken references, consistent with the existing helm-docs conventions. LGTM. ✅
· 20260706_split_helm

Comment thread charts/k8s-reporter/_mintlify_templates.gotmpl
@mbevc1
mbevc1 enabled auto-merge (squash) July 6, 2026 14:01
@mbevc1
mbevc1 merged commit b4e74a8 into main Jul 6, 2026
16 checks passed
@mbevc1
mbevc1 deleted the 20260706_split_helm branch July 6, 2026 14:02
mbevc1 added a commit to kosli-dev/docs that referenced this pull request Jul 6, 2026
Splits Helm chart pages to subpages.

Needs kosli-dev/cli#993
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants