Merge branch 'main' into feature/issue/160

jmacdotorg · web-flow · commit d1050e680251 · 2025-06-02T10:32:11.000-04:00
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -5,6 +5,14 @@ description: The latest updates and changes to CodeRabbit.
 sidebar_position: 13
 ---
 
+### May 30, 2025
+
+#### New Static Analysis Tool
+
+We're excited to announce that [Pylint](https://github.com/PyCQA/pylint) is now supported on CodeRabbit!
+
+- **Pylint**: A widely used static analysis and code quality tool for Python. It checks for errors, enforces a coding standard, and looks for code smells in your Python codebase by analyzing Python files.
+
 ## May 25, 2025
 
 ### New Security and Code Quality Tools
diff --git a/docs/faq.md b/docs/faq.md
@@ -10,6 +10,42 @@ import TabItem from '@theme/TabItem';
 
 ## General Questions {#general-questions}
 
+### How to trigger a CodeRabbit Review?
+
+Once installed, CodeRabbit automatically triggers a review when a pull request is opened against the main branch of any repository. We automatically detect the name of the primary branch (whether this be master, main, dev, etc). This branch restriction can be customized in your settings.
+
+You can also manually trigger a review at any time by commenting on a pull request with one of these commands (see [Commands](/guides/commands.md) for full list):
+
+- `@coderabbitai review` - Triggers a standard review
+- `@coderabbitai full review` - Triggers a comprehensive review
+
+### How to run a review from my IDE?
+
+You can trigger CodeRabbit reviews directly from your IDE using our editor plugins:
+
+- [VSCode Extension](./guides/about-vscode.md) - For VSCode, Cursor or Windsurf users
+
+These plugins allow you to request reviews without leaving your development environment. See the individual plugin documentation for installation and usage instructions.
+
+### How to install CodeRabbit?
+
+View step by step instructions depending on your platform:
+
+<Tabs>
+  <TabItem value="github" label="GitHub" default>
+    See our [GitHub App installation guide](./platforms/github-com.md) for step-by-step instructions.
+  </TabItem>
+  <TabItem value="gitlab" label="GitLab">
+    Follow our [GitLab integration guide](/platforms/gitlab-com.mdx) to get started.
+  </TabItem>
+  <TabItem value="bitbucket" label="Bitbucket">
+    Check out the [Bitbucket installation steps](/platforms/bitbucket-cloud.md) for detailed setup.
+  </TabItem>
+  <TabItem value="azure" label="Azure DevOps">
+    View our [Azure DevOps setup guide](/platforms/azure-devops.md) for complete installation instructions.
+  </TabItem>
+</Tabs>
+
 ### How accurate is CodeRabbit?
 
 > CodeRabbit demonstrates high accuracy in code reviews based on early adoption results. While 100% accuracy isn't guaranteed due to AI's evolving nature, our technology continuously improves through:
@@ -27,6 +63,51 @@ CodeRabbit works with all programming languages, with varying proficiency based
 - Available training data
 - Community usage patterns
 
