Clarify several best practices. #389
Conversation
WalkthroughThe documentation was updated to clarify terminology by replacing "Dashboard" with "CodeRabbit web interface," refining descriptions of repository and organizational settings, and expanding the explanation of the benefits of using a 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 (2)
docs/guides/setup-best-practices.md (2)
74-74: Nit: remove unnecessary comma
The comma before “as well” isn’t required. Consider:We recommend adding a `coderabbit.yaml` file to repositories as well.🧰 Tools
🪛 LanguageTool
[typographical] ~74-~74: A comma before “as well” is not needed unless you want to explicitly mark a pause in speech.
Context: ...acoderabbit.yamlfile to repositories, as well. Using this file has several ad...(AS_WELL_UNNECESSARY_COMMA)
81-81: Optional: refine preposition for clarity
Consider replacing “using the CodeRabbit web interface” with “via the CodeRabbit web interface” for smoother reading.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/guides/setup-best-practices.md(3 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/setup-best-practices.md
[typographical] ~74-~74: A comma before “as well” is not needed unless you want to explicitly mark a pause in speech.
Context: ...a coderabbit.yaml file to repositories, as well. Using this file has several ad...
(AS_WELL_UNNECESSARY_COMMA)
[uncategorized] ~77-~77: You might be missing the article “the” here.
Context: ...s, CodeRabbit loads the file along with rest of your repository. This means that you...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~78-~78: Consider removing “of” to be more concise
Context: ...ry's CodeRabbit settings transparent to all of the repository's contributors. Repository-...
(ALL_OF_THE)
[style] ~94-~94: Consider using a different verb to strengthen your wording.
Context: ...e when preparing a code review can help make its code reviews faster. You can define path filters using the...
(MAKE_XXX_FASTER)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: test
🔇 Additional comments (5)
docs/guides/setup-best-practices.md (5)
67-69: Clearer terminology: "CodeRabbit web interface"
Replacing "Dashboard" with "CodeRabbit web interface" sharpens the reference to the exact UI.
71-72: Concise description of Repositories page
The updated sentences clearly convey how to get started.
76-76: Approve version-control benefit expansion
Highlighting the ability to track, view history, and revert configurations is spot-on.
90-90: Approve path filter clarification
The new wording clearly communicates the behavior of the!dist/**filter.
96-96: Approve consistency in mentioning configuration file
Standardizing references to the YAML file here aligns with earlier changes.
Deploying coderabbit-docs with
|
| Latest commit: |
6d4ae5c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3c5078c3.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://best-practices.coderabbit-docs.pages.dev |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
docs/guides/setup-best-practices.md (6)
71-72: Optional: improve readability by splitting long sentence
The sentence is a bit lengthy. Consider breaking it into two shorter sentences or removing the adverb “rapidly” to increase clarity.
74-74: Remove unnecessary comma before “as well”
The comma before “as well” is not needed unless indicating a strong pause.🧰 Tools
🪛 LanguageTool
[typographical] ~74-~74: A comma before “as well” is not needed unless you want to explicitly mark a pause in speech.
Context: ...acoderabbit.yamlfile to repositories, as well. Using this file has several ad...(AS_WELL_UNNECESSARY_COMMA)
77-77: Add missing article before “rest”
Change “along with rest of your repository” to “along with the rest of your repository.”🧰 Tools
🪛 LanguageTool
[uncategorized] ~77-~77: Possible missing article found.
Context: ...s, CodeRabbit loads the file along with rest of your repository. This means that you...(AI_HYDRA_LEO_MISSING_THE)
78-78: Refine phrasing for conciseness
Consider removing “of” to avoid redundancy: “transparent to all repository contributors.”🧰 Tools
🪛 LanguageTool
[style] ~78-~78: Consider removing “of” to be more concise
Context: ...ry's CodeRabbit settings transparent to all of the repository's contributors. Repository-...(ALL_OF_THE)
81-82: Optional: clarify precedence wording
Reword to improve clarity, for example:
“Repository-level settings in acoderabbit.yamlfile override those configured in the CodeRabbit web interface at both the repository and organization levels.”
94-94: Strengthen vocabulary
Replace “help make its code reviews faster” with a more direct verb, such as “speed up its code reviews.”🧰 Tools
🪛 LanguageTool
[style] ~94-~94: Consider using a different verb to strengthen your wording.
Context: ...e when preparing a code review can help make its code reviews faster. You can define path filters using the...(MAKE_XXX_FASTER)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/guides/setup-best-practices.md(3 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/guides/setup-best-practices.md
[typographical] ~74-~74: A comma before “as well” is not needed unless you want to explicitly mark a pause in speech.
Context: ...a coderabbit.yaml file to repositories, as well. Using this file has several ad...
(AS_WELL_UNNECESSARY_COMMA)
[uncategorized] ~77-~77: Possible missing article found.
Context: ...s, CodeRabbit loads the file along with rest of your repository. This means that you...
(AI_HYDRA_LEO_MISSING_THE)
[style] ~78-~78: Consider removing “of” to be more concise
Context: ...ry's CodeRabbit settings transparent to all of the repository's contributors. Repository-...
(ALL_OF_THE)
[style] ~94-~94: Consider using a different verb to strengthen your wording.
Context: ...e when preparing a code review can help make its code reviews faster. You can define path filters using the...
(MAKE_XXX_FASTER)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (3)
docs/guides/setup-best-practices.md (3)
67-68: Clarity: explicit mention of both org and repo settings via UI
Great update—this clearly indicates that both the Organization Settings and Repositories pages in the CodeRabbit web interface support configuration at different scopes.
76-76: Skip: bullet is clear
The added bullet explaining version control advantages is clear and grammatically correct.
90-90: Skip: line break is acceptable
The line break before “to disregard…” is acceptable in markdown lists.
Staged: https://best-practices.coderabbit-docs.pages.dev/guides/setup-best-practices