add note on config priority #443
Conversation
WalkthroughA new section titled "Configuration priority" was added to the documentation, detailing the strict hierarchy CodeRabbit follows when determining which configuration settings apply. The section explains the precedence of configuration sources and clarifies that settings are not merged or inherited between sources. Changes
Poem
Impact AnalysisClarification of configuration priority in documentationℹ️ Low 🔄 Impacts behavior The documentation now clearly explains how CodeRabbit determines which configuration settings take precedence, outlining the strict priority order and emphasizing that settings are not merged or inherited. This helps users understand how their configuration choices are applied and prevents confusion about which settings are in effect. Review the new documentation section for clarity and accuracy. Ensure that the described configuration priority matches actual system behavior, and verify that users can easily understand which settings will apply in different scenarios. ✨ 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: |
af66113
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://27176221.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://fix-config-priority.coderabbit-docs.pages.dev |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/guides/configuration-overview.md (3)
55-55: Prefer “in the head branch” for natural phrasingThe current wording is a bit clunky. Switching the preposition improves readability.
-1. **Local `.coderabbit.yaml` file of head branch** +1. **Local `.coderabbit.yaml` file in the head branch**
55-57: Align bullet phrasing for better parallelismBullets 2 & 3 start with a noun phrase, whereas bullet 1 starts with “Local …”. Making all bullets parallel improves flow.
-1. **Local `.coderabbit.yaml` file in the head branch** +1. **Repository-local `.coderabbit.yaml` file (head branch)**
61-64: Clarify what “repository settings are disabled” meansReaders may not know how repository-level settings become “disabled.”
Explicitly state that repository settings are considered inactive when the web-UI toggle is off or no.coderabbit.yamlexists in the repo.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/guides/configuration-overview.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
docs/guides/configuration-overview.md (1)
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.
⏰ 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). (1)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
docs/guides/configuration-overview.md (1)
67-69: Double-check config key spelling and default valueThe example references
reviews.tools.github-checks.timeout_mswith a default of90000 ms. Please verify that:
- The key matches the current schema (hyphen vs underscore).
90000is indeed the documented default.Inaccurate details here will confuse users.
No description provided.