+### Whats the difference between CodeRabbit Code Reviews and CodeRabbit Reports?
+
+CodeRabbit offers two distinct features that serve different roles in your development workflow:
+
+#### CodeRabbit Code Reviews
+
+**Role**: Developer, QA, and Code Reviewer
+**Access Level**: Full code access with comprehensive analysis capabilities
+
+**Key Features:**
+
+- **Complete Toolchain**: Runs all available analysis tools on your codebase
+- **Static Analysis**: Can execute shell commands and perform deep static analysis against your codebase
+- **Direct Code Access**: Has full access to code in issues and pull requests
+- **Interactive Chat**: Provides chat features for real-time collaboration and questions
+- **Comprehensive Review**: Analyzes code quality, security, performance, and best practices
+- **Actionable Feedback**: Provides specific, line-by-line suggestions and improvements
+- **Comment Interaction**: Engages with users through comments in pull requests and issues for clarifications and discussions
+- **Available in All Tiers**: All features are available across Free, Lite, and Pro plans
+
+#### CodeRabbit Reports
+
+**Role**: Project Manager and Communication Hub
+**Access Level**: Summary-only access without direct code interaction
+
+**Key Features:**
+
+- **Summary Generation**: Creates convenient, formatted summaries of all your recent pull requests
+- **Customizable Prompts**: Allows you to select or create your own summarization templates
+- **High-Level Overview**: Focuses on project progress and changes without code details
+- **Comment Analysis**: Reads and summarizes existing comments and discussions
+- **No Code Access**: Operates only on summaries and metadata, not the actual codebase
+- **Communication Tool**: Designed for stakeholders who need updates without technical details
+- **Multi-Channel Delivery**: Sends reports through various communication channels:
+  - Email notifications
+  - Slack integration
+  - Discord webhooks
+  - Microsoft Teams updates
+- **Pro Plan Exclusive**: Reports feature is available only in the Pro plan tier
+
+**In Summary:**
+
+- **Code Reviews** = Technical analysis with full code access for developers
+- **Reports** = High-level summaries with no code access for project management
+
 ### Data Security
 
 <Tabs>
@@ -92,7 +173,7 @@ Email field and click Update to save your changes.
 ### Usage and Configuration
 
 - **Language Settings**: Configure review language in repository settings
-- **Review Rules**: Customize via [review instructions](/guides/review-instructions)
+- **Review Rules**: Customize via [review instructions](/guides/review-instructions.md)
 - **Branch Selection**: Default branch reviews enabled by default (configurable)
 
 ### Access & Permissions
@@ -108,7 +189,7 @@ Interact with CodeRabbit by:
 1. Replying directly to CodeRabbit comments
 2. Tagging `@coderabbitai` in PR discussions
 3. Adding review comments for specific lines
-4. Customize via [review instructions](/guides/review-instructions)
+4. Customize via [review instructions](/guides/review-instructions.md)
 
 :::tip Collaboration Mode
 When team members are active in PRs, use `@coderabbitai` to engage the bot.
@@ -146,7 +227,7 @@ The following limits enforced _per developer_:
 3. That's it. CodeRabbit will automatically start reviewing your PRs
 
 :::tip Need Help?
