Adding onprem KB settings to docs

[NickBusey]

No description provided.

[coderabbitai]

Walkthrough

The pull request updates the docs/self-hosted/github.md document to introduce new configuration options for self-hosting CodeRabbit with GitHub. It adds two environment variables: ON_PREM_KNOWLEDGE_BASE, a boolean for enabling knowledge base features, and ON_PREM_KNOWLEDGE_BASE_BRANCH, which specifies the branch for storing knowledge base JSON files. The overall structure of the document remains unchanged, retaining existing instructions and notes.

Changes

File	Change Summary
docs/self-hosted/github.md	Added two new environment variables: ON_PREM_KNOWLEDGE_BASE (boolean) and ON_PREM_KNOWLEDGE_BASE_BRANCH (branch path).

Possibly related PRs

• docs: add guide for CodeRabbit GitHub integration #133: The changes in this PR involve adding a guide for integrating CodeRabbit with GitHub, which is directly related to the enhancements made in the main PR regarding configuration options for self-hosting CodeRabbit with GitHub.
• docs: Improve docs SEO  #142: This PR focuses on improving documentation clarity and SEO, which may indirectly relate to the overall documentation improvements in the main PR, particularly in enhancing user guidance for configuration options.

Suggested reviewers

• aravindputrevu
• dk03051996

🐰 In the garden of code, we sprout,
New options for hosting, without a doubt.
Knowledge bases bloom, branches align,
With GitHub and CodeRabbit, our setup will shine!
Let's hop to new heights, with features so bright! 🌼

---

🪧 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.

[cloudflare-workers-and-pages]

Deploying coderabbit-docs with    Cloudflare Pages

Latest commit:	2d00281
Status:	✅  Deploy successful!
Preview URL:	https://6b76d09d.coderabbit-docs.pages.dev
Branch Preview URL:	https://nick-learnings-onprem.coderabbit-docs.pages.dev

View logs

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

docs/self-hosted/github.md (1)

111-114: Consider adding prerequisites for knowledge base features.

While the variables are well-documented, it might be helpful to add a note about any prerequisites or additional setup required for the knowledge base features to work correctly (e.g., repository permissions, storage requirements, etc.).

Consider adding a note similar to:

 # Set to true to use the knowledge base features.
 ON_PREM_KNOWLEDGE_BASE=[true]
 # The branch which CodeRabbit will store the knowledge base json files in.
 ON_PREM_KNOWLEDGE_BASE_BRANCH=[coderabbitai/data]
+
+:::note
+When enabling the knowledge base features:
+1. Ensure the GitHub App has write permissions for the repository contents
+2. The specified branch will be created if it doesn't exist
+:::

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5224d4a and 2d00281.

📒 Files selected for processing (1)

• docs/self-hosted/github.md (1 hunks)