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

Introducing Valibot Guru on Gurubase.io #921

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

kursataktas
Copy link

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
Copy link
Owner

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?

@fabian-hiller fabian-hiller self-assigned this Nov 12, 2024
@fabian-hiller fabian-hiller added the documentation Improvements or additions to documentation label Nov 12, 2024
@kursataktas
Copy link
Author

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
Copy link
Owner

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
Copy link
Author

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
Copy link
Owner

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
Copy link
Author

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
Copy link
Owner

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.

@kursataktas
Copy link
Author

Hey @fabian-hiller

Here is the repository for the widget script. Feel free to fork it, modify it, and raise a PR if needed. Would this address your concerns?

@kursataktas
Copy link
Author

Additionally, I’d like to update you on the release of the Maintainer Panel feature on Gurubase. With this panel, you can add, remove, or update data sources, as well as change the logo and more. You can find the details here.

In the near future, I’m planning to include analytics insights in this panel, such as the number of questions asked, the most frequently asked ones, and more. I’ll be sure to update this thread once it’s available. However, in case I miss it, I highly recommend joining our Discord channel to stay updated.

If you’d prefer that I don’t update this thread anymore, please let me know.

@vladshcherbin
Copy link
Contributor

Hopefully this will never get merged. Only god knows which data will it eventually collect and a good half of devs can just ask ChatGPT or other AI-bloated tech 🙌

@fabian-hiller
Copy link
Owner

fabian-hiller commented Dec 5, 2024

Thank you for the update Kursat. Do you also plan to provide the service as an API in the long run?

I understand your concerns Vlad, but please try to write a little friendlier next time. I know where you are coming from, but people can take it the wrong way.

In general, AI help similar to our search would be amazing, but at this point I am not quite sure how to proceed. I am busy with other things at the moment and will come back to this PR at a later time.

@kursataktas
Copy link
Author

Thank you for the update Kursat. Do you also plan to provide the service as an API in the long run?

You're welcome. There's no written plan for this at the moment, but it does sound like a feature we would like to implement in the future. I'll be sure to update this thread once it's available. However, in case I miss it, I highly recommend joining our Discord channel to stay updated.

@fabian-hiller
Copy link
Owner

Thanks for the update. In general, this could be a great opportunity for an open source project so that other projects like Valibot could self-host such a service and integrate it natively into our docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants