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 Shuttle Guru on Gurubase.io #1915

Open
wants to merge 2 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 Shuttle Guru to Gurubase. Shuttle 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 "Shuttle Guru", which highlights that Shuttle 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 Shuttle Guru in Gurubase, just let me know that's totally fine.

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary

This PR adds a Shuttle Guru badge to the README.md, introducing an AI assistant powered by Gurubase.io to help users with Shuttle-related questions.

  • Added new badge in README.md linking to gurubase.io/g/shuttle with consistent styling
  • Integrates documentation from both shuttle-hq/shuttle repo and docs.shuttle.rs as knowledge base
  • Provides users with an AI-powered assistant for answering Shuttle-related questions

1 file(s) reviewed, 2 comment(s)
Edit PR Review Bot Settings | Greptile

Comment on lines +22 to +24
<a href="https://gurubase.io/g/shuttle">
<img alt="Gurubase" src="https://img.shields.io/badge/Gurubase-Ask%20Shuttle%20Guru-006BFF"/>
</a>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: Consider using orange color (like other tool badges) instead of 006BFF to maintain visual consistency with existing badges

@@ -19,6 +19,9 @@
<a href="https://circleci.com/gh/shuttle-hq/shuttle/">
<img alt="build status" src="https://circleci.com/gh/shuttle-hq/shuttle.svg?style=shield"/>
</a>
<a href="https://gurubase.io/g/shuttle">
<img alt="Gurubase" src="https://img.shields.io/badge/Gurubase-Ask%20Shuttle%20Guru-006BFF"/>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: Alt text 'Gurubase' could be more descriptive like 'Ask Shuttle Guru' to match badge text

@jonaro00
Copy link
Member

jonaro00 commented Nov 6, 2024

Interesting tool!
We are migrating to our updated platform on shuttle.dev, so https://docs.shuttle.dev/ will have the most relevant information from now on. I can suggest adding it as a source.

@kursataktas
Copy link
Author

I've changed the data source from https://docs.shuttle.rs/ to https://docs.shuttle.dev/.

@kursataktas
Copy link
Author

Hi @jonaro00,

Have you had a chance to check this out?

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.

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary

(updates since last review)

No major changes found since last review. The previous review already covered the key aspects of adding the Shuttle Guru badge to the README.md file, and there have been no significant changes since then.

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

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

Successfully merging this pull request may close these issues.

2 participants