Skip to content

docs(kai): document chat controls and refresh Getting Started - #1104

Closed
KaroEverling wants to merge 1 commit into
keboola:mainfrom
KaroEverling:docs/kai-chat-controls
Closed

KaroEverling wants to merge 1 commit into
keboola:mainfrom
KaroEverling:docs/kai-chat-controls

Conversation

@KaroEverling

Copy link
Copy Markdown
Contributor

Jira issue(s): n/a — Linear PRDCT-654

Every button in the Kai chat panel is now explained in one place, in tables with icons. Deeper configuration stays in Kai Settings.

Changes:

  • New "Chat Controls" section with two tables: the panel header (new chat, report a bug, settings, expand, close) and the message box row (upload files, plan mode, follow mode)
  • Plan mode is documented. PRDCT-654 exists because it is "advertised in the product and documented nowhere" — this closes it. Placed beside Action Approval as that ticket suggested
  • Opening Kai screenshot replaced with a current capture; the unreferenced kai-welcome.png is deleted
  • Action Approval gains a screenshot of the approval dialog and now names all three buttons — Decline was missing entirely — and states what triggers approval instead of "when Kai wants to modify your project"
  • Follow Mode subsection folded into the table so no control is explained twice; Contextual Awareness now links to it
  • Example Prompts links on to Effective Prompting in Best Practices

All screenshots are real product captures. Icons are all 72x72.


@jordanrburger — draft. Three things I could not verify, all in the panel header table:

  1. Report a bug — described as collecting debug details (chat ID, trace link, project, stack), which is what every Kai SUPPORT ticket in Linear contains. Whether the button also files the ticket, or just hands the user the block to paste, I could not confirm.
  2. Close — "your conversation is kept" is an assumption.
  3. The chevron next to the chat name. I had written that it opens a list of recent conversations, then removed it when Karo said history lives in the expanded view. If it does something, it is the one header control still undocumented.

Two open bugs describe behaviour this page now documents as working:

  • AI-3783 (Triage) — Kai runs despite "confirmation required" and continues even when Decline is pressed. This page says "Decline — do not run it."
  • AI-3665 (In Progress) — plan-mode gating is not enforced.

Documenting intended behaviour still seems right, but worth knowing the docs and those tickets disagree.

Rate Limits is deliberately untouched. It documents the beta caps, which are correct until 15 September. The replacement belongs with #1102 (Kai Pricing and Limits), which should merge after this one and update that section to point at /kai/pricing/.

Every button in the Kai chat panel is now explained in one place. The
panel header row (new chat, report a bug, settings, expand, close) and
the message box row (upload files, plan mode, follow mode) each get a
table with icons.

Plan mode was advertised in the product and documented nowhere
(PRDCT-654). It is now covered in the chat controls table.

Also replaces the Opening Kai screenshot, adds a screenshot of the
action approval dialog and names all three of its buttons, and folds
the Follow Mode subsection into the table so no control is explained
twice.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Aug 28, 2026

Copy link
Copy Markdown

@KaroEverling is attempting to deploy a commit to the Keboola Engineering Team on Vercel.

A member of the Team first needs to authorize it.

@KaroEverling
KaroEverling marked this pull request as ready for review August 28, 2026 15:46
@jordanrburger
jordanrburger removed their request for review August 28, 2026 15:46
@jordanrburger

Copy link
Copy Markdown
Contributor

Removing myself from Review. Please request from someone else.

@keboola-pr-reviewer-bot keboola-pr-reviewer-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verdict: needs_human (risk 3/5) · profile connection-docs

Needs human: the page documents Kai behavior that two open bugs say doesn't work yet.

Concerns:

  • src/content/docs/kai/getting-started.md: Documents Decline and plan-mode gating as working; open bugs AI-3783/AI-3665 say they aren't.
  • src/content/docs/kai/getting-started.md: Author flags three panel-header claims (Report a bug, Close, settings scope) as unverified.
  • public/kai/kai-action-approval.png: Screenshots are real captures but not machine-verifiable by the reviewer.

Suggested reviewers: @keboola/docs

@davidesner

Copy link
Copy Markdown
Contributor

Superseded by #1106 — same commit moved to a branch in keboola/connection-docs so CI and the Vercel preview run with repo credentials. Review notes carried over verbatim. Closing this fork PR.

@davidesner davidesner closed this Aug 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants