Skip to content

docs: update CLI and helm reference for v2.28.1#283

Merged
mbevc1 merged 1 commit into
mainfrom
reference-docs/v2.28.1
Jun 22, 2026
Merged

docs: update CLI and helm reference for v2.28.1#283
mbevc1 merged 1 commit into
mainfrom
reference-docs/v2.28.1

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

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

@github-actions github-actions Bot requested a review from a team as a code owner June 22, 2026 10:51
@mintlify

mintlify Bot commented Jun 22, 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 Jun 22, 2026, 10:53 AM

@claude

claude Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Claude finished @github-actions[bot]'s task in 1m 53s —— View job


Review of PR #283 — CLI & Helm reference update for v2.28.1

  • Gather context and read CLAUDE.md
  • Check new pages are in navigation.json
  • Review changed files for content issues
  • Check for relative links
  • Post review findings

Automated reference docs update for v2.28.1. 85 files changed across client_reference/ and config/navigation.json. Beyond the routine live-data refresh, this PR introduces meaningful structural improvements.

What changed

  1. New command: kosli attest decision (hidden: true, beta) — records compliance decisions against trail controls.
  2. Navigation restructuring: The "Deprecated" nav group is removed. Deprecated commands move into their logical command groups (kosli assert, kosli get, kosli list, kosli snapshot), and new kosli report / kosli request groups are created. This is a good improvement — users find commands where they expect them.
  3. Frontmatter modernization: beta: false/deprecated: false fields removed; deprecated: truetag: "DEPRECATED"; beta: truetag: "BETA". Inline deprecation/beta warnings replaced with shared snippets (<CliDeprecatedNotice />, <CliBetaNotice />). Both snippets exist and render correctly.
  4. Live data refresh: JSON example outputs updated with current snapshot data across kosli get snapshot, kosli diff snapshots, kosli list environments, kosli log environment, kosli list snapshots, etc.
  5. Version bump: overview.mdv2.28.1.

Findings

Suggestionclient_reference/kosli_attest_decision.md is a new page that is not in config/navigation.json. Since it's marked hidden: true, this is likely intentional (hidden beta command). Mintlify does support hidden pages in the nav config (they won't render in the sidebar), so adding it would keep routing explicit without affecting visibility. Low priority — no action needed if the generator intentionally omits hidden pages.

No issues found:

  • No relative links — all internal links use root-relative paths (/integrations/ci_cd, /faq/#boolean-flags, /getting_started/install/, etc.).
  • All previously-existing pages retain their navigation entries after the restructuring.
  • The snippet imports use absolute paths (/snippets/cli-beta-notice.mdx), consistent with repo conventions.
  • Frontmatter is well-formed across all changed files.

Looks good overall. The deprecation/beta snippet consolidation and navigation restructuring are clean improvements.

@mbevc1 mbevc1 merged commit b7f290e into main Jun 22, 2026
6 checks passed
@mbevc1 mbevc1 deleted the reference-docs/v2.28.1 branch June 22, 2026 11:04
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