Removed a typo, and rewrote a paragraph for clarity. #424
+3
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThe documentation for initial configuration was updated to clarify how users can adjust path-specific CodeRabbit behavior. The revised section now explicitly explains that users may provide custom instructions for certain files or directories or configure CodeRabbit to ignore specific paths during code reviews. Changes
Poem
✨ 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 (
|
![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
🧹 Nitpick comments (1)
docs/guides/initial-configuration.md (1)
80-82: Prefer “ignore” over “disregard” for consistency with the surrounding docs
Elsewhere in the guide (see lines 88–90) we use “disregard” only when describing the outcome of a filter; in headings and intro sentences we say “ignore”. Swapping “disregard” for “ignore” here keeps terminology consistent and reads a bit more naturally.-You can give CodeRabbit additional instructions for reviewing specific files or -locations in your repository, or configure CodeRabbit to disregard certain file paths -during code reviews. +You can give CodeRabbit additional instructions for reviewing specific files or +locations in your repository, or configure CodeRabbit to ignore certain file paths +during code reviews.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/guides/initial-configuration.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
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: aravindputrevu
PR: coderabbitai/coderabbit-docs#121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the `/img/` directory, not `/static/img/`.
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#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: NatoBoram
PR: coderabbitai/coderabbit-docs#125
File: CONTRIBUTING.md:60-65
Timestamp: 2024-10-31T17:01:26.168Z
Learning: In the `CONTRIBUTING.md` file, the user prefers to keep the "Keeping your Fork Up-to-Date" section concise without additional comments on Git commands.
Learnt from: tyaga001
PR: coderabbitai/coderabbit-docs#155
File: docs/getting-started/quickstart.md:22-22
Timestamp: 2024-11-28T16:45:08.224Z
Learning: In the `coderabbitai/coderabbit-docs` repository, when reviewing markdown files, image paths that start with `/img/` are correct and should not include the `static` prefix, even though the images are located in the `static/` directory.
Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#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/guides/initial-configuration.md (4)
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: aravindputrevu
PR: coderabbitai/coderabbit-docs#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.
Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the `/img/` directory, not `/static/img/`.
Learnt from: NatoBoram
PR: coderabbitai/coderabbit-docs#125
File: CONTRIBUTING.md:60-65
Timestamp: 2024-10-31T17:01:26.168Z
Learning: In the `CONTRIBUTING.md` file, the user prefers to keep the "Keeping your Fork Up-to-Date" section concise without additional comments on Git commands.
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Cloudflare Pages
Deploying coderabbit-docs with
|
| Latest commit: |
eaae20c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d19ae79f.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://423-typo-and-and-on-the-new.coderabbit-docs.pages.dev |
howonlee
approved these changes
Jul 1, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #423
Staged: https://docs.coderabbit.ai/guides/initial-configuration/?#path