-
Notifications
You must be signed in to change notification settings - Fork 15
Kapa.ai
Kapa.ai powers the AI-assisted chatbot available through the Zephyr documentation as well as an MCP server.
This page documents how it is administered, what data it ingests, and how to flag issues or coverage gaps.
Kapa.ai administration is shared across multiple maintainers so that no single person is a blocker for account or configuration changes.
| Role | Persons |
|---|---|
| Owner | Documentation Infrastructure Maintainers |
| Owner | Infrastructure (CI) Maintainers / LF Reps |
The following sources are used to build Kapa's knowledge base.
| Name | Details | Source type | Update frequency |
|---|---|---|---|
| Code | https://github.com/zephyrproject-rtos/zephyr (all folders excepts boards/ and doc/) | Code (C, Markdown, Python, text) | hourly |
| API Reference | https://docs.zephyrproject.org/latest/doxygen/ | HTML | daily |
| Bindings | https://docs.zephyrproject.org/latest/build/dts/api/ | HTML | daily |
| Docs | https://docs.zephyrproject.org/latest/ (minus "API Reference" and "Bindings") | HTML | daily |
| Wiki | https://github.com/zephyrproject-rtos/zephyr/wiki | HTML | daily |
| GH Issues | https://github.com/zephyrproject-rtos/zephyr, issues opened/closed in the last 6 months | GitHub | every 5 min |
| GH Pull Requests | https://github.com/zephyrproject-rtos/zephyr, PRs opened/closed in the last 6 months (excluding closed without merge) | GitHub | every 10 min |
If existing sources need tweaking or new sources should be considered, please open a new issue/enhancement against "Documentation Infrastructure" in the zephyr project.
Kapa.ai provides reports highlighting classes of questions that could not be answered well, sources that may be missing, or areas where the knowledge base appears incomplete.
These gaps are monitored by the documentation manager and handled like other documentation gaps. Depending on the issue, follow-up may include:
- Opening or updating documentation issues.
- Improving existing documentation.
- Adding missing documentation.
- Adjusting knowledge sources when the issue is related to source coverage.