Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ADR]: add kapa.ai for docs #143

Open
JeremyFriesenGitHub opened this issue Oct 12, 2024 · 0 comments
Open

[ADR]: add kapa.ai for docs #143

JeremyFriesenGitHub opened this issue Oct 12, 2024 · 0 comments
Assignees

Comments

@JeremyFriesenGitHub
Copy link
Contributor

Problem Statement
Our docs site is getting quite large, with room still left to grow. As developers and representatives of cuHacking, it is now starting to become a challenge now to properly explain all of the technologies that cuHacking supports to others and externals. We want to eliminate any discrepancies from this so that we can consistently explain to people what cuHacking is all about.

Goals
Goal 1: Be able to explain what cuHacking is as an organization
Goal 2: Be able to explain the technologies used at cuHacking
Goal 3: Be able to explain design choices (show why we used one technology over another)
Goal 4: Be consistent and up-to-date with explanations of what cuHacking is.

Solution Summary

History/Context
For the history about this ADR, see issue #25 .

Solution
The solution to this will be to implement kapa.ai. This would be a fantastic addition to our docs site and would solve all of our problems mentioned above. Kapa supports knowledge bases for documentation sites specifically (for instance, Docker's documentation site), which fits our exact use case. Not to mention, they also have an open-source tier specifically, which would fit our exact plans/budget needs. This would be a great opportunity to leverage this technology for our docs site, and would be similar to what we do with CodeRabit.

Other options considered
I did some research for other ai options to integrate with our docs. For instance, I looked into open-source llama models. Doing something like this would be interesting, however we would have to integrate this with another interface (for instance Open WebUI) to make this a proper chatting service, and integration might not be as seamless. Then I looked at other ai chatting services like BotPress, but then realized that they don't offer open-source plans, which would make us limited to free-tiers and community editions. Not to mention, that most of these chatting bots don't specifically serve our use case purpose for our docs. This is what has lead me to conclude that Kapa is the best/right service for us and fits our needs the best.

Next Steps
What is next to do is to reach out to Kapa to let them know we are interested in their open-sourced tier. This is up for deliberation, and if anyone proves this issue wrong or can find a better service that we can use for docs site, I would be open to discuss and present in further detail some of my findings.

@JeremyFriesenGitHub JeremyFriesenGitHub self-assigned this Oct 12, 2024
@github-project-automation github-project-automation bot moved this to ⏭ Todo in 🐞 2025 Oct 12, 2024
@JeremyFriesenGitHub JeremyFriesenGitHub changed the title [ADR]: ai kapa.ai for docs [ADR]: add kapa.ai for docs Oct 12, 2024
@HasithDeAlwis HasithDeAlwis moved this from ⏭ Todo to 💀 Backlog in 🐞 2025 Oct 13, 2024
@HasithDeAlwis HasithDeAlwis moved this from 💀 Backlog to 🏃 In Progress in 🐞 2025 Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📋 Backlog
Development

No branches or pull requests

2 participants