Skip to content

docs: advise against parsing raw CLI output#290

Merged
mbevc1 merged 3 commits into
mainfrom
mintlify/d62e638b
Jun 24, 2026
Merged

docs: advise against parsing raw CLI output#290
mbevc1 merged 3 commits into
mainfrom
mintlify/d62e638b

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Adds a "Don't parse the raw CLI output" section to the Querying Kosli tutorial, advising readers to use exit codes or --output json rather than grepping human-readable output (e.g. COMPLIANT/NON-COMPLIANT/INCOMPLIANT). This avoids scripts silently breaking when wording is tweaked between CLI versions (context: internal discussion around kosli-dev/cli#970).


Generated by Mintlify Agent.

Requested by: [email protected] via Slack
Mintlify session: slack_1782312639.838479_C0AJTQ5633K

@mintlify mintlify Bot requested a review from a team as a code owner June 24, 2026 14:52
@claude

claude Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Claude finished @mbevc1's task in 47s —— View job


PR Review: docs: advise against parsing raw CLI output

  • Gather context and read changed files
  • Review against CLAUDE.md conventions
  • Post review findings

Findings

File: tutorials/querying_kosli.md (+11 lines, new section)

No issues found. This is a clean, well-placed addition:

  • Navigation: Page already exists in config/navigation.json — no update needed (existing page, not a new one).
  • Links: All internal links are root-relative (/getting_started/install, /client_reference/kosli_search, etc.) — correct per CLAUDE.md.
  • Front matter: Present and well-formed.
  • Writing style: Active voice, imperative mood, American spelling — all consistent with conventions.
  • Structure: The new section fits naturally before the "What you've accomplished" wrap-up. The two bullet points (exit codes, structured output) give readers clear, actionable alternatives.
  • Diataxis fit: Practical advice inside a tutorial — appropriate scope.

Note on latest commit (5dbca54): mbevc1's suggestion was applied, removing the INCOMPLIANT parenthetical. The closing sentence is now cleaner and avoids potential reader confusion about whether INCOMPLIANT was a typo.

Overall: solid, focused addition. No critical or improvement-level findings.

Comment thread tutorials/querying_kosli.md Outdated
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Comment thread tutorials/querying_kosli.md Outdated
@mbevc1 mbevc1 merged commit 1518268 into main Jun 24, 2026
6 checks passed
@mbevc1 mbevc1 deleted the mintlify/d62e638b branch June 24, 2026 15:11
@mintlify

mintlify Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
kosli 🔴 Failed Jun 24, 2026, 3:23 PM

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