Skip to content

docs: scope the boolean flags FAQ to pre-v2.36.0 CLIs - #347

Merged
JonJagger merged 1 commit into
mainfrom
faq-boolean-flags-space-form
Jul 29, 2026
Merged

docs: scope the boolean flags FAQ to pre-v2.36.0 CLIs#347
JonJagger merged 1 commit into
mainfrom
faq-boolean-flags-space-form

Conversation

@JonJagger

Copy link
Copy Markdown
Contributor

CLI v2.36.0 accepts boolean flag values written with a space
(kosli-dev/cli#1037), so the page's central claim, that an explicitly
specified boolean value must use an "=", and its worked example were both
wrong for anyone on a current CLI.

Rewritten rather than removed, and the "Boolean flags" heading kept
verbatim. CLI versions up to v2.35.0 still hardcode a link to the
#boolean-flags anchor in the error they print, and those customers are
exactly the ones the old explanation still serves, so the anchor has to
keep resolving and the pre-v2.36.0 behaviour has to stay documented.

The example now uses --compliant false, the case where the old parse
silently inverted the caller's intent, instead of --compliant true where
the stray argument changed nothing.

  CLI v2.36.0 accepts boolean flag values written with a space
  (kosli-dev/cli#1037), so the page's central claim, that an explicitly
  specified boolean value must use an "=", and its worked example were both
  wrong for anyone on a current CLI.

  Rewritten rather than removed, and the "Boolean flags" heading kept
  verbatim. CLI versions up to v2.35.0 still hardcode a link to the
  #boolean-flags anchor in the error they print, and those customers are
  exactly the ones the old explanation still serves, so the anchor has to
  keep resolving and the pre-v2.36.0 behaviour has to stay documented.

  The example now uses --compliant false, the case where the old parse
  silently inverted the caller's intent, instead of --compliant true where
  the stray argument changed nothing.
@JonJagger
JonJagger requested a review from a team as a code owner July 29, 2026 08:54
@claude

claude Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

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


PR Review: Scope boolean flags FAQ to pre-v2.36.0 CLIs

  • Gather context — read diff and changed files
  • Review content against doc conventions
  • Post findings

Scope: faq/faq.md — the only changed file.

Findings

No critical or improvement issues found. This is a clean, well-scoped edit.

Suggestions:

  • faq/faq.md:108 — "Either upgrade the CLI, or write the flag as --compliant=false." — The actionable guidance is good. You could consider linking "upgrade the CLI" to the install/upgrade page for discoverability, but it's minor since this section targets users who likely already know how to upgrade.

Checks

Check Status
Heading ## Boolean flags preserved (anchor stability) Pass
#boolean-flags anchor references still resolve (faq/faq.md:70, getting_started/artifacts.md:67) Pass
No relative links Pass
Frontmatter unchanged Pass
Writing style (active voice, American spelling, "Kosli" not "the Kosli platform") Pass
No navigation changes needed (no new pages) Pass

Summary

Good change. The rewrite correctly frames the space-separator limitation as version-specific (pre-v2.36.0) rather than absolute, while preserving the #boolean-flags anchor that older CLI versions link to in their error output. Switching the example to --compliant false is a clear improvement — it demonstrates the case where the old parse silently inverted intent, which is the actual footgun. The explanation is more concise (net −3 lines) and the step-by-step breakdown is easier to follow with one fewer intermediate state.

@mintlify

mintlify Bot commented Jul 29, 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 29, 2026, 8:55 AM

@JonJagger
JonJagger merged commit dd2b6ea into main Jul 29, 2026
6 checks passed
@JonJagger
JonJagger deleted the faq-boolean-flags-space-form branch July 29, 2026 09:03
@mintlify

mintlify Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
kosli 🟡 Building Jul 29, 2026, 8:54 AM

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