Add knowledge base feature flag defns in self hosted docs #469
Conversation
WalkthroughThe documentation for self-hosted integrations with Azure DevOps, Bitbucket, GitHub, and GitLab was updated to restructure the environment variable configuration for knowledge base features. A single flag was replaced with a global feature flag and multiple granular flags, providing detailed control over knowledge base indexing options. No code or public API changes occurred. Changes
Estimated code review effort1 (~5 minutes) Poem
Pre-Merge Checks (1 passed, 2 warnings)❌ Failed Checks (2 warnings)
✅ Passed Checks (1 passed)
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying coderabbit-docs with
|
| Latest commit: |
19232c8
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://ce1c0dee.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://kb-selfhosted.coderabbit-docs.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
docs/self-hosted/github.md (1)
164-168: Outdated reference to removed flagThe note still says:
- When ENABLE_LEARNINGS is set to true, …
ENABLE_LEARNINGSno longer exists. Replace with the new pair:- When ENABLE_KNOWLEDGE_BASE=true and ENABLE_LEARNING_INDEX=true, …This avoids confusing readers who will look for the old flag.
🧹 Nitpick comments (4)
docs/self-hosted/bitbucket.md (1)
19-20: Minor grammar nit ‑ remove extraneous “s”“… profile picture to ensures easy recognition.”
Change to “… profile picture to ensure easy recognition.”
docs/self-hosted/github.md (1)
45-46: Grammar nit – “to ensure”Same wording issue as in other guides:
“… logo … as the profile picture to ensures easy recognition.”
Use “to ensure”.
docs/self-hosted/azure-devops.md (1)
19-20: Grammar nit – “to ensure”“… profile picture to ensures easy recognition.”
Replace “ensures” with “ensure”.
docs/self-hosted/gitlab.md (1)
19-20: Grammar nit – “to ensure”“… profile picture to ensures easy recognition.”
Use “to ensure”.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
docs/self-hosted/azure-devops.md(1 hunks)docs/self-hosted/bitbucket.md(1 hunks)docs/self-hosted/github.md(1 hunks)docs/self-hosted/gitlab.md(1 hunks)
🧠 Learnings (4)
docs/self-hosted/azure-devops.md (1)
Learnt from: aravindputrevu
PR: #402
File: docs/guides/setup-best-practices.md:21-21
Timestamp: 2025-06-18T09:22:07.198Z
Learning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.
docs/self-hosted/bitbucket.md (1)
Learnt from: aravindputrevu
PR: #402
File: docs/guides/setup-best-practices.md:21-21
Timestamp: 2025-06-18T09:22:07.198Z
Learning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.
docs/self-hosted/gitlab.md (1)
Learnt from: aravindputrevu
PR: #402
File: docs/guides/setup-best-practices.md:21-21
Timestamp: 2025-06-18T09:22:07.198Z
Learning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.
docs/self-hosted/github.md (3)
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
Learnt from: alexcoderabbitai
PR: #176
File: docs/self-hosted/bitbucket.md:37-37
Timestamp: 2024-12-13T15:10:43.483Z
Learning: In the docs repository, it's acceptable to use 127.0.0.1 in documentation examples, and CodeRabbit should not flag it as an issue.
Learnt from: aravindputrevu
PR: #402
File: docs/guides/setup-best-practices.md:21-21
Timestamp: 2025-06-18T09:22:07.198Z
Learning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.
🧰 Additional context used
🧠 Learnings (4)
docs/self-hosted/azure-devops.md (1)
Learnt from: aravindputrevu
PR: #402
File: docs/guides/setup-best-practices.md:21-21
Timestamp: 2025-06-18T09:22:07.198Z
Learning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.
docs/self-hosted/bitbucket.md (1)
Learnt from: aravindputrevu
PR: #402
File: docs/guides/setup-best-practices.md:21-21
Timestamp: 2025-06-18T09:22:07.198Z
Learning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.
docs/self-hosted/gitlab.md (1)
Learnt from: aravindputrevu
PR: #402
File: docs/guides/setup-best-practices.md:21-21
Timestamp: 2025-06-18T09:22:07.198Z
Learning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.
docs/self-hosted/github.md (3)
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
Learnt from: alexcoderabbitai
PR: #176
File: docs/self-hosted/bitbucket.md:37-37
Timestamp: 2024-12-13T15:10:43.483Z
Learning: In the docs repository, it's acceptable to use 127.0.0.1 in documentation examples, and CodeRabbit should not flag it as an issue.
Learnt from: aravindputrevu
PR: #402
File: docs/guides/setup-best-practices.md:21-21
Timestamp: 2025-06-18T09:22:07.198Z
Learning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: test
- GitHub Check: Cloudflare Pages
🔇 Additional comments (3)
docs/self-hosted/bitbucket.md (1)
118-130: Flag name & pluralization inconsistency
ENABLE_LEARNING_INDEXis singular, whereas the previous flag (ENABLE_LEARNINGS) and the product wording (“Learnings”) are plural. Double-check the actual variable expected by the agent; if the backend still looks forENABLE_LEARNINGS_INDEX(plural) this doc will drift out of sync and mislead deployers.
If the new singular form is intentional, ensure all four self-hosted guides and the codebase use the exact same spelling.docs/self-hosted/azure-devops.md (1)
148-150: Contradictory guidance on optional valuesThe line states:
- Values marked with [] are not optional to provide.Square brackets are used throughout the docs to denote optional fields (e.g.
[<openai-base-url>]). Saying they are “not optional” contradicts that convention and will confuse operators. Clarify whether the bracketed variables are optional or mandatory and update wording accordingly.docs/self-hosted/gitlab.md (1)
190-192: Contradictory guidance on optional valuesSame issue as Azure DevOps guide – brackets indicate optional fields, but the note claims they are “not optional”. Re-align the note with the established bracket convention.
No description provided.