Clarify several best practices.

[jmacdotorg]

Staged: https://best-practices.coderabbit-docs.pages.dev/guides/setup-best-practices

[coderabbitai]

Walkthrough

The documentation was updated to clarify terminology by replacing "Dashboard" with "CodeRabbit web interface," refining descriptions of repository settings, and expanding the explanation of the benefits of using a coderabbit.yaml file. Additional clarifications and minor typographical corrections were made to improve consistency and accuracy.

Changes

File(s)	Change Summary
docs/guides/setup-best-practices.md	Updated terminology, clarified repository settings descriptions, expanded benefits of configuration files, standardized references, and fixed minor typos.

Poem

In the warren of docs, we tidy and mend,
"Dashboard" hops out, "web interface" we send.
With coderabbit.yaml, our history’s in view,
Settings clear as morning dew.
Typo bunnies chased away,
Now our guidance leads the way! 🐇✨

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Commit Unit Tests in branch best-practices
• Post Copyable Unit Tests in Comment

---

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need 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)

• @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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this 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.

[coderabbitai]

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: ...a coderabbit.yaml file 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

📥 Commits

Reviewing files that changed from the base of the PR and between e4ebaaa and ea9a458.

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

[SahanaVP]

Should we also mention that they can config Org-level? Is the best practice to set the config at repo-level over org-level? It might also be helpful to mention that to make changes to the repo-settings, they would have to first disable using org settings (there's that toggle in the top) which many users miss and still get confused by.