Introducing Riverpod Guru on Gurubase.io

[kursataktas]

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

Summary by CodeRabbit

• New Features
  • Introduced a new badge for Gurubase in the README, allowing users to easily access resources and ask questions.
• Documentation
  • Enhanced visual representation of project resources without altering existing content.

[coderabbitai]

Walkthrough

The changes introduced in this pull request consist of an additive modification to the README.md file, specifically the inclusion of a new badge for Gurubase. This badge features an anchor tag linking to Gurubase and an image indicating that users can "Ask Riverpod Guru." The modification does not affect any existing functionality or content structure within the document, and all other content remains unchanged.

Changes

File	Change Summary
README.md	Added a new badge for Gurubase with a link and image.

Poem

In the README, a badge shines bright,
For Gurubase, a guiding light.
"Ask Riverpod Guru," it cheerfully says,
Helping users find their ways.
With a hop and a skip, we celebrate,
New visuals that make our project great! 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 288c9b5 and 63c870b.

📒 Files selected for processing (1)

• README.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• README.md

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[kursataktas]

Hi everyone,

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 about how to claim a Guru 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.

[noriHanda]

@kursataktas It's a wonderful tool. I wish I had this when I started using Riverpod. This should help many people not too familiar with Riverpod.

With that being said, I found some rooms for improvement.

• It recommends StateNotifier which is deprecated
• It recommeds StateProvider which is also not recommended to use any longer
• It recommends MVVM and BLoC as best architecture patterns with Riverpod.

[kursataktas]

Hey @noriHanda

Thank you for the review, I'll investigate these and update this thread.