docs: clarify PR review eligibility (#378)

[hardikkgupta]

Adds "Review eligibility" section to clarify which PRs CodeRabbit reviews.

Tackles #378

[coderabbitai]

Walkthrough

The documentation was updated to add a "Review eligibility" section, explaining when CodeRabbit will review pull requests for public and private repositories. The section also includes an embedded ProPlanNotice component to display information about the Pro plan requirements for private repositories.

Changes

File(s)	Change Summary
docs/guides/code-review-overview.md	Added a "Review eligibility" section detailing review conditions for public/private repositories; embedded ProPlanNotice component.

Poem

In the docs a section grew,
Explaining what our bot will do—
Public repos? Reviews for all!
Private ones? Pro plan’s the call.
A notice hops in, clear and bright,
So every dev can see the light.
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 94f88f3 and 057d05d.

📒 Files selected for processing (1)

• docs/guides/code-review-overview.md (2 hunks)

🔇 Additional comments (4)

docs/guides/code-review-overview.md (4)

7-7: Add ProPlanNotice import
Importing the ProPlanNotice component at the top is appropriate for later usage in this MDX file. The path aligns with project conventions and matches other component imports.

---

19-19: Introduce “Review eligibility” section
The new section header and anchor ({#eligibility}) clearly mark the eligibility criteria for code reviews. This aligns with the existing structure and will appear correctly in the generated TOC.

---

21-24: Clarify public vs. private repository policies
The bullet points succinctly describe the default behavior for public repos and the Pro-plan requirement for private repos. The bold styling highlights key differences effectively.

---

26-26: Embed ProPlanNotice component
Including <ProPlanNotice /> here ensures users see additional details about plan requirements in context. This enhances discoverability of Pro-plan information.

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Commit Unit Tests in branch docs/clarify-review-eligibility
• Post Copyable Unit Tests in Comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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