Skip to content

docs: update CLI and helm reference for v2.52.0 - #480

Merged
mbevc1 merged 1 commit into
mainfrom
reference-docs/v2.52.0
Oct 30, 2026
Merged

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

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

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

@mintlify

mintlify Bot commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
kosli 🟢 Ready View Preview Oct 30, 2026, 1:22 PM

@claude

claude Bot commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

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


Doc review — v2.52.0 CLI reference

The 4 new command pages (kosli evaluate policy, kosli publish rego-policy, kosli get rego-policy, kosli list rego-policies) all have config/navigation.json entries in the generated CLI subtree. The kosli get snapshot, log environment, list environments, list snapshots, list flows, get environment and diff snapshots changes are just regenerated sample data: timestamps, snapshot indices and durations.

policy-reference/rego_policy.mdx (hand-authored)

Improvement: --server-side makes the "local only" description out of date

  • Location: policy-reference/rego_policy.mdx:31, :405, :407-411
  • Issue: v2.52.0 adds --server-side to kosli evaluate trail and kosli evaluate trails ("Evaluate the policy on the Kosli server rather than on this machine"). This page still says these commands "evaluate a policy in the CLI instead." The whole "Local evaluation" section, including the comparison list and the "Local input data" table, assumes they only ever run locally. A reader who finds --server-side on the reference page can't tell which contract and input shape apply: input.trail or a trail moment, and whether the server's built-in restrictions are enforced.
  • Recommendation: Add a sentence to the "Local evaluation" section explaining what --server-side changes: which input it receives, whether server compile rules apply, and that it can't be combined with --attestations, --show-input or --output-rule. Also say how it differs from kosli evaluate policy --path. Doing this in a follow-up PR is fine; it doesn't block this merge.

Suggestion: link the new reference pages

  • Location: policy-reference/rego_policy.mdx:7, :142, :327; tutorials/working_with_controls.mdx:7
  • Issue: These pages name kosli publish rego-policy and kosli evaluate policy as plain code. Until now those commands had no reference pages; this PR adds them, but nothing on the site links to them.
  • Recommendation: Link the first mention on each page to /client_reference/kosli_publish_rego-policy and /client_reference/kosli_evaluate_policy, the same way :405 already links kosli evaluate trail.

Upstream — does not block this merge

Placeholders inside backtick spans render as broken nested code

  • Location: client_reference/kosli_evaluate_policy.md:21, :27, :84 (also the --context and --identifier rows of the flags table)
  • Issue: Placeholders such as <flow> and <n> get turned into backticks, even when they're already inside a ^…^ code span. The result is --context trail=`flow`/`trail` , Append `@v`n andDefaults to control-decision``. Each code span closes early, leaving stray backticks and the placeholders in plain text. This is the same kind of generator escaping bug as a surviving ^, not a typo in the description.
  • Fix in: kosli-dev/cli. Either change the placeholder handling in the kosli docs markdown renderer so placeholders inside a code span aren't re-wrapped, or reword the long description and flag help in cmd/kosli/evaluatePolicy.go to avoid placeholders inside ^…^.

1 Improvement, 1 Suggestion, 1 Upstream. No Critical findings: safe to merge, and the two rego_policy.mdx items can go in a follow-up PR.

@mbevc1
mbevc1 merged commit 13b8c37 into main Oct 30, 2026
6 checks passed
@mbevc1
mbevc1 deleted the reference-docs/v2.52.0 branch October 30, 2026 14:11

This branch was successfully deployed

1 active deployment
staging — 81c10b93 Deployed Oct 30, 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