-Visit our [Support](/getting-started/support) page for additional assistance or reach out to our team on [Discord](http://discord.gg/coderabbit).
+Visit our [Support](/getting-started/support.md) page for additional assistance or reach out to our team on [Discord](http://discord.gg/coderabbit).
 :::
 
 #### Unable to View Repositories in GitLab
diff --git a/docs/guides/custom-reports.md b/docs/guides/custom-reports.md
@@ -11,6 +11,8 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
 
 CodeRabbit Pro allows you to create custom reports tailored to your specific needs using a flexible prompt-based system. This guide will help you understand how to create effective custom reports.
 
+For a conceptual overview of reports in CodeRabbit, see [Generate reports](/guides/reports-overview).
+
 ## Understanding Custom Reports
 
 Custom reports allow you to:
@@ -558,6 +560,6 @@ These are the available emojis and the type of change they represent. Do not usi
 
 ## Related Resources
 
-- [Scheduled Reports](./scheduled-reports.md)
-- [On-demand Reports](./ondemand-reports.md)
+- [Schedule reports](/guides/scheduled-reports)
+- [Generate reports on demand](/guides/ondemand-reports)
 - [API Documentation](https://api.coderabbit.ai/api/swagger/)
diff --git a/docs/guides/ondemand-reports.md b/docs/guides/ondemand-reports.md
@@ -1,5 +1,5 @@
 ---
-title: Generate reports
+title: Generate reports on demand
 description: CodeRabbit offers a way to generate on-demand reports using a simple API request
 ---
 
@@ -12,13 +12,9 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
 
 ## Overview
 
-CodeRabbit's reporting feature helps you track and analyze pull request activity across your repositories. There are two ways to generate reports:
+This page is about using the CodeRabbit API to generate on-demand reports about your organization's usage of CodeRabbit. For a conceptual overview of reports in CodeRabbit, see [Generate reports](/guides/reports-overview).
 
-1. **[Scheduled Reports](./scheduled-reports.md)** - Set up automated recurring reports that are delivered on a schedule to your preferred channels (email, Slack, MS Teams). This is the recommended way to keep your team informed about development progress.
-
-2. **On-demand Reports** (this guide) - Generate reports programmatically through our API when you need them. This is useful for integration with your own tools and workflows.
-
-If you're new to CodeRabbit's reporting features, we recommend starting with [Scheduled Reports](./scheduled-reports.md) to understand the available options and capabilities.
+If you're new to CodeRabbit's reporting features, then we recommend starting with [Scheduled reports](/guides/scheduled-reports) to understand the available options and capabilities.
 
 ## API Access
 
@@ -73,3 +69,8 @@ The on-demand report generation endpoints take in inputs as per the schema shown
 ```
 
 [API Reference](https://api.coderabbit.ai/api/swagger/)
+
+## What's next
+
+- [Customize reports](/guides/custom-reports)
+- [Scheduled reports](/guides/scheduled-reports)
diff --git a/docs/guides/reports-overview.md b/docs/guides/reports-overview.md
@@ -0,0 +1,38 @@
+---
+title: Generate reports
+description: Learn about CodeRabbit's reporting capabilities, including scheduled and on-demand reports, and how to customize them
+sidebar_label: Overview
+---
+
+```mdx-code-block
+import ReportSchema from "@site/src/components/ReportSchema";
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+<ProPlanNotice />
+```
+
+You can track and analyze pull request activity across your organization's repositories by using the CodeRabbit reporting feature.
+
+## Scheduled and on-demand reports {#types}
+
+There are two ways to generate reports:
+
+- **[Scheduled Reports](/guides/scheduled-reports)**: Set up automated, recurring reports that are delivered to your team on a set schedule. Supported delivery channels include the following:
+
+  - Email
+  - Discord
+  - Slack
+  - Teams
+
+- **[On-demand Reports](/guides/ondemand-reports)**: If you require customized integration of reports with your own tools and workflows, then you can generate reports programmatically through our API.
+
+For your first reports, we recommend exploring scheduled reports. Its web-based UI can help you get familiar with the options available to you.
+
+## Customize reports using natural language {#customize}
+
+For both scheduled and on-demand reports, you define the shape and content of your reports by providing a prompt that instructs CodeRabbit about report that you want, using natural language. The scheduled reports interface includes several example prompts that you can choose from, or you can write your own prompt. For more information, see [Customize reports](/guides/custom-reports).
+
+## What's next {#whats-next}
+
+- [Schedule reports](/guides/scheduled-reports)
+- [Generate reports on demand](/guides/ondemand-reports)
diff --git a/docs/guides/scheduled-reports.md b/docs/guides/scheduled-reports.md
@@ -11,6 +11,8 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
 
 CodeRabbit Pro offers automated recurring reports that provide insights into your GitHub organization's activities. These reports can be customized and delivered through various channels to help teams stay informed about development progress.
 
+For a conceptual overview of reports in CodeRabbit, see [Generate reports](/guides/reports-overview).
+
 ## Setting Up a Recurring Report
 
 1. Navigate to **Recurring Reports** in the [CodeRabbit dashboard](https://app.coderabbit.ai/reports/recurring)
@@ -248,3 +250,8 @@ Deleting a report will immediately stop all scheduled runs and remove access to
 - [Custom Reports](./custom-reports.md)
 - [On-demand Reports](./ondemand-reports.md)
 - [API Documentation](https://api.coderabbit.ai/api/swagger/)
+
+## What's next
+
+- [Customize reports](/guides/custom-reports)
+- [Generate reports on demand](/guides/ondemand-reports)
diff --git a/docs/platforms/github-enterprise-server.md b/docs/platforms/github-enterprise-server.md
@@ -170,7 +170,7 @@ Use this CodeRabbit IP if your instance requires IP whitelisting
 `35.222.179.152/32` and `34.170.211.100/32`.
 
 VPN tunneling is available as an add-on package. Please reach out to us at
-[contact@coderabbit.ai](mailto:contact@coderabbit.ai) if you are interested.
+[support@coderabbit.ai](mailto:support@coderabbit.ai) if you are interested.
 
 ### **FAQ**
 
diff --git a/docs/platforms/self-hosted-gitlab.md b/docs/platforms/self-hosted-gitlab.md
@@ -122,4 +122,4 @@ Use this CodeRabbit IP if your instance requires IP whitelisting
 `35.222.179.152/32` and `34.170.211.100/32`.
 
 VPN tunneling is available as an add-on package. Please reach out to us at
-[contact@coderabbit.ai](mailto:contact@coderabbit.ai) if you are interested.
+[support@coderabbit.ai](mailto:support@coderabbit.ai) if you are interested.
diff --git a/docs/tools/list.md b/docs/tools/list.md
@@ -33,7 +33,7 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
 | Plaintext                   | [LanguageTool][LanguageTool]                               | Grammar and Spell Checking                          |
 | Java                        | [PMD][PMD]                                                 | Code Quality                                        |
 | Protobuf                    | [Buf][Buf]                                                 | Code Quality                                        |
-| Python                      | [Ruff][Ruff]                                               | Code Quality                                        |
+| Python                      | [Ruff][Ruff], [Pylint][Pylint]                             | Code Quality                                        |
 | Regal                       | [Regal][Regal]                                             | Code Quality                                        |
 | Ruby                        | [RuboCop][RuboCop], [Brakeman][Brakeman]                   | Code Quality, Code Security                         |
 | Rust                        | [Clippy][Clippy]                                           | Code Quality                                        |
@@ -77,3 +77,4 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
 [Luacheck]: /tools/luacheck.md
 [Brakeman]: /tools/brakeman.md
 [Clippy]: /tools/clippy.md
+[Pylint]: /tools/pylint.md
diff --git a/docs/tools/pylint.md b/docs/tools/pylint.md
@@ -0,0 +1,37 @@
+---
+title: Pylint
+sidebar_label: Pylint
+description: CodeRabbit's guide to Pylint.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+<ProPlanNotice />
+```
+
+[Pylint](https://pylint.pycqa.org/) is a static code analysis tool for Python. It checks your Python code for errors, enforces a coding standard, and looks for code smells.
+
+## Supported Files
+
+Pylint will run on files with the following extensions:
+
+- `*.py`
+
+## Features
+
+Pylint can detect many issues such as:
+
+- Coding standard violations (PEP8)
+- Unused variables and imports
+- Undefined variables
+- Code smells and refactoring suggestions
+- Error-prone constructs
+- And many more
+
+## Links
+
+- [Pylint Official Website](https://pylint.pycqa.org/)
+- [Pylint GitHub Repository](https://github.com/pylint-dev/pylint)
+- [Pylint Documentation](https://pylint.pycqa.org/en/latest/)
+- [Message Control](https://pylint.pycqa.org/en/latest/user_guide/message-control.html)
diff --git a/sidebars.ts b/sidebars.ts
@@ -129,9 +129,10 @@ const sidebars: SidebarsConfig = {
 			collapsed: true,
 			label: "Generate reports",
 			items: [
+				"guides/reports-overview",
+				"guides/scheduled-reports",
 				"guides/ondemand-reports",
 				"guides/custom-reports",
-				"guides/scheduled-reports",
 			],
 		},
 		{
diff --git a/static/schema/schema.v2.json b/static/schema/schema.v2.json
@@ -831,6 +831,19 @@
 									"default": {},
 									"description": "Configuration for Prisma Schema linting to ensure schema file quality"
 								},
+								"pylint": {
+									"type": "object",
+									"properties": {
+										"enabled": {
+											"type": "boolean",
+											"default": true,
+											"description": "Enable Pylint | Pylint is a Python static code analysis tool. | v3.3.7"
+										}
+									},
+									"additionalProperties": false,
+									"default": {},
+									"description": "Pylint is a Python static code analysis tool."
+								},
 								"oxc": {
 									"type": "object",
 									"properties": {
