Skip to content

docs: update CLI and helm reference for v2.30.1#308

Open
github-actions[bot] wants to merge 2 commits into
mainfrom
reference-docs/v2.30.1
Open

docs: update CLI and helm reference for v2.30.1#308
github-actions[bot] wants to merge 2 commits into
mainfrom
reference-docs/v2.30.1

Conversation

@github-actions

@github-actions github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Automated update of CLI and Helm reference documentation for release v2.30.1.

@github-actions github-actions Bot requested a review from a team as a code owner July 3, 2026 17:39
@mintlify

mintlify Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
kosli 🟢 Ready View Preview Jul 3, 2026, 5:41 PM

@claude

claude Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Claude finished @mbevc1's task in 1m 39s —— View job


Reviewing PR #308

  • Gather context and read changed files
  • Review helm/k8s_reporter.mdx (new file)
  • Review CLI reference changes
  • Check navigation configuration
  • Post review findings

Review Summary

This PR updates CLI reference docs for v2.30.1 and adds a new consolidated Helm chart page. The CLI changes are auto-generated "live example" output refreshes — updated snapshot indices, timestamps, commit SHAs, and a couple of new response fields. Those all look correct.

The main concern is around the new helm/k8s_reporter.mdx file.


Findings

helm/k8s_reporter.mdx — Critical: not in navigation, coexists with old sub-pages

Status: The previous review already flagged this (see inline comment), and it remains unresolved after the latest push.

The new helm/k8s_reporter.mdx consolidates content currently spread across 8 sub-pages in helm/k8s_reporter/ (overview, prerequisites, installing, upgrading, uninstalling, tls-proxy, karpenter, configuration). However:

  1. Not in navigationhelm/k8s_reporter is absent from config/navigation.json. Per repo rules, every new page must be added to navigation.
  2. Old sub-pages still present — The helm/k8s_reporter/ directory and its 8 files still exist, and navigation still points to them (lines 522–533 of config/navigation.json). This creates duplicate content.

Action needed: Decide the intended structure:

  • If replacing sub-pages: remove the helm/k8s_reporter/ directory, replace the navigation group entries with "helm/k8s_reporter", and add redirects in config/redirects.json from old paths → new path.
  • If coexisting: add "helm/k8s_reporter" to navigation alongside the sub-pages, and differentiate the content.

helm/k8s_reporter.mdx — Suggestion: description capitalization

Line 3 uses lowercase "CronJob" which is correct in the description field. No action needed (the earlier review comment about this was based on the pre-edit version — the current file already has it capitalized correctly on line 3).

CLI reference changes — No issues

All 17 modified client_reference/ files contain expected auto-generated updates:

Change type Files
Updated GitHub commit SHA links kosli_assert_artifact, kosli_attest_artifact, kosli_attest_custom, kosli_attest_generic, kosli_attest_junit, kosli_attest_pullrequest_github, kosli_attest_pullrequest_gitlab, kosli_attest_sonar, kosli_begin_trail
Refreshed live example output (timestamps, indices, data) kosli_diff_snapshots, kosli_get_environment, kosli_get_snapshot, kosli_list_environments, kosli_list_flows, kosli_list_snapshots, kosli_log_environment
New response fields in output (flow_name, trail_name) kosli_get_attestation
Updated CLI version string overview

These are all mechanical, auto-generated updates with no content issues. Internal links use root-relative paths. No relative links found.


Bottom line

The CLI reference updates are clean and ready. The helm/k8s_reporter.mdx situation needs a decision on whether it replaces or coexists with the existing sub-pages before merge — navigation must be updated either way.

@mbevc1 mbevc1 enabled auto-merge (squash) July 3, 2026 17:49
Comment thread helm/k8s_reporter.mdx
@@ -0,0 +1,397 @@
---

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Critical: This new page is not listed in config/navigation.json, so it won't appear in the site navigation. Per CLAUDE.md: "Never create a page file without also adding it to navigation."

Additionally, the existing split pages (helm/k8s_reporter/overview, prerequisites, installing, etc.) are still present in the filesystem and navigation. This consolidated single-page file appears to duplicate their content. The intended relationship needs clarification:

  • If this replaces the sub-pages: remove the old helm/k8s_reporter/ directory files, replace the navigation entries with "helm/k8s_reporter", and add redirects.
  • If this coexists: add "helm/k8s_reporter" to navigation (e.g. as the group landing page) and differentiate the content.

Comment thread helm/k8s_reporter.mdx Outdated
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
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.

1 participant