Skip to content

Add Kai - AI Assistant section to navigation and main AI page#855

Open
jordanrburger wants to merge 9 commits intomainfrom
kai-documentation
Open

Add Kai - AI Assistant section to navigation and main AI page#855
jordanrburger wants to merge 9 commits intomainfrom
kai-documentation

Conversation

@jordanrburger
Copy link
Contributor

@jordanrburger jordanrburger commented Dec 16, 2025

Add Comprehensive Kai AI Assistant Documentation

Overview:
Added complete documentation structure for Kai, Keboola's embedded AI assistant, splitting content into focused, user-friendly sections.

Documentation Pages:

  • /kai/ - Main overview and introduction
    • /kai/getting-started/ - Access requirements and first steps
    • /kai/use-cases/ - Detailed examples and practical applications
    • /kai/best-practices/ - Effective prompting and workflow guidance
    • /kai/technical/ - Architecture, security, and deployment details
      Key Features:
  • User-focused structure: Organized by user journey from introduction to advanced usage
    • Practical examples: Real prompts and workflows for common data engineering tasks
    • Clear differentiation: Explains relationship between Kai and MCP Server
    • Security emphasis: Covers governance, audit trails, and data protection
    • Navigation integration: Added hierarchical menu structure under AI Features
    • Visual assets: Added welcome and capabilities images for documentation
      Updates:
  • Moved documentation to /kai/ directory structure
    • Added rate limits and hotkey documentation
    • Added contextual awareness and enablement instructions
    • Integrated Kai section into home page AI features

@jordanrburger jordanrburger self-assigned this Dec 16, 2025
@davidesner
Copy link
Contributor

davidesner commented Jan 28, 2026

@jordanrburger I went through the docs locally:

I think we for sure need to add reference to the privacy policy or include a dedicated page like this https://github.com/keboola/connection-docs/pull/856/changes#diff-b504d79105e6b09adfd1804afe56a570a7f3e3cf82e8e3a14bf895a8ff6dd3af. This is imo very important to say loudly-> no training, data residency, compliance.

It would be nice to add the generic video with use cases to the main Kai page

Then this (prompt:) ):

  • Mention the available hotkeys -> A to open the (recent) chat window , SHIFT + A to open new chat
  • Update rate limiting: Every user will have 150 turns (user messages) per month per project for free. It resets every calendar month. If they need more they can reach out to support and we will need to deal with them individually (we have the technical option to set the limit per project). PAYG has lower limit of 15 messages per user per month
    • Users will see the rate limit usage in the chat UI
  • Elaborate more on contextual awareness and follow mode. That the agent has also a context of what the users sees in the UI and user can also follow along as the agent works with configurations. Refer to the implementation to understand more (ui repo path)
  • Expand tips with Don't type secrets in chat. KAI uses secure forms for credentials
  • Describe how to enable it. It is no longer private beta but public beta:
    • Every user will be able to see the Kai button in every project (if the stack has the appropriate feature, effectively excluding STs). It is also possible to enable it through settings -> features
    • Only Organization Admins will be able to enable the feature straight from the chat screen. Others will have to reach out to their org admins or our support if unsure.
  • remove .playwright folder

The Kai Use Cases & Examples would deserve the video (generated). I am not so sure the prompt examples are too useful. I will for sure not copy paste these prompts and it's quite hard to read. At least I would think about the page structure so it looks nicer.

@jordanrburger
Copy link
Contributor Author

jordanrburger commented Jan 28, 2026

@davidesner - Sadly, I think one issue with the videos in the docs is that I don't think we can auto-play them and I'm not sure how easily they can even be embedded.

I agree with all the rest, though. Updating it now.

@jordanrburger jordanrburger marked this pull request as ready for review January 28, 2026 16:31
jordanrburger and others added 5 commits January 28, 2026 17:31
…sponse types, clarify action approval requirements, and enhance descriptions of capabilities and integration setup.
…ure, security, deployment, and integration details. Update use case example to reflect changes in error message handling for job failures.
… best practices for new users, and streamline troubleshooting guidance. Revise navigation structure to reflect changes in content organization.
…ontextual awareness, and enablement instructions

- Update from Private Beta to Public Beta with enablement details
- Add keyboard shortcuts (A for recent chat, Shift+A for new chat)
- Update rate limits: 150 turns/month (free), 15/month (PAYG)
- Add Contextual Awareness & Follow Mode section with implementation details
- Add security tip about using secure forms for credentials
- Remove .playwright-mcp folder and add to .gitignore

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@davidesner
Copy link
Contributor

davidesner commented Jan 29, 2026

@davidesner - Sadly, I think one issue with the videos in the docs is that I don't think we can auto-play them and I'm not sure how easily they can even be embedded.

I agree with all the rest, though. Updating it now.

I usually convert them to gif, that works. Here's an example https://help.keboola.com/ai/mcp-server/

@jordanrburger
Copy link
Contributor Author

I usually convert them to gif, that works. Here's an example https://help.keboola.com/ai/mcp-server/

Yeah, then we just have a ~15 second limit. I'll try to recreate the capabilities video to be a little shorter.

jordanrburger and others added 2 commits January 29, 2026 12:35
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@jordanrburger
Copy link
Contributor Author

Okay, the .gif has been added. Now, I'm debating whether or not we should include an FAQ page in addition to what we already have.

jordanrburger and others added 2 commits February 4, 2026 16:47
- Relocate Kai docs from ai/kai-assistant/ to kai/
- Update navigation and index references
- Clarify rate limits: contracted plans get 150 messages, PAYG gets 50
- Add note that Kai is free during public beta

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@cjayyy
Copy link
Contributor

cjayyy commented Feb 5, 2026

This is deliberate.

@AdamVyborny AdamVyborny self-requested a review February 5, 2026 12:30
@AdamVyborny
Copy link
Contributor

Oh, good point. URL should be: https://help.keboola.com/ai/kai-assistant

Copy link
Contributor

@AdamVyborny AdamVyborny left a comment

Choose a reason for hiding this comment

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

@jordanrburger
Copy link
Contributor Author

Oh, good point. URL should be: https://help.keboola.com/ai/kai-assistant

No, Michal pushed back on this.

@AdamVyborny
Copy link
Contributor

Oh nevermind, we changed it yesterday 🤦🏻
CleanShot 2026-02-05 at 13 34 21@2x

@cjayyy
Copy link
Contributor

cjayyy commented Feb 5, 2026

Oh, good point. URL should be: https://help.keboola.com/ai/kai-assistant

No, Michal pushed back on this.

wtf. So we'll have AI section but our main AI feature will not be listed there? 😕

@AdamVyborny
Copy link
Contributor

Oh, good point. URL should be: help.keboola.com/ai/kai-assistant

No, Michal pushed back on this.

wtf. So we'll have AI section but our main AI feature will not be listed there? 😕

Yep, that's shame

@jordanrburger
Copy link
Contributor Author

Oh, good point. URL should be: https://help.keboola.com/ai/kai-assistant

No, Michal pushed back on this.

wtf. So we'll have AI section but our main AI feature will not be listed there? 😕

Correct. It's a platform feature, not an AI specific feature.

@AdamVyborny
Copy link
Contributor

But there still could be link. People could click on AI section as naturaly they are expecting Kai docs there.

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.

4 participants