Add AI Chat settings and integration for CodeRabbit in Docusaurus config

[aravindputrevu]

No description provided.

[coderabbitai]

Walkthrough

The update introduces a new plugin configuration for the Docusaurus configuration file. A plugin for @inkeep/cxkit-docusaurus is added to enable a customized search bar. The configuration sets up basic settings such as the API key and primary brand color, as well as AI chat settings including a chat subject, assistant avatar, and predefined help options and example questions.

Changes

File(s)	Change Summary
docusaurus.config.ts	Added new @inkeep/cxkit-docusaurus plugin with a SearchBar configuration. This includes baseSettings (with API key from env and a set brand color) and aiChatSettings (with chat subject, avatar URL, help options, and example questions).

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant SB as Search Bar Plugin
    participant API as Backend/API
    U->>SB: Enter search query or chat question
    SB->>API: Send query and settings (API key, chat settings)
    API-->>SB: Return search results/AI chat response
    SB-->>U: Display results/response

Loading

Poem

In digital fields I hop with glee,
A search bar blooms in our code spree.
With AI chatter soft and bright,
I nibble on each new insight.
CodeRabbit cheers, "Let's leap and play!"
Together, we bound into a brighter day!

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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

🧹 Nitpick comments (3)

docusaurus.config.ts (3)

134-135: Consider adding a fallback for the API key

The current implementation may cause issues if the environment variable is not set.

- apiKey: process.env.INKEEP_API_KEY,
+ apiKey: process.env.INKEEP_API_KEY || '',

Also consider adding some error handling or a warning message if the key is not available.

---

139-139: Consider using a higher resolution image for the AI assistant avatar

The favicon.ico file is typically small and may not look optimal when displayed as an avatar in the chat interface.

You might want to use a dedicated, higher-resolution image designed specifically for the avatar purpose.

---

165-165: Fix grammar in example question

There's a small grammar issue in the third example question.

- "How to set up a AI Code Review?",
+ "How to set up an AI Code Review?",

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 595fb4b and a471693.

⛔ Files ignored due to path filters (3)

• .github/workflows/node.js.yaml is excluded by !**/*.yaml
• package.json is excluded by !**/*.json
• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml, !**/*.yaml

📒 Files selected for processing (1)

• docusaurus.config.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: test
• GitHub Check: Cloudflare Pages

🔇 Additional comments (1)

docusaurus.config.ts (1)

129-170: Good implementation of the Inkeep AI chat integration

The configuration is well-structured and follows good security practices by using environment variables for the API key.

[cloudflare-workers-and-pages]

Deploying coderabbit-docs with    Cloudflare Pages

Latest commit:	cec32f6
Status:	✅  Deploy successful!
Preview URL:	https://b098f64a.coderabbit-docs.pages.dev
Branch Preview URL:	https://inkeep-cr-chat.coderabbit-docs.pages.dev

View logs