Introducing Fern Guru on Gurubase.io

[kursataktas]

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

Summary by CodeRabbit

• New Features

  • Introduced a new badge linking to "Gurubase" in the README for enhanced visibility.

• Documentation

  • Maintained existing content structure while integrating the new badge seamlessly.

[coderabbitai]

Walkthrough

The changes in the pull request involve an update to the README.md file, specifically the addition of a new badge that links to the "Gurubase" website. This badge is visually styled and includes a hyperlink to the Gurubase site. The structure of the document remains largely unchanged, with existing sections that describe the toolkit's functionality, installation instructions, and various generators preserved. The overall layout and formatting of the README.md have not been modified, allowing the new badge to integrate smoothly into the existing content. The specific alteration consists of the inclusion of the badge code: [![](https://img.shields.io/badge/Gurubase-Ask%20Fern%20Guru-006BFF)](https://gurubase.io/g/fern).

---

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

README.md (1)

15-15: Approve badge addition with suggestions for improvement

The addition of the Gurubase badge is a good way to provide users with quick access to Fern-related assistance. However, there are a couple of improvements we can make:

1. Add alt text to the badge for better accessibility.
2. Consider providing a brief explanation of what Gurubase/Fern Guru is, either in the README or by updating the badge text.

Here's a suggested improvement with alt text added:

[![Ask Fern Guru on Gurubase](https://img.shields.io/badge/Gurubase-Ask%20Fern%20Guru-006BFF)](https://gurubase.io/g/fern "Get AI-powered assistance for Fern on Gurubase")

This change addresses the accessibility concern raised by the static analysis tool while also providing a hint about the purpose of the link in the title attribute.

🧰 Tools

🪛 Markdownlint

15-15: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between b0f2e8c and e8464b5.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 Markdownlint

README.md

15-15: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

[dsinghvi]

hey @kursataktas thanks for the PR. We don't have time to engage this quarter, feel free to file an issue though!