fabian-hiller / valibot

The modular and type safe schema library for validating structural data 🤖
https://valibot.dev
MIT License
6.32k stars 204 forks source link

Introducing Valibot Guru on Gurubase.io #921

Open kursataktas opened 1 week ago

kursataktas commented 1 week ago

Hello team,

I'm the maintainer of Anteon. We have created Gurubase.io with the mission of building a centralized, open-source tool-focused knowledge base. Essentially, each "guru" is equipped with custom knowledge to answer user questions based on collected data related to that tool.

I wanted to update you that I've manually added the Valibot Guru to Gurubase. Valibot Guru uses the data from this repo and data from the docs to answer questions by leveraging the LLM.

In this PR, I showcased the "Valibot Guru", which highlights that Valibot now has an AI assistant available to help users with their questions. Please let me know your thoughts on this contribution.

Additionally, if you want me to disable Valibot Guru in Gurubase, just let me know that's totally fine.

fabian-hiller commented 1 week ago

This is great! I would love to have a feature like this in our docs one day. The Gurubase results are quite accurate. Great job! Is it expensive to host such a service?

kursataktas commented 1 week ago

Glad to hear you liked it 🎊 It's not too expensive, actually.

What do you think about adding a widget to the docs, similar to the one we use on the Anteon Docs. Screenshot 2024-11-07 at 23 09 04

If the docs are also open source, I can open a PR for this.

fabian-hiller commented 1 week ago

Yes, the docs are in /website of this repository. It would be nice if we could integrate this feature natively into our website in the long run, similar to the Algolia search implementation.

kursataktas commented 1 week ago

I updated this PR to include the Guru widget. Here’s how it looks:

image

It would be nice if we could integrate this feature natively into our website in the long run, similar to the Algolia search implementation.

I have this feature idea as well, but it’s still in the idea stage. I’ll update this thread if we move forward with it.

fabian-hiller commented 1 week ago

I am quite busy at the moment. I will probably change the design of the button to match the brand design before merging. Is that OK with you?

kursataktas commented 1 week ago

I am quite busy at the moment. I will probably change the design of the button to match the brand design before merging. Is that OK with you?

Of course, feel free to play with it. However, changing the design would be challenging since the widget is generated by the script I imported. The script only accepts a color parameter as a design choice. I used the secondary color from the Valibot website, but if you prefer a different color, I can update the PR accordingly.

fabian-hiller commented 1 week ago

I am not sure I want to allow such a script from a security perspective. Especially since the functionality is just a simple link to another website that we could add ourselves. Also, it will most likely break the UX of our site on mobile.