Skip to content

docs: update CLI and helm reference for v2.39.2 - #378

Merged
mbevc1 merged 1 commit into
mainfrom
reference-docs/v2.39.2
Sep 1, 2026
Merged

mbevc1 merged 1 commit into
mainfrom
reference-docs/v2.39.2

Conversation

@github-actions

@github-actions github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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

@github-actions
github-actions Bot requested a review from a team as a code owner September 1, 2026 11:01
@mintlify

mintlify Bot commented Sep 1, 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 Sep 1, 2026, 11:03 AM

@claude

claude Bot commented Sep 1, 2026 •

Copy link
Copy Markdown
Contributor

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


Doc review — CLI reference update for v2.39.2

  • Gather context (CLAUDE.md, changed files)
  • Review the diff
  • Check links, navigation, and structure
  • Post findings

Verdict: looks good to merge. This is a generated client_reference/ update — no hand-editing, no new pages, so no config/navigation.json change is needed. One advisory note below.

Critical

None.

Improvement

client_reference/kosli_diff_snapshots.md:68-78 — the regenerated example now has snappish1.artifacts, snappish2.artifacts and changed.artifacts all empty; every artifact landed in not-changed. The reference page for a diff command no longer shows what a difference looks like. That's a consequence of capturing against a live cyber-dojo environment where beta and prod happened to be in sync — not something to fix in this PR, but worth handling in the generator (pin a snapshot pair known to differ, or fall back to a fixture when the live diff is empty). Left as an inline comment.

Suggestion

None.

What I checked

Check Result
Prose/content changes Only kosli_attest_sonar.md: overriden → overridden (×3) and sonar scanner → Sonar scanner. Both correct — overriden no longer appears anywhere in the repo.
Version banner client_reference/overview.md correctly bumped v2.39.1 → v2.39.2.
Relative links None introduced — all added links are absolute external URLs (github.com, gitlab.com, app.kosli.com).
Internal links / navigation No internal links added or removed; no new or deleted pages, so config/navigation.json is unaffected.
Structure Code fences balanced (even count) in all 94 client_reference/*.md files; no fence, heading, or front matter lines touched by the diff.
Large diffs kosli_get_snapshot.md (−566 net), kosli_log_environment.md, kosli_list_* — pure JSON sample-data churn (timestamps, fingerprints, commit SHAs). Zero prose lines changed in either large file, so the shrink is just fewer artifacts in the captured snapshot, not truncation.
Style guide No violations — American spelling maintained, "Kosli" used correctly, sentence-case headings unchanged.

Two things I could not run in this environment: mint broken-links (CLI not installed) and a JSON parse of every example block (python3/heredoc calls were declined by the sandbox). The link check is low-risk here since no internal links changed; fence balance is the main structural signal and it passes. If you want those enforced, mint and python3 -c would need to be added to --allowedTools.
· branch reference-docs/v2.39.2

Comment on lines 67 to +78
{
"snappish1": {
"snapshot_id": "aws-beta#8227",
"snapshot_id": "aws-beta#8249",
"artifacts": []
},
"snappish2": {
"snapshot_id": "aws-prod#5309",
"artifacts": []
},
"changed": {
"artifacts": []
},

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.

Improvement — The regenerated live example is now a degenerate diff: snappish1.artifacts, snappish2.artifacts, and changed.artifacts are all [], because aws-beta and aws-prod happened to be fully in sync when the docs were generated. Every artifact landed in not-changed.

The whole point of this page is to show what a snapshot diff looks like, so a reader can no longer see the shape of a changed entry (which is the interesting part). Previously the example showed 8 artifacts in snappish1 and 9 in snappish2.

Not a blocker for merging the release update, but worth making the generator resilient — e.g. compare against an older snapshot (aws-prod~5) for this page, or keep the previous output when the fetched diff comes back empty.

Fix this →

@mbevc1
mbevc1 merged commit 55f14be into main Sep 1, 2026
6 of 7 checks passed
@mbevc1
mbevc1 deleted the reference-docs/v2.39.2 branch September 1, 2026 11:22
Comment on lines 68 to +78
"snappish1": {
"snapshot_id": "aws-beta#8227",
"snapshot_id": "aws-beta#8249",
"artifacts": []
},
"snappish2": {
"snapshot_id": "aws-prod#5309",
"artifacts": []
},
"changed": {
"artifacts": []
},

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.

Improvement — The regenerated example for kosli diff snapshots now has snappish1.artifacts, snappish2.artifacts and changed.artifacts all empty, so the sample output for a diff command no longer demonstrates a single difference. Everything landed in not-changed.

This is an artifact of generating against a live cyber-dojo environment where aws-beta and aws-prod happened to be in sync at capture time — not a bug in this PR. But it does make the page a weaker reference: a reader can't see what a changed/added/removed artifact entry actually looks like.

Worth considering for the generator (scripts/): capture this example from a snapshot pair that is known to differ, or fall back to a checked-in fixture when the live diff comes back empty.

This branch was successfully deployed

1 active deployment
staging — c90f63a5 Deployed Sep 1, 2026 by mintlify[bot]
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