+ to guide the content of the summary. Use the format shown in <\_example> but do not include or refer to the example's content in the final summary/report.
+
+
+
+**Instructions:**
+Generate a weekly code review report for the author of this pull request only following scoring parameters. Calculate the scores and compile the results into a table so that the team-wise average score can be easily determined.
+**Scoring Parameters:**
+
+1. **Basic Code Standards (Score out of 2)**
+
+ - Avoidance of hard-coded values
+ - No repetition of code (DRY principle)
+
+2. **Code Readability (Score out of 2)**
+
+ - Presence of meaningful comments
+ - Proper variable declaration using `const` and `let`
+
+3. **Error Handling (Score out of 4)**
+
+ - Handling failure scenarios (e.g., try-catch, fallbacks)
+ - Proper loading state implementation (e.g., button click loading states)
+ - Handling edge cases (e.g., checking for undefined or missing values)
+ - Input validation (ensuring correct user inputs)
+
+4. **Circle CI Check Validation (Score: 0 or 1)**
+ - `0` โ Not Passed
+ - `1` โ Passed
+
+**Final Score Calculation:**
+Combine the scores from the parameters above to derive the final code quality score (out of 5).
+**Output Format:**
+Provide the final report in a table format with the following columns (use shorthand notations), be sure to include this list at the top above the chart in the "Column Notation" section so users understand what the columns mean:
+
+- **User Name (User)**
+- **Basic Code Standards (BCS) (out of 2)**
+- **Code Readability (CR) (out of 2)**
+- **Error Handling (EH) (out of 4)**
+- **Shopify Theme Check (CI) (out of 1)**
+- **Final Code Quality Score (FCQS) (out of 9)**
+
+
+
+<\_example>
+
+## Column Notation
+
+- **User Name (User)**
+- **Basic Code Standards (BCS) (out of 2)**
+- **Code Readability (CR) (out of 2)**
+- **Error Handling (EH) (out of 4)**
+- **Shopify Theme Check (CI) (out of 1)**
+- **Final Code Quality Score (FCQS) (out of 9)**
+
+## Score Chart
+
+| User | BCS (2) | CR (3) | EH (2) | CI (1) | FCQS (9) |
+| -------- | ------- | ------ | ------ | ------ | -------- |
+| John Doe | 2 | 3 | 2 | 1 | 9 |
+
+
+```
+
+
+
+Then CodeRabbit will reply with a score for you pull request:
+
+Click to view example User Score Card/Chart Comment:
+ + + +```markdown +@coderabbitai +Use the
+
+
+You can then utilize this in a report. We recommend your report looks specifically for these score cards and puts together a unified report:
+
+Click to view resulting Score Card/Chart bot comment:
+ + + +
+ to guide the content of the summary. Use the format shown in but do not include or refer to the example's content in the final summary/report.
+
+
+**Instructions:**
+
+Locate the score chart comment in the . There will be a single comment with data on these fields:
+
+- **User Name (User)**
+- **Basic Code Standards (BCS) (out of 2)**
+- **Code Readability (CR) (out of 2)**
+- **Error Handling (EH) (out of 4)**
+- **Shopify Theme Check (CI) (out of 1)**
+- **Final Code Quality Score (FCQS) (out of 9)**
+
+These details may also be in the form of a chart such as:
+
+## Score Chart
+
+| User | BCS (2) | CR (3) | EH (2) | CI (1) | FCQS (9) |
+| -------- | ------- | ------ | ------ | ------ | -------- |
+| John Doe | 2 | 3 | 2 | 1 | 9 |
+
+You will create a new chart averaging all the values from various pull requests for each author. Only include pull requests with a `Score Chart`. Do not invent or create score charts if none exist.
+
+
+
+
+
+## Column Notation
+
+- **User Name (User)**
+- **Basic Code Standards (BCS) (out of 2)**
+- **Code Readability (CR) (out of 2)**
+- **Error Handling (EH) (out of 4)**
+- **Shopify Theme Check (CI) (out of 1)**
+- **Final Code Quality Score (FCQS) (out of 9)**
+
+## Score Chart
+
+| User | BCS (2) | CR (3) | EH (2) | CI (1) | FCQS (9) | PR URL |
+| -------- | ------- | ------ | ------ | ------ | -------- | ------ |
+| John Doe | 2 | 3 | 2 | 1 | 9 | URL |
+| Alex Foo | 2 | 3 | 2 | 1 | 9 | URL |
+
+
+
+
+```
+
+
+
+**Best Practices for Score Cards/Charts:**
+
+- The reporting bot only has access to your comments and summary (like a project manager) if you want to make a report looking for these score card/chart comments make sure the reviewer does this ahead of time.
+- Only include checks for very specific scenarios, such as a specific check failing or using tabs vs spaces.
+- Do not use general rules without explaining specifically what they mean. If you add "Insure the pull request follows development best practices" you must define what "development best practices" actually mean or the AI will guess.
+- Make one point for each specific check and make sure its a True/False condition.
+- Instead of manually commenting on pull requests you can use the [Github Actions Bot](https://github.com/marketplace/actions/create-or-update-comment) to automatically comment on pull requests and trigger coderabbit score card/chart comments by including `@coderabbit` in the comment.
+
+## Best Practices
+
+1. **Be Specific**
+
+ - Clearly define what should be included/excluded
+ - Use precise language to avoid ambiguity
+ - Specify exact metrics you want to track
+
+2. **Structure Matters**
+
+ - Start with high-level summaries
+ - Use consistent grouping patterns
+ - Include clear section breaks
+
+3. **Keep it Relevant**
+
+ - Focus on actionable information
+ - Avoid redundant data points
+ - Consider your audience's needs
+
+4. **Optimize Readability**
+
+ - Use appropriate formatting
+ - Include visual breaks
+ - Maintain consistent styling
+
+5. **Use Examples**
+ - Include "do this" and "don't do this" examples (especially for titles)
+ - Demonstrate proper formatting patterns
+ - Show concrete use cases for different report types
+ - Help maintain consistency across teams
+ - Avoid ambiguity in report generation
+
+### Add Examples for Consistent Formatting
+
+Try to use `Click to view example Report Prompt when using Score Card/Chart:
+ + + + + +Prompt Example: + +```markdown +Use the
+
+
+You can also edit your path filters directly in the UI by navigating to: **Configuration** > **Review** > **Settings** > **Path Filters**
+
+View complete list of default blocked paths
+ +The following paths are blocked by default, grouped by category: + +#### Build and Dependency Directories + +| Path Pattern | Description | +| --------------------- | -------------------------- | +| `!**/dist/**` | Build output directory | +| `!**/node_modules/**` | Node.js dependencies | +| `!**/.svelte-kit/**` | SvelteKit build directory | +| `!**/.webpack/**` | Webpack build directory | +| `!**/.yarn/**` | Yarn cache directory | +| `!**/.docusaurus/**` | Docusaurus build directory | +| `!**/.temp/**` | Temporary files directory | +| `!**/.cache/**` | Cache directory | +| `!**/.next/**` | Next.js build directory | +| `!**/.nuxt/**` | Nuxt.js build directory | + +#### Lock Files + +| Path Pattern | Description | +| ----------------------- | ------------------ | +| `!**/package-lock.json` | npm lock file | +| `!**/yarn.lock` | Yarn lock file | +| `!**/pnpm-lock.yaml` | pnpm lock file | +| `!**/bun.lockb` | Bun lock file | +| `!**/*.lock` | Generic lock files | + +#### Generated Code + +| Path Pattern | Description | +| ---------------------- | -------------------------------------- | +| `!**/generated/**` | Generated code directory | +| `!**/@generated/**` | Generated code directory (alternative) | +| `!**/__generated__/**` | Generated code directory (alternative) | +| `!**/__generated/**` | Generated code directory (alternative) | +| `!**/_generated/**` | Generated code directory (alternative) | +| `!**/gen/**` | Generated code directory (alternative) | +| `!**/@gen/**` | Generated code directory (alternative) | +| `!**/__gen__/**` | Generated code directory (alternative) | +| `!**/__gen/**` | Generated code directory (alternative) | +| `!**/_gen/**` | Generated code directory (alternative) | + +#### Binary and Compiled Files + +| Path Pattern | Description | +| ------------- | ----------------------- | +| `!**/*.app` | Application bundle | +| `!**/*.bin` | Binary file | +| `!**/*.class` | Java compiled class | +| `!**/*.dll` | Windows dynamic library | +| `!**/*.dylib` | macOS dynamic library | +| `!**/*.exe` | Windows executable | +| `!**/*.o` | Object file | +| `!**/*.so` | Shared object file | +| `!**/*.wasm` | WebAssembly file | + +#### Archives and Compressed Files + +| Path Pattern | Description | +| ------------ | ----------------------- | +| `!**/*.bz2` | Bzip2 archive | +| `!**/*.gz` | Gzip archive | +| `!**/*.xz` | XZ archive | +| `!**/*.zip` | ZIP archive | +| `!**/*.7z` | 7-Zip archive | +| `!**/*.rar` | RAR archive | +| `!**/*.zst` | Zstandard archive | +| `!**/*.tar` | TAR archive | +| `!**/*.jar` | Java archive | +| `!**/*.war` | Web application archive | +| `!**/*.nar` | NAR archive | + +#### Media Files + +| Path Pattern | Description | +| ------------ | --------------- | +| `!**/*.mp3` | MP3 audio | +| `!**/*.wav` | WAV audio | +| `!**/*.wma` | WMA audio | +| `!**/*.mp4` | MP4 video | +| `!**/*.avi` | AVI video | +| `!**/*.mkv` | MKV video | +| `!**/*.wmv` | WMV video | +| `!**/*.m4a` | M4A audio | +| `!**/*.m4v` | M4V video | +| `!**/*.3gp` | 3GP video | +| `!**/*.3g2` | 3G2 video | +| `!**/*.rm` | RealMedia video | +| `!**/*.mov` | QuickTime video | +| `!**/*.flv` | Flash video | +| `!**/*.swf` | Flash animation | +| `!**/*.flac` | FLAC audio | +| `!**/*.ogg` | OGG audio | + +#### Images and Fonts + +| Path Pattern | Description | +| ------------- | ---------------------- | +| `!**/*.ico` | Icon file | +| `!**/*.svg` | SVG image | +| `!**/*.jpeg` | JPEG image | +| `!**/*.jpg` | JPEG image | +| `!**/*.png` | PNG image | +| `!**/*.gif` | GIF image | +| `!**/*.bmp` | BMP image | +| `!**/*.tiff` | TIFF image | +| `!**/*.webm` | WebM image | +| `!**/*.ttf` | TrueType font | +| `!**/*.otf` | OpenType font | +| `!**/*.woff` | Web Open Font Format | +| `!**/*.woff2` | Web Open Font Format 2 | +| `!**/*.eot` | Embedded OpenType font | + +#### Documents and Data Files + +| Path Pattern | Description | +| --------------- | ----------------------- | +| `!**/*.pdf` | PDF document | +| `!**/*.doc` | Word document | +| `!**/*.docx` | Word document | +| `!**/*.xls` | Excel spreadsheet | +| `!**/*.xlsx` | Excel spreadsheet | +| `!**/*.ppt` | PowerPoint presentation | +| `!**/*.pptx` | PowerPoint presentation | +| `!**/*.csv` | CSV data file | +| `!**/*.tsv` | TSV data file | +| `!**/*.dat` | Data file | +| `!**/*.db` | Database file | +| `!**/*.parquet` | Parquet data file | + +#### Development and System Files + +| Path Pattern | Description | +| -------------------- | ------------------- | +| `!**/tags` | Tags file | +| `!**/.tags` | Tags file | +| `!**/TAGS` | Tags file | +| `!**/.TAGS` | Tags file | +| `!**/.DS_Store` | macOS system file | +| `!**/.cscope.files` | Cscope files | +| `!**/.cscope.out` | Cscope output | +| `!**/.cscope.in.out` | Cscope input/output | +| `!**/.cscope.po.out` | Cscope output | +| `!**/*.log` | Log file | +| `!**/*.map` | Source map | +| `!**/*.out` | Output file | +| `!**/*.sum` | Checksum file | +| `!**/*.work` | Work file | +| `!**/*.md5sum` | MD5 checksum file | + +#### Game and 3D Assets + +| Path Pattern | Description | +| ------------------- | ---------------------- | +| `!**/*.tga` | Targa image | +| `!**/*.dds` | DirectDraw surface | +| `!**/*.psd` | Photoshop document | +| `!**/*.fbx` | FBX 3D model | +| `!**/*.obj` | OBJ 3D model | +| `!**/*.blend` | Blender file | +| `!**/*.dae` | COLLADA 3D model | +| `!**/*.gltf` | GL Transmission Format | +| `!**/*.hlsl` | HLSL shader | +| `!**/*.glsl` | GLSL shader | +| `!**/*.unity` | Unity scene | +| `!**/*.umap` | Unreal map | +| `!**/*.prefab` | Unity prefab | +| `!**/*.mat` | Material file | +| `!**/*.shader` | Shader file | +| `!**/*.shadergraph` | Shader graph | +| `!**/*.sav` | Save file | +| `!**/*.scene` | Scene file | +| `!**/*.asset` | Asset file | + +#### Python-specific Files + +| Path Pattern | Description | +| -------------- | --------------------- | +| `!**/*.pyc` | Python compiled file | +| `!**/*.pyd` | Python dynamic module | +| `!**/*.pyo` | Python optimized file | +| `!**/*.pkl` | Python pickle file | +| `!**/*.pickle` | Python pickle file | + +#### Go-specific Files + +| Path Pattern | Description | +| ---------------- | ------------------------------- | +| `!**/*.pb.go` | Protocol buffer Go file | +| `!**/*.pb.gw.go` | Protocol buffer gateway Go file | + +#### Terraform Files + +| Path Pattern | Description | +| ---------------------- | ---------------------- | +| `!**/*.tfstate` | Terraform state file | +| `!**/*.tfstate.backup` | Terraform state backup | + +#### Minified Files + +| Path Pattern | Description | +| ------------------ | ------------------------------ | +| `!**/*.min.js` | Minified JavaScript | +| `!**/*.min.js.map` | Minified JavaScript source map | +| `!**/*.min.js.css` | Minified CSS | + +
+
### Sample Usage
:::note
diff --git a/docs/guides/roles.md b/docs/guides/roles.md
new file mode 100644
index 00000000..c919f57d
--- /dev/null
+++ b/docs/guides/roles.md
@@ -0,0 +1,138 @@
+---
+title: Control administrative access
+description: Using the role-based authorization features of CodeRabbit
+---
+
+You can control which CodeRabbit
+administrative features are available to your organization's user accounts by
+assigning and updating account roles.
+
+## Overview of CodeRabbit roles {#overview}
+
+Every CodeRabbit account has exactly one role for each organization
+that account is associated with.
+For example, if you belong to two GitHub-based organizations that use
+CodeRabbit, then you have one CodeRabbit role set for each of those two
+organizations.
+
+CodeRabbit roles determine your ability to read or change various
+billing, account management, and other administrative functions related to
+an organization. The roles are as follows:
+
+- **Admin**: allows full read/write access to all CodeRabbit administrative features.
+- **Member**: allows read-only access to a limited set of administrative settings. This role
+ is appropriate for most developers in an organization.
+- **Billing Admin**: allows read/write access to features specific
+ to a subscription and billing management, and limited access to other administrative features.
+
+CodeRabbit users with the **Admin** role can modify the roles of other users in the
+organization.
+
+For a complete list of the administrative functions available to each role, see
+[Role permissions](#permissions).
+
+### CodeRabbit roles and Git platform roles {#and-upstream}
+
+Modifying an account's CodeRabbit role doesn't have any "upstream"
+effect on that account's role or permissions in your organization's Git platform.
+Similarly, changes to an account's role on your organization's Git platform don't
+affect that account's CodeRabbit role.
+
+For example, if you have CodeRabbit integrated with a GitHub organization, and you change an account's CodeRabbit role from **Member** to **Admin**, then that account's
+permission or ownership level with your GitHub organization doesn't change as a result.
+
+### CodeRabbit roles and developer features {#and-features}
+
+CodeRabbit roles affect only access to administrative features. Roles have no effect on using CodeRabbit developer features, such as automated code reviews.
+
+For example, if an organization has a Pro-tier
+CodeRabbit account, then any user account with a seat assigned to it can use Pro-tier features with the organization's private repositories, regardless of that account's role.
+
+For more information on seat and subscription management, see [Manage your subscription](/getting-started/subscription-management).
+
+## Default roles {#defaults}
+
+CodeRabbit assigns every user account in your organization a default role,
+using the following metrics:
+
+- If a user has an ownership-level role with the Git platform organizationโfor example,
+ **Admin** on GitHub, or **Owner** on Bitbucketโthen that user receives the default
+ CodeRabbit role of **Admin**.
+- Otherwise, the user receives the **Member** role by default.
+
+You can update a user's role from its default setting by following the steps detailed in the next section. This requires that your own account
+has an **Admin** role with the organization.
+
+CodeRabbit applies these defaults only when initially setting up for an
+account within an organization. Subsequent "upstream" role changes don't affect
+an account's CodeRabbit role.
+
+## View or set roles {#how-to}
+
+You can view and set roles from the CodeRabbit dashboard, as detailed in the
+following sections.
+
+### View roles {#view-roles}
+
+To view a list of your organization's role assignments, follow these steps:
+
+1. Go to the [CodeRabbit dashboard](https://app.coderabbit.ai/settings/repositories).
+1. At the top of the sidebar, select the organization whose user roles you want to view.
+1. On the sidebar, click **Subscription**.
+
+This displays a table of all of the CodeRabbit **Admin** and **Member** accounts associated with the selected
+organization. In this table, the **Role** column displays the CodeRabbit role for
+each account.
+
+To view a list of accounts with the **Billing Admin** role, click the **Billing Admins** tab located above the table of user accounts.
+
+### Set roles {#set-roles}
+
+:::note
+To modify users' CodeRabbit accounts, your own account must have the **Admin** role within your organization.
+:::
+
+To change a user account's CodeRabbit role, follow these steps:
+
+1. Go to your organization's list of user accounts, as detailed in the previous section.
+ If you have the **Admin** role within this organization, then the **Role** column in the user accounts table contains selectable menus.
+1. Click the menu in the user's **Role** column, and select the appropriate role from
+ the list.
+
+The only roles you can assign through this method are **Admin** and **Member**.
+You can't grant the **Billing Admin** role to an existing user account. To add an account with the **Billing Admin** role, see the next section.
+
+### Add billing admin accounts {#billing}
+
+:::note
+Billing Admin users don't require CodeRabbit seat licenses. You can add Billing Admin users regardless of how many seat licenses you have available.
+:::
+
+To add a CodeRabbit user account with the **Billing Admin** role, follow these steps:
+
+1. Go to your organization's list of user accounts, as detailed in [View roles](#view-roles).
+1. Click **Invite Billing Admin**.
+1. Enter the name and email address of the billing administrator who you want to invite to the organization.
+
+This sends an email to the address that you specified. After the recipient completes the process of joining your organization in CodeRabbit, then their record appears in the user accounts list, under the **Billing Admins** tab.
+
+## Role permissions {#permissions}
+
+The following table lists the CodeRabbit administrative functionality
+available to each of the CodeRabbit roles.
+
+| Resource | Admin | Member | Billing Admin |
+| ----------------------- | ---------- | --------- | ------------- |
+| Learning Resources | Read/Write | Read-only | No access |
+| Metrics/Dashboard | Read/Write | No access | No access |
+| Reports | Read/Write | Read-only | No access |
+| Integrations | Read/Write | Read-only | No access |
+| Repository Settings | Read/Write | Read-only | No access |
+| Organization Settings | Read/Write | Read-only | No access |
+| User Management | Read/Write | Read-only | Read-only |
+| Subscription Management | Read/Write | Read-only | Read/Write |
+| Billing Management | Read/Write | No access | Read/Write |
+
+## What's next {#whats-next}
+
+- [Manage your subscription](/getting-started/subscription-management)
diff --git a/docs/guides/scheduled-reports.md b/docs/guides/scheduled-reports.md
new file mode 100644
index 00000000..34c59032
--- /dev/null
+++ b/docs/guides/scheduled-reports.md
@@ -0,0 +1,257 @@
+---
+title: Schedule reports
+description: Learn how to set up automated recurring reports with CodeRabbit Pro
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+
+
-### Intelligence Through Integration
+:::tip DID YOU KNOW?
+CodeRabbit's AI can detect potential issues that would only surface in production, saving costly debugging time later.
+:::
+
+## CodeRabbit is Adaptive
+
+Let the AI learn and grow with your team.
+
+Being an adaptive system means that CodeRabbit continuously learns from your team's practices and preferences without requiring manual configuration or rule setting. When reviewers accept or reject suggestions, CodeRabbit learns and applies these preferences to future reviews.
+
+### Real-World Example: Performance Optimization
-CodeRabbit combines the specialized insights of over 20 analysis tools (ESLint, Semgrep, Checkov, and more) with AI understanding to provide meaningful, actionable feedback. But instead of drowning you in alerts, it provides curated, context-aware suggestions.
+Here's a real example of how CodeRabbit identifies opportunities for performance improvement:
-### Learning Your Team's DNA
+
+
+
+
+
+
+ Intelligent Features
+
+
+ -
+
- Instant code understanding +
- Security vulnerability detection +
- Performance impact assessment +
- Architecture evaluation +
+
+
+
+
+
+ Context Analysis
+
+ Understanding context means analyzing how code changes affect the entire system, not just the modified files. This approach contrasts with traditional code review tools that only look at direct changes.
+
+
+
-CodeRabbit will then:
+:::tip Learning from Feedback
+When you accept or reject these suggestions, CodeRabbit learns your team's preferences and adjusts future recommendations accordingly. This ensures that suggestions become increasingly relevant to your specific needs and coding standards.
+:::
+
+## CodeRabbit is Integrated
+
+Seamless integration with your existing workflow.
+
+CodeRabbit combines insights from multiple specialized tools into a single, coherent review:
+
+
+
+
+
+
+
+ Analyzes Patterns
+
+
+ -
+
- Identifies common performance bottlenecks +
- Learns from your codebase's patterns +
- Suggests modern best practices +
+
+
+
+
+
+ Provides Context
+
+
+ -
+
- Explains the reasoning behind suggestions +
- Highlights potential benefits +
- Offers committable suggestions +
+
+
+But instead of flooding you with alerts, CodeRabbit provides curated, actionable feedback.
+
+## Tool Comparison
-- Remember this preference for future reviews
-- Apply this knowledge across the entire codebase
-- Share this learning with the whole team through its review comments
-- Maintain consistency with your established standards
+
+
+
+
+
+
+ Security
+
+ Semgrep, Checkov
+
+
+
+
+
+
+
+ Style
+
+ ESLint, Prettier
+
+
+
+
+
+
+
+ Performance
+
+ Lighthouse
+
+
+
+
+
+
+
+ Dependencies
+
+ Dependabot
+
+
+
+
+:::note ENTERPRISE READY
+CodeRabbit is built for production environments with:
+
+- SOC 2 Type II certification
+- GDPR compliance
+- Zero data retention
+- Self-hosted options
+ :::
+
+## Start Reviewing Code in Seconds
+
+> CodeRabbit makes it effortless to begin AI-powered code reviews. Our architecture enables instant setup and immediate code analysis, providing you with intelligent feedback within minutes.
+
+### Three Steps to Better Code Reviews
+
+1. **Sign in** with [GitHub](../platforms/github-com.md), [GitLab](../platforms/gitlab-com.mdx), or [Azure DevOps](../platforms/azure-devops.md)
+2. Select and add repositories in CodeRabbit dashboard
+3. That's it. You're good to go.
+
+:::tip INSTANT ACTIVATION
+CodeRabbit starts analyzing your first pull request immediately - no complex configuration needed.
+:::
+
+### What You'll Get
+
+
+
+
+
+
+
+ Immediate Analysis
+
+
+ -
+
- Scans changed files and dependencies +
- Identifies security vulnerabilities +
- Evaluates performance impact +
- Checks architectural consistency +
+
+
+
+
+
+ Communication
+
+
+ -
+
- Generates concise summary +
- Creates visual diagrams +
- Generates a changelist and walkthrough +
- Chat option +
+
+
+
+
+
+ Continuous Learning
+
+
+ -
+
- Remembers team preferences +
- Adapts to coding patterns +
- Shares knowledge across teams +
- Maintains consistent standards +
+
-- Analyzes changes across the entire codebase context
-- Generates a clear, actionable summary
-- Creates visual sequence diagrams for complex changes
-- Provides specific feedback and suggestions
+### Quick Configuration Examples
-This means human reviewers can focus on architectural decisions and knowledge sharing, rather than catching basic issues.
+
+
+
+
+
+
+ Immediate Benefits
+
+ - Instant PR analysis
+ - Security checks
+ - Style enforcement
+ - Performance insights
+
+
+
+
+
+
+
+ Team Features
+
+ - Custom review rules
+ - Team preferences
+ - Knowledge sharing
+ - Workflow integration
+
+
+
+
+
+
+
+ Advanced Tools
+
+ - Visual diagrams
+ - Impact analysis
+ - Batch suggestions
+ - Pattern detection
+
+
+ 
+
+
+The webhook `https://coderabbit.ai/bitbucketHandler` will now be installed for the projects selected.
+
+
+
+ 
+
+
+### Troubleshooting
+
+:::note
+
+If you are experiencing issues with the webhook, such as CodeRabbit not being able to access the repository, or not
+reviewing pull requests, you can manually delete the webhook to the repository.
+
+Then refresh the repository page in the CodeRabbit app and you can reinstall the webhook.
+
+If you cannot install the webhook please check that your Bitbucket user has the necessary permissions to install the
+webhook and the API Token is properly configured.
+
+:::
diff --git a/docs/platforms/github-com.md b/docs/platforms/github-com.md
index b368ce74..60d919d7 100644
--- a/docs/platforms/github-com.md
+++ b/docs/platforms/github-com.md
@@ -7,7 +7,7 @@ sidebar_position: 1
This is a step-by-step guide to integrate CodeRabbit with your GitHub repositories.
-> **CodeRabbit** is an AI code reviewer designed to ease the challenges of code review, supporting repository maintainers and teams. It not only reviews your PRs but also provides concise summaries, identifies potential issues, and offers insights that might be missed during manual reviews.
+> **CodeRabbit** is an AI code reviewer designed to ease the challenges of code review, supporting repository maintainers and teams. It reviews your PRs and provides concise summaries, identifies potential issues, and offers insights that might be missed during manual reviews.
## How CodeRabbit Works?
@@ -21,13 +21,13 @@ It preprocesses the PR content, builds context, leverages Large Language Models
### 1. Accessing CodeRabbit
-Visit the [Code Rabbit login](https://app.coderabbit.ai/login?free-trial) page. You'll see all the authentication options, select "**Login with GitHub**" to proceed.
+Visit the [CodeRabbit login](https://app.coderabbit.ai/login?free-trial) page. You'll see all the authentication options, select "**Login with GitHub**" to proceed.
### 2. Authorization
-When you choose **Login with GitHub** in step1 , you'll be prompted to authorize CodeRabbit.
+When you choose **Login with GitHub** in step1, you'll be prompted to authorize CodeRabbit.
> This step grants the necessary permissions for CodeRabbit to interact with your repositories and pull requests.
@@ -53,15 +53,17 @@ If you opt to authorize all repositories during setup, CodeRabbit will automatic
### 5. CodeRabbit Configuration
-You can configure CodeRabbit through a YAML file or using the [App's UI](https://app.coderabbit.ai/login).
+You can configure CodeRabbit through a YAML file or using the [App's UI](https://app.coderabbit.ai/login?free-trial).
-You can tailor CodeRabbit's functionality using the coderabbit.yaml file, which you place directly in your GitHub repository. This file mirrors the options available in the CodeRabbit user interface, with each setting in the YAML corresponding to a specific toggle in the UI. Configure CodeRabbit either through the coderabbit.yaml file or the interface, depending on your preference.
+You can tailor CodeRabbit's functionality using the `.coderabbit.yaml` file, which you place directly in your GitHub repository. This file mirrors the options available in the CodeRabbit user interface, with each setting in the YAML corresponding to a specific toggle in the UI. Configure CodeRabbit either through the coderabbit.yaml file or the interface, depending on your preference.
:::note
-If a coderabbit.yaml file exists in your GitHub repository, it takes precedence over any UI settings. Choose either the YAML file or UI configuration - you don't need to use both. **Refer Coderabbit.yaml schema [here](https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json)**
+
+If a `.coderabbit.yaml` file exists in your GitHub repository, it takes precedence over any UI settings. Choose either the YAML file or UI configuration - you don't need to use both. **Refer CodeRabbit YAML schema [here](https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json)**
+
:::
-Once your coderabbit.yaml file is prepared according to your needs, simply place it in your GitHub repository, and you're all setโCodeRabbit is now integrated.
+Once your `.coderabbit.yaml` file is prepared according to your needs, simply place it in your GitHub repository, and you're all set โ CodeRabbit is now integrated.
> When a pull request is created targeting the master branch, CodeRabbit automatically initiates its review process. It analyzes the changes and generates a summary and walkthrough of the modifications. The specific feedback and analysis provided by CodeRabbit are determined by the options you've configured in your YAML file.
@@ -89,7 +91,7 @@ The sequence diagram illustrates the precise flow of interactions between the ob
-Also check out the response when i asked for what improvements can be done on the code level
+Also, check out the response when asked for what improvements can be done on the code level.
@@ -97,7 +99,7 @@ In addition to providing reviews and summaries, **CodeRabbit** can also detect c
> For example, I accidentally set up both CodeRabbit Pro (The process we've been discussing) and the open-source version (Refer to [different config process](https://github.com/coderabbitai/ai-pr-reviewer?tab=readme-ov-file#install-instructions)) in my repository at the same time.
-Interestingly, CodeRabbit automatically detects and alerts you about configuration conflicts.
+CodeRabbit automatically detects and alerts you about configuration conflicts.
@@ -107,7 +109,7 @@ CodeRabbit generates detailed statistics and test plans for each pull request.
-> CodeRabbit also allows you to configure **custom review instructions** based on your organization's needs, in case you want it to follow specific guidelines beyond the standard review, to learn more on [adding custom review instructions](https://docs.coderabbit.ai/guides/review-instructions/)
+> CodeRabbit also allows you to configure **custom review instructions** based on your organization's needs, in case you want it to follow specific guidelines beyond the standard review, to learn more on [adding custom review instructions](/guides/review-instructions)
Whether you manage a popular repository or are working on a smaller project, whether it's hosted on **GitLab, GitHub, or self-hosted GitHub or GitLab**, CodeRabbit can help streamline your development process. This AI Code Review assistant is designed to save you time by automating code reviews and offering insightful feedback.
diff --git a/docs/platforms/github-enterprise-server.md b/docs/platforms/github-enterprise-server.md
index cb0e8084..733607cb 100644
--- a/docs/platforms/github-enterprise-server.md
+++ b/docs/platforms/github-enterprise-server.md
@@ -75,8 +75,7 @@ steps below to
[create a GitHub App](https://docs.github.com/en/enterprise-server@latest/apps/creating-github-apps/registering-a-github-app/registering-a-github-app):
1. Sign in to your GitHub Enterprise account.
-2. In the upper-right corner of any page, click your profile photo, then click
- **Settings**.
+2. In the upper-right corner of any page, click your profile photo, then click **Settings**.
3. In the left sidebar, click **Developer settings** > **GitHub Apps**
4. Click **New GitHub App**.
5. Set the following fields:
@@ -90,8 +89,10 @@ steps below to
- **Webhook secret**: Use a secure string and keep it handy.
- **Permissions**:
- **Repository permissions**:
+ - **Actions**: Read-only
- **Checks**: Read-only
- **Contents**: Read and write
+ - **Commit statuses**: Read and write
- **Discussions**: Read-only
- **Issues**: Read and write
- **Metadata**: Read-only
@@ -110,6 +111,7 @@ steps below to
- Pull request review thread
- Push
- Release
+ - **Where can this GitHub App be installed?**: Select `Any account`
6. Click **Create GitHub App**.
Once the GitHub App has been created, click on **Generate a new client secret**
@@ -129,6 +131,8 @@ Keep the following details handy:
+We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition.
+
### **Step 4: CodeRabbit UI Onboarding**
Submit the details that were accumulated in previous steps:
@@ -166,4 +170,20 @@ 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**
+
+#### Who should create the OAuth App and GitHub App?
+
+The OAuth App and GitHub App should be created by a user with administrative
+privileges on the GitHub Enterprise Server instance. This user will be responsible for managing the integration with CodeRabbit.
+
+#### I see an error when trying to log in to CodeRabbit. What should I do?
+
+If you encounter an error during the login process, please ensure that:
+
+- The OAuth App and GitHub App are correctly configured with the right URLs and permissions.
+- The browser local storage and cookies related to CodeRabbit are cleared.
+
+If the issue persists, contact our support team.
diff --git a/docs/platforms/gitlab-com.md b/docs/platforms/gitlab-com.md
deleted file mode 100644
index ebff5ce4..00000000
--- a/docs/platforms/gitlab-com.md
+++ /dev/null
@@ -1,70 +0,0 @@
----
-title: Integrating CodeRabbit with GitLab.com
-description: Learn how to integrate CodeRabbit and add to your GitLab workflow.
-sidebar_label: GitLab.com
-sidebar_position: 2
----
-
-This guide will assist you in effectively integrating CodeRabbit with SaaS GitLab.
-
-## How it works
-
-For the CodeRabbit app to post reviews on merge requests, it needs to interact with the GitLab API, which requires a Personal Access Token. This token can be generated either by using our default CodeRabbit user or by creating a Personal Access Token from one of your existing users.
-
-The CodeRabbit default user, named "coderabbitai", is already set up in GitLab SaaS and will be added to your project when you install the CodeRabbit app. During installation, the necessary webhook for the project will also be created.
-
-If your organization prefers to use an organization user, you can create a new user in GitLab and generate a Personal Access Token for that user, following [our recommendations](#recommendations).
-
-:::note
-
-Keep in mind that if you want to change the review user, you can either disable the organization user or add a new user via the CodeRabbit UI. However, this will require manually removing the previous user from the projects and associated webhooks. Afterward, you will need to reinstall the CodeRabbit app for each project.
-
-:::
-
-## GitLab Access Tokens
-
-To interact with the GitLab API, a **Personal Access Token** is required. This token can either be generated by using our default CodeRabbit user or by creating a **Personal Access Token** from one of your existing users.
-
-Upon first login to the application (immediately after the onboarding screen), you will need to choose based on your organization's requirements.
-
-
-
-**We recommend using the default CodeRabbit user** for most organizations, as it is pre-configured. However, we understand that some organizations may prefer more control over the user or have restrictions regarding user inclusion within their organization.
-
-### Personal Access Tokens
-
-If your organization opts to use another user within the organization, you can do so by [generating a personal access token](#generating-a-personal-access-token).
-
-
-
-#### Recommendations
-
-- **Create a dedicated user for CodeRabbit** - This ensures the user is exclusively for CodeRabbit, allowing better access control.
-- **Use "CodeRabbit" as the username** - This makes the user easily recognizable for future reference.
-- **Use a dedicated email address** - This helps in easy identification and management.
-- **Use the CodeRabbit logo as the profile picture** - This further ensures easy recognition. You can download our logo from [here](/img/integrations/logo.svg "download").
-
-#### Key Points to Remember
-
-- Personal access tokens have expiration dates. Ensure the expiration date covers the duration of your intended use of the CodeRabbit app.
-- Code reviews will be attributed to the owner of the personal access token.
-- If the personal access token expires, you can add a new one via the CodeRabbit UI:
- - Navigate to the "GitLab User" page in the sidebar.
- - Click the "Update" button on the displayed card to see the same modal as the initial login.
-
-### Generating a Personal Access Token
-
-GitLab provides an option to generate a personal access token for a new user. Follow these steps to generate the token:
-
-1. Log in as the user intended for CodeRabbit reviews.
-2. Select your avatar on the left sidebar.
-3. Choose "Edit Profile."
-4. Select "Access Tokens" from the left sidebar.
-5. Click "Add New Token."
-6. Enter a name and an expiry date for the token.
-7. If no expiry date is entered, it defaults to 365 days from the current date.
-8. Ensure the following scopes are selected: `api`, `read_api`, `read_user`.
-9. Click "Create Personal Access Token."
-10. Note down the token as it will only be displayed once.
-
-
diff --git a/docs/platforms/gitlab-com.mdx b/docs/platforms/gitlab-com.mdx
new file mode 100644
index 00000000..c276cd35
--- /dev/null
+++ b/docs/platforms/gitlab-com.mdx
@@ -0,0 +1,154 @@
+---
+title: Integrating CodeRabbit with GitLab.com
+description: Learn how to integrate CodeRabbit and add to your GitLab workflow.
+sidebar_label: GitLab.com
+sidebar_position: 2
+---
+
+CodeRabbit integrates with GitLab to enhance code review and collaboration by:
+
+- Automatically initiating code reviews for newly created merge requests.
+- Displaying review comments and suggestions directly on merge requests.
+- Enabling seamless interaction with the CodeRabbit bot for real-time feedback and assistance.
+
+This guide will assist you in effectively integrating CodeRabbit with SaaS GitLab.
+
+## GitLab Access Tokens
+
+To enable CodeRabbit to interact with your GitLab repositories, an access token is required. This token grants the necessary permissions for interacting with the Merge Requests and Discussions APIs.
+
+ 1. Personal Access Token (PAT): You can create a new GitLab account specifically for CodeRabbit, name it โCodeRabbitโ and treat it as a service account. Then generate a PAT from it where PAT will enable seamless integration between CodeRabbit and your GitLab repositories.
+ 2. Group Access Token: If your organization uses GitLab Premium or Ultimate, you can generate a Group Access Token. This option automatically creates a bot user associated with the group for managing access and posting reviews.
+
+### Personal Access Token
+
+We recommend creating a new user as a service account, associating this user to the group you'd like to install CodeRabbit on, and providing CodeRabbit with the personal access token to allow access. During the installation process, CodeRabbit will automatically configure the required webhook for seamless integration.
+
+
+
+ 
+
+
+:::note
+
+If you wish to change the review user, you must provide the access token for the new user who will post reviews and comments. However, this requires manually removing the previous user from the projects and associated webhooks. Once this is done, you will need to reinstall the CodeRabbit app for each project.
+
+:::
+
+
+
+ 
+
+
+#### Recommendations
+
+- **Create a dedicated user for CodeRabbit** - This ensures the user is exclusively for CodeRabbit, allowing better access control.
+- **Use "CodeRabbit" as the username** - This makes the user easily recognizable for future reference.
+- **Use a dedicated email address** - This helps in easy identification and management.
+- **Use the CodeRabbit logo as the profile picture** - This further ensures easy recognition. You can download our logo from [here](/img/integrations/logo.svg "download").
+- **Ensure Developer Access** - Ensure the dedicated user has (at least) **Developer** access to the group or projects that you wish to install CodeRabbit on.
+
+#### Key Points to Remember
+
+- Personal access tokens have expiration dates. Ensure the expiration date **covers the duration** of your intended use of CodeRabbit.
+- Code reviews will be attributed to the owner of the personal access token.
+- If the personal access token expires, you can add a new one via the CodeRabbit UI:
+ - Navigate to the **GitLab User** page in the sidebar.
+ - Enter the new Access token, and click the **Update** button on the page.
+
+#### Generating a Personal Access Token
+
+GitLab provides an option to generate a personal access token for a new user. Follow these steps to generate the token:
+
+1. Log in using the user designated for CodeRabbit reviews. This user serves as a service account for managing reviews and related activities.
+2. Select your avatar on the left sidebar.
+3. Choose **Edit Profile**.
+4. Select **Access Tokens** from the left sidebar.
+5. Click [Add New Token.](https://gitlab.com/-/user_settings/personal_access_tokens)
+6. Enter a name and an expiry date for the token.
+7. If no expiry date is entered, it defaults to 365 days from the current date.
+8. Ensure the following scopes are selected: `api`, `read_api`, `read_user`.
+9. Click **Create Personal Access Token**
+10. Note down the token as it will only be displayed once.
+
+
+
+ 
+
+
+---
+
+### Group Access Token
+
+Creating a Group Access Token in GitLab automatically generates a bot user. Ensure that the token is configured with Developer access. Once set up, you only need to provide this token for integration. Note that a Group Access Token is limited to the scope of the group where it was created. To configure additional groups, you will need to generate a separate Group Access Token for each group.
+
+:::note
+
+By default, GitLab restricts this option to users on the Premium or Ultimate tiers.
+
+:::
+
+#### Generating a Group Access Token
+
+1. Navigate to the group you wish to install CodeRabbit on.
+2. Select **Settings** from the left sidebar.
+3. Select **Access Tokens** within the Settings heading.
+4. Create a Group Access Token.
+5. Ensure the following scopes are selected: `api`.
+6. Ensure Developer Access is provided.
+
+---
+
+### Where to Provide CodeRabbit the Access Token
+
+By default, if no access token is provided, CodeRabbit will prompt you to provide one during the installation process. However, if you wish to provide the token beforehand, you can do so by navigating to the **Organization Settings** tab, and selecting the **GitLab User** tab on the sidebar. Once entering the token, the token will be validated and saved for future use.
+
+You can confirm the correct user is being selected by verifying the user ID shown on the UI with the user ID of the service account user you created.
+
+---
+
+### Installing CodeRabbit into your GitLab Repositories
+
+1. Go to the [Repositories page](https://app.coderabbit.ai/settings/repositories) in the CodeRabbit app.
+2. Select the checkbox next to the repositories where you want to install CodeRabbit. To install it on all repositories at once, select the checkbox at the top.
+3. Select **Install Repositories**.
+
+
+
+
+
+
+The webhook `https://coderabbit.ai/gitlabHandler` will now be installed for the projects selected.
+
+
+
+ 
+
+
+### Troubleshooting
+
+:::note
+
+If you are experiencing issues with the webhook, such as coderabbit not being able to access the repository, or not reviewing pull requests, you can manually delete the webhook to the repository.
+
+Then refresh the repository page in the CodeRabbit app and you can reinstall the webhook.
+
+If you cannot install the webhook please check that your GitLab user has the necessary permissions to install the webhook and the PAT is not expired.
+
+:::
diff --git a/docs/platforms/platforms.md b/docs/platforms/platforms.md
index ab0cc068..d4cb1748 100644
--- a/docs/platforms/platforms.md
+++ b/docs/platforms/platforms.md
@@ -1,8 +1,6 @@
---
-title: Supported Git Platforms
-sidebar_label: Supported Git Platforms
+title: Integrate with Git platforms
description: Overview of CodeRabbit's supported Git platforms.
-sidebar_position: 1
---
CodeRabbit supports various Git platforms to provide code review for your repositories. For the cloud-hosted Git platforms, you can [login][login] to CodeRabbit and add your repositories. The following platforms are supported:
@@ -13,28 +11,25 @@ CodeRabbit supports various Git platforms to provide code review for your reposi
| ------------------------ | ---------------------------------------- |
| GitHub.com | [Supported](github-com.md) |
| GitHub Enterprise Server | [Supported](github-enterprise-server.md) |
-| GitHub Self Hosted | [Supported](../self-hosted/github.md) |
## GitLab
-| Host | Support |
-| ------------------- | ------------------------------------- |
-| GitLab.com | [Supported](gitlab-com.md) |
-| GitLab Self Managed | [Supported](self-hosted-gitlab.md) |
-| GitLab Self Hosted | [Supported](../self-hosted/gitlab.md) |
+| Host | Support |
+| ------------------- | ---------------------------------- |
+| GitLab.com | [Supported](gitlab-com.mdx) |
+| GitLab Self Managed | [Supported](self-hosted-gitlab.md) |
## Azure DevOps
-| Host | Support |
-| ------------------- | ------------------------------------------- |
-| Azure DevOps | [Supported](azure-devops.md) |
-| Azure DevOps Server | [Supported](../self-hosted/azure-devops.md) |
+| Host | Support |
+| ------------ | ---------------------------- |
+| Azure DevOps | [Supported](azure-devops.md) |
## Bitbucket
| Host | Support |
| -------------------- | ---------------------------------------- |
| Bitbucket Datacenter | [Supported](../self-hosted/bitbucket.md) |
-| Bitbucket Cloud | Coming soon |
+| Bitbucket Cloud | [Supported](./bitbucket-cloud.md) |
-[login]: https://app.coderabbit.ai/login
+[login]: https://app.coderabbit.ai/login?free-trial
diff --git a/docs/platforms/self-hosted-gitlab.md b/docs/platforms/self-hosted-gitlab.md
index 4ef7623c..3fa18a71 100644
--- a/docs/platforms/self-hosted-gitlab.md
+++ b/docs/platforms/self-hosted-gitlab.md
@@ -71,6 +71,8 @@ After the user is created, you can retrieve the **User ID** from that user's
profile and generate an [**access token**](#generating-personal-access-token).
The access token is used to post reviews on merge requests.
+We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition.
+
#### **Creating OAuth2 application**
For self-managed GitLab, we recommend creating an instance-wide application
@@ -120,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/reference/caching.md b/docs/reference/caching.md
new file mode 100644
index 00000000..cea907c0
--- /dev/null
+++ b/docs/reference/caching.md
@@ -0,0 +1,20 @@
+# Caching
+
+CodeRabbit provides caching capabilities for code and dependencies to accelerate the review process. This feature enhances your development workflow by delivering faster feedback.
+
+## Security and Privacy
+
+- Cached data is encrypted (except for OSS projects)
+- Cache expires after a maximum of one week
+- Cached data is used exclusively for speeding up reviews
+
+## Configuration
+
+You can opt out of caching in two ways:
+
+1. **Disable Cache**: Configure `Review - Disable Cache` at either:
+
+ - Organization level
+ - Repository level
+
+2. **Disable Data Retention**: Turn off the `Data Retention` setting in your Organization Settings to disable all data retention across your organization.
diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md
new file mode 100644
index 00000000..bd0b3e8e
--- /dev/null
+++ b/docs/reference/configuration.md
@@ -0,0 +1,4357 @@
+---
+title: Configuration reference
+description: Complete reference for all CodeRabbit configuration options.
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+This reference guide lists all of the code review configuration options that
+CodeRabbit makes available.
+
+For an overview of how configuration works with CodeRabbit, see [Configure CodeRabbit](/guides/configuration-overview).
+
+## How to use this reference {#how-to}
+
+Each entry in this reference corresponds to a single CodeRabbit configuration setting, including an informational table and a description of what the setting does. The tables have two views, which you can select with a tab:
+
+- The **Web UI** tab displays the location and default value of the setting in the CodeRabbit web interface, for both [organization settings](/guides/organization-settings) and [repository settings](/guides/repository-settings).
+- The **coderabbit.yaml** tab displays information about the field's location and datatype in [your repository's `.coderabbit.yaml` file](/getting-started/configure-coderabbit).
+
+## Global Settings
+
+### Data retention
+
+
+| Location | +General > Data Retention | +
| Default | +true | +
| Location | +General > Early Access | +
| Default | +false | +
| Field | +`early_access` | +
| Datatype | +boolean | +
| Default | +false | +
| Location | +General > Enable Free Tier | +
| Default | +true | +
| Field | +`enable_free_tier` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +General > Language | +
| Default | +en-US | +
| Field | +`language` | +
| Datatype | +string | +
| Default | +"en-US" | +
| Location | +General > Tone Instructions | +
| Default | ++ |
| Field | +`tone_instructions` | +
| Datatype | +string | +
| Default | ++ |
| Location | +Review > Settings > Abort On Close | +
| Default | +true | +
| Field | +`reviews.abort_on_close` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Settings > Assess Linked Issues | +
| Default | +true | +
| Field | +`reviews.assess_linked_issues` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Settings > Auto Apply Labels | +
| Default | +false | +
| Field | +`reviews.auto_apply_labels` | +
| Datatype | +boolean | +
| Default | +false | +
| Location | +Review > Settings > Auto Assign Reviewers | +
| Default | +false | +
| Field | +`reviews.auto_assign_reviewers` | +
| Datatype | +boolean | +
| Default | +false | +
| Location | +Review > Settings > Auto Title Instructions | +
| Default | ++ |
| Field | +`reviews.auto_title_instructions` | +
| Datatype | +string | +
| Default | ++ |
| Location | +Review > Settings > Auto Title Placeholder | +
| Default | +@coderabbitai | +
| Field | +`reviews.auto_title_placeholder` | +
| Datatype | +string | +
| Default | +"@coderabbitai" | +
| Location | +Review > Settings > Changed Files Summary | +
| Default | +true | +
| Field | +`reviews.changed_files_summary` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Settings > Collapse Walkthrough | +
| Default | +false | +
| Field | +`reviews.collapse_walkthrough` | +
| Datatype | +boolean | +
| Default | +false | +
| Location | +Review > Settings > Commit Status | +
| Default | +true | +
| Field | +`reviews.commit_status` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Settings > Disable Cache | +
| Default | +false | +
| Field | +`reviews.disable_cache` | +
| Datatype | +boolean | +
| Default | +false | +
| Location | +Review > Settings > Fail Commit Status | +
| Default | +false | +
| Field | +`reviews.fail_commit_status` | +
| Datatype | +boolean | +
| Default | +false | +
| Location | +Review > Settings > High Level Summary | +
| Default | +true | +
| Field | +`reviews.high_level_summary` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Settings > High Level Summary In Walkthrough | +
| Default | +false | +
| Field | +`reviews.high_level_summary_in_walkthrough` | +
| Datatype | +boolean | +
| Default | +false | +
| Location | +Review > Settings > High Level Summary Placeholder | +
| Default | +@coderabbitai summary | +
| Field | +`reviews.high_level_summary_placeholder` | +
| Datatype | +string | +
| Default | +"@coderabbitai summary" | +
| Location | +Review > Settings > Labeling Instructions | +
| Default | +_Empty array_ | +
| Field | +`reviews.labeling_instructions` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Review > Settings > Path Filters | +
| Default | +_Empty array_ | +
| Field | +`reviews.path_filters` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Review > Settings > Path Instructions | +
| Default | +_Empty array_ | +
| Field | +`reviews.path_instructions` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Review > Settings > Poem | +
| Default | +true | +
| Field | +`reviews.poem` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Settings > Profile | +
| Default | +chill | +
| Field | +`reviews.profile` | +
| Datatype | +string | +
| Default | +"chill" | +
| Location | +Review > Settings > Related Issues | +
| Default | +true | +
| Field | +`reviews.related_issues` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Settings > Related PRs | +
| Default | +true | +
| Field | +`reviews.related_prs` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Settings > Request Changes Workflow | +
| Default | +false | +
| Field | +`reviews.request_changes_workflow` | +
| Datatype | +boolean | +
| Default | +false | +
| Location | +Review > Settings > Review Status | +
| Default | +true | +
| Field | +`reviews.review_status` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Settings > Sequence Diagrams | +
| Default | +true | +
| Field | +`reviews.sequence_diagrams` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Settings > Suggested Labels | +
| Default | +true | +
| Field | +`reviews.suggested_labels` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Settings > Suggested Reviewers | +
| Default | +true | +
| Field | +`reviews.suggested_reviewers` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Auto Review > Automatic Review | +
| Default | +true | +
| Field | +`reviews.auto_review.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Auto Review > Automatic Incremental Review | +
| Default | +true | +
| Field | +`reviews.auto_review.auto_incremental_review` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Auto Review > Base Branches | +
| Default | +_Empty array_ | +
| Field | +`reviews.auto_review.base_branches` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Review > Auto Review > Drafts | +
| Default | +false | +
| Field | +`reviews.auto_review.drafts` | +
| Datatype | +boolean | +
| Default | +false | +
| Location | +Review > Auto Review > Ignore Title Keywords | +
| Default | +_Empty array_ | +
| Field | +`reviews.auto_review.ignore_title_keywords` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Review > Auto Review > Labels | +
| Default | +_Empty array_ | +
| Field | +`reviews.auto_review.labels` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Review > Finishing Touches > Docstrings | +
| Default | +true | +
| Field | +`reviews.finishing_touches.docstrings.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Finishing Touches > Unit Tests | +
| Default | +true | +
| Field | +`reviews.finishing_touches.unit_tests.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Chat > Auto Reply | +
| Default | +true | +
| Field | +`chat.auto_reply` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Chat > Jira | +
| Default | +auto | +
| Field | +`chat.integrations.jira.usage` | +
| Datatype | +string | +
| Default | +"auto" | +
| Location | +Chat > Linear | +
| Default | +auto | +
| Field | +`chat.integrations.linear.usage` | +
| Datatype | +string | +
| Default | +"auto" | +
| Location | +Knowledge Base > Opt Out | +
| Default | +false | +
| Field | +`knowledge_base.opt_out` | +
| Datatype | +boolean | +
| Default | +false | +
| Location | +Knowledge Base > Pull Requests | +
| Default | +auto | +
| Field | +`knowledge_base.pull_requests.scope` | +
| Datatype | +string | +
| Default | +"auto" | +
| Location | +Knowledge Base > Web Search | +
| Default | +true | +
| Field | +`knowledge_base.web_search.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Knowledge Base > Issues | +
| Default | +auto | +
| Field | +`knowledge_base.issues.scope` | +
| Datatype | +string | +
| Default | +"auto" | +
| Location | +Knowledge Base > Jira | +
| Default | +auto | +
| Field | +`knowledge_base.jira.usage` | +
| Datatype | +string | +
| Default | +"auto" | +
| Location | +Knowledge Base > Project Keys | +
| Default | +_Empty array_ | +
| Field | +`knowledge_base.jira.project_keys` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Knowledge Base > Learnings | +
| Default | +auto | +
| Field | +`knowledge_base.learnings.scope` | +
| Datatype | +string | +
| Default | +"auto" | +
| Location | +Knowledge Base > Linear | +
| Default | +auto | +
| Field | +`knowledge_base.linear.usage` | +
| Datatype | +string | +
| Default | +"auto" | +
| Location | +Knowledge Base > Team Keys | +
| Default | +_Empty array_ | +
| Field | +`knowledge_base.linear.team_keys` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Code Generation > Language | +
| Default | +en-US | +
| Field | +`code_generation.docstrings.language` | +
| Datatype | +string | +
| Default | +"en-US" | +
| Location | +Code Generation > Path Instructions | +
| Default | +_Empty array_ | +
| Field | +`code_generation.docstrings.path_instructions` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Code Generation > Unit Test Generation | +
| Default | +_Empty array_ | +
| Field | +`code_generation.unit_tests.path_instructions` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Review > Tools > Enable actionlint | +
| Default | +true | +
| Field | +`reviews.tools.actionlint.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > ast-grep > Essential Rules | +
| Default | +true | +
| Field | +`reviews.tools.ast-grep.essential_rules` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > ast-grep > Packages | +
| Default | +_Empty array_ | +
| Field | +`reviews.tools.ast-grep.packages` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Review > Tools > ast-grep > Rule Dirs | +
| Default | +_Empty array_ | +
| Field | +`reviews.tools.ast-grep.rule_dirs` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Review > Tools > ast-grep > Util Dirs | +
| Default | +_Empty array_ | +
| Field | +`reviews.tools.ast-grep.util_dirs` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Review > Tools > Enable Biome | +
| Default | +true | +
| Field | +`reviews.tools.biome.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable Brakeman | +
| Default | +true | +
| Field | +`reviews.tools.brakeman.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable Buf | +
| Default | +true | +
| Field | +`reviews.tools.buf.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable checkmake | +
| Default | +true | +
| Field | +`reviews.tools.checkmake.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable Checkov | +
| Default | +true | +
| Field | +`reviews.tools.checkov.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable CircleCI | +
| Default | +true | +
| Field | +`reviews.tools.circleci.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable Clippy | +
| Default | +true | +
| Field | +`reviews.tools.clippy.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable Cppcheck | +
| Default | +true | +
| Field | +`reviews.tools.cppcheck.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > detekt > Enable | +
| Default | +true | +
| Field | +`reviews.tools.detekt.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > detekt > Config File | +
| Default | +_No default_ | +
| Field | +`reviews.tools.detekt.config_file` | +
| Datatype | +string | +
| Default | +_No default_ | +
| Location | +Review > Tools > Enable dotenv-linter | +
| Default | +true | +
| Field | +`reviews.tools.dotenvLint.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable ESLint | +
| Default | +true | +
| Field | +`reviews.tools.eslint.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Flake8 > Enable | +
| Default | +true | +
| Field | +`reviews.tools.flake8.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > GitHub Checks > Enable | +
| Default | +true | +
| Field | +`reviews.tools.github-checks.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > GitHub Checks > Timeout Ms | +
| Default | +90000 | +
| Field | +`reviews.tools.github-checks.timeout_ms` | +
| Datatype | +number | +
| Default | +90000 | +
| Location | +Review > Tools > Enable Gitleaks | +
| Default | +true | +
| Field | +`reviews.tools.gitleaks.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > golangci-lint > Enable | +
| Default | +true | +
| Field | +`reviews.tools.golangci-lint.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > golangci-lint > Config File | +
| Default | +_No default_ | +
| Field | +`reviews.tools.golangci-lint.config_file` | +
| Datatype | +string | +
| Default | +_No default_ | +
| Location | +Review > Tools > Enable Hadolint | +
| Default | +true | +
| Field | +`reviews.tools.hadolint.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > HTMLHint > Enable | +
| Default | +true | +
| Field | +`reviews.tools.htmlhint.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > HTMLHint > Config File | +
| Default | +_No default_ | +
| Field | +`reviews.tools.htmlhint.config_file` | +
| Datatype | +string | +
| Default | +_No default_ | +
| Location | +Review > Tools > LanguageTool > Disabled Categories | +
| Default | +_Empty array_ | +
| Field | +`reviews.tools.languagetool.disabled_categories` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Review > Tools > LanguageTool > Disabled Rules | +
| Default | +_Empty array_ | +
| Field | +`reviews.tools.languagetool.disabled_rules` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Review > Tools > LanguageTool > Enable | +
| Default | +true | +
| Field | +`reviews.tools.languagetool.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > LanguageTool > Enabled Categories | +
| Default | +_Empty array_ | +
| Field | +`reviews.tools.languagetool.enabled_categories` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Review > Tools > LanguageTool > Enabled Only | +
| Default | +false | +
| Field | +`reviews.tools.languagetool.enabled_only` | +
| Datatype | +boolean | +
| Default | +false | +
| Location | +Review > Tools > LanguageTool > Enabled Rules | +
| Default | +_Empty array_ | +
| Field | +`reviews.tools.languagetool.enabled_rules` | +
| Datatype | +array | +
| Default | +[] | +
| Location | +Review > Tools > LanguageTool > Level | +
| Default | +default | +
| Field | +`reviews.tools.languagetool.level` | +
| Datatype | +string | +
| Default | +"default" | +
| Location | +Review > Tools > Enable Luacheck | +
| Default | +true | +
| Field | +`reviews.tools.luacheck.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable markdownlint | +
| Default | +true | +
| Field | +`reviews.tools.markdownlint.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable OXC | +
| Default | +true | +
| Field | +`reviews.tools.oxc.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > PHPStan > Enable | +
| Default | +true | +
| Field | +`reviews.tools.phpstan.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > PHPStan > Level | +
| Default | +default | +
| Field | +`reviews.tools.phpstan.level` | +
| Datatype | +string | +
| Default | +"default" | +
| Location | +Review > Tools > PMD > Enable | +
| Default | +true | +
| Field | +`reviews.tools.pmd.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > PMD > Config File | +
| Default | +_No default_ | +
| Field | +`reviews.tools.pmd.config_file` | +
| Datatype | +string | +
| Default | +_No default_ | +
| Location | +Review > Tools > Enable PHPMD | +
| Default | +true | +
| Field | +`reviews.tools.phpmd.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable PHPCS | +
| Default | +true | +
| Field | +`reviews.tools.phpcs.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable Prisma Schema Linting | +
| Default | +true | +
| Field | +`reviews.tools.prismaLint.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable Pylint | +
| Default | +true | +
| Field | +`reviews.tools.pylint.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable Regal | +
| Default | +true | +
| Field | +`reviews.tools.regal.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable RuboCop | +
| Default | +true | +
| Field | +`reviews.tools.rubocop.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable Ruff | +
| Default | +true | +
| Field | +`reviews.tools.ruff.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Semgrep > Enable | +
| Default | +true | +
| Field | +`reviews.tools.semgrep.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Semgrep > Config File | +
| Default | +_No default_ | +
| Field | +`reviews.tools.semgrep.config_file` | +
| Datatype | +string | +
| Default | +_No default_ | +
| Location | +Review > Tools > Enable ShellCheck | +
| Default | +true | +
| Field | +`reviews.tools.shellcheck.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable Shopify Theme Check | +
| Default | +true | +
| Field | +`reviews.tools.shopifyThemeCheck.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > Enable SQLFluff | +
| Default | +true | +
| Field | +`reviews.tools.sqlfluff.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > SwiftLint > Enable | +
| Default | +true | +
| Field | +`reviews.tools.swiftlint.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
| Location | +Review > Tools > SwiftLint > Config File | +
| Default | +_No default_ | +
| Field | +`reviews.tools.swiftlint.config_file` | +
| Datatype | +string | +
| Default | +_No default_ | +
| Location | +Review > Tools > Enable YAMLlint | +
| Default | +true | +
| Field | +`reviews.tools.yamllint.enabled` | +
| Datatype | +boolean | +
| Default | +true | +
+
+### Java Build & Testing
+
+- Maven/Gradle dependency conflicts
+- Compilation errors
+- Test failures
+- Memory allocation issues
+
+
+
+### Kubernetes Deployments
+
+- Service configuration validation
+- Resource allocation optimization
+- Network policy fixes
+- Security context remediation
+
+
+
+### NPM Package Management
+
+- Package resolution conflicts
+- Version compatibility issues
+- Security vulnerability patches
+- Build script optimization
+
+
+
+### Python Environment
+
+- Package dependency resolution
+- Virtual environment setup
+- Test framework configuration
+- Code style compliance
+
+
+
+### Security Scanning
+
+- SAST finding remediation
+- Code injection prevention
+- Security best practices
+- Compliance validation
+
+
+
+### Terraform and Infrastructure as Code
+
+- Resource configuration validation
+- State management issues
+- Provider compatibility
+- Security group optimization
+
+
+
+## Supported Platforms
+
+### GitHub Actions
+
+- Automatic detection of workflow failures
+- Inline fixes for common build issues
+- Integration with GitHub Checks
+- Support for custom actions and workflows
+
+### GitLab CI/CD
+
+- GitLab CI/CD Pipeline failure analysis
+- Integration with GitLab Advanced Security
+- Support for DAST (Dynamic Application Security Testing) findings
+- Remediation for SAST (Static Application Security Testing) issues
+
+
+
+
+
+### CircleCI
+
+- CircleCI Pipeline failure analysis
+- Job-level error analysis
+- Configuration validation
+- Dependency resolution
+
+
+
+### Azure DevOps Pipelines
+
+- Azure DevOps CI/CD Pipeline failure analysis
+- Integration with Azure DevOps Checks
+- Support for custom tasks and pipelines
+- Remediation for build issues
+
+
+
+## Common Use Cases
+
+Our tool handles a wide range of pipeline failures including:
+
+### Build Failures
+
+- Docker build issues
+- Node.js dependency conflicts
+- Java compilation errors
+- Python package resolution
+- Go module management
+
+### Infrastructure as Code
+
+- Kubernetes manifest validation
+- Terraform template errors
+- CloudFormation stack issues
+- Ansible playbook failures
+
+### Security Pipeline Integration
+
+- SAST finding remediation
+- DAST vulnerability fixes
+- Dependency scanning
+- Container security
+
+### Testing Failures
+
+- Unit test failures
+- Integration test errors
+- End-to-end test issues
+- Performance test threshold violations
+
+## How It Works
+
+1. **Detection**: CodeRabbit monitors your pipeline runs and automatically detects failures
+2. **Analysis**: Our AI analyzes the failure logs and context to determine the root cause
+3. **Remediation**: We provide inline suggestions and automated fixes where possible
+4. **Learning**: The system learns from successful fixes to improve future recommendations
+
+## Best Practices
+
+1. **Keep Dependencies Updated**: Regular dependency updates help prevent build failures
+2. **Use Lock Files**: Lock files ensure consistent builds across environments
+3. **Implement Caching**: Proper caching strategies speed up builds and reduce failures
+4. **Monitor Resource Usage**: Ensure sufficient resources are allocated to prevent timeouts
+5. **Maintain Clean Tests**: Well-maintained tests reduce false positives
+
+## Links
+
+- [GitHub Actions Configuration](https://docs.github.com/en/actions)
+- [GitLab CI/CD Documentation](https://docs.gitlab.com/ee/ci/)
+- [CircleCI Documentation](https://circleci.com/docs/)
+- [Azure DevOps Pipeline Documentation](https://learn.microsoft.com/en-us/azure/devops/pipelines/get-started/pipelines-get-started?view=azure-devops)
diff --git a/docs/tools/prisma-lint.md b/docs/tools/prisma-lint.md
new file mode 100644
index 00000000..33a36904
--- /dev/null
+++ b/docs/tools/prisma-lint.md
@@ -0,0 +1,46 @@
+---
+title: Prisma Lint
+sidebar_label: Prisma Lint
+description: CodeRabbit's guide to Prisma Lint.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+