Skip to content

Latest commit

 

History

History
300 lines (240 loc) · 9.93 KB

README.md

File metadata and controls

300 lines (240 loc) · 9.93 KB
Gurubase Image

Discord Twitter Mastodon Bluesky

Gurubase

What is Gurubase

Gurubase lets you create AI-powered Q&A assistants for any topic or need. Create a new Guru by uploading webpages, PDFs, videos, or GitHub repositories. Start asking questions directly on Gurubase.io, or embed it on your website to let your users ask questions about your product. It’s already being used by hundreds of open-source repositories.

How to Create a Guru

Currently, only the Gurubase team can create a Guru. Please open an issue on this repository with the title "Guru Creation Request" and include the GitHub repository link in the issue content. We prioritize Guru creation requests from the maintainers of the tools. Please mention whether you are the maintainer of the tool. If you are not the maintainer, it would be helpful to obtain the maintainer's permission before opening a creation request for the tool.

How to Claim a Guru

Although you can't create a Guru, you can manage it on Gurubase. For example, you can add, remove, or reindex the datasources. To claim a Guru, you must have a Gurubase account and be one of the tool's maintainers. Please open an issue with the title "Guru Claim Request". Include the link to the Guru (e.g., https://gurubase.io/g/anteon), your Gurubase username, and a link proving you are one of the maintainers of the tool, such as a PR merged by you.

Showcase Your Guru

1. Widget

Add an "Ask AI" widget to your website by importing a small JS script. For an example, check the Anteon docs.

Gurubase Widget Demo

2. Badge

Like hundreds of GitHub repositories, add a badge to your README to guide your users to learn about your tool on Gurubase.

Example Badge:

[![Gurubase](https://img.shields.io/badge/Gurubase-Ask%20OpenCost%20Guru-006BFF)](https://gurubase.io/g/opencost)

Gurubase Image

How to Update Datasources

Datasources can include your tool's documentation webpages, YouTube videos, or PDF files. You can add new ones, remove existing ones, or reindex them. Reindexing ensures your Guru is updated based on changes to the indexed datasources. For example, if you update your tool's documentation, you can reindex those pages so your Guru generates answers based on the latest data.

Once you claim your Guru, you will see your Gurus in the "My Gurus" section.

Gurubase Image

Click the Guru you want to update. On the edit page, click "Reindex" for the datasource you want to reindex.

Gurubase Image

You can also see the "Last Index Date" on the URL pages.

Gurubase Image

License

All the content generated by Gurubase aligns with the license of the datasources used to generate answers. More details can be found on the Terms of Usage page, Section 2.

Help

We prefer Discord for written communication. Join our channel! To stay updated on new features, you can follow us on X, Mastodon, and Bluesky.

Used By

Gurubase currently hosts hundreds of Gurus, and it grows every day. Here are some repositories that showcase their Gurus in their READMEs or documentation.


Sunshine
21.7K ★

Teable
15K ★

Albumentations
14.5K ★

Open IM
14.3K ★

Sandboxie
14.2K ★

Quarkus
14K ★

Navidrome
12.9K ★

Vanna
12.6K ★

Tamagui
11.9K ★

Carla
11.9K ★

Duplicati
11.5K ★

Mongoose
11.3K ★

Assimp
11.2K ★

WatermelonDB
10.7K ★

Gorse
8.7K ★

SQLFluff
8.4K ★

Databend
8.1K ★

Nhost
8K ★

ast-grep(sg)
7.9K ★

DoWhy
7.2K ★
100+ more