Merge branch 'main' into hasit/docs-cleanup

hasit · hasit · commit ae47e752d914 · 2024-10-03T15:35:45.000-07:00
diff --git a/docs/about/pricing.md b/docs/about/pricing.md
@@ -41,7 +41,7 @@ CodeRabbit.
 
 These are the hourly usage limits for each developer per repository:
 
-- Number of files reviewed per hour: 100 Files
+- Number of files reviewed per hour: 150 Files
 - Number of reviews per hour (includes incremental reviews): 9
 - Number of conversations per hour: 50
 
diff --git a/docs/guides/delete-account.md b/docs/guides/delete-account.md
@@ -97,6 +97,16 @@ look at the next section for additional steps required by the user.
 3. Select <strong>Remove Member</strong> and confirm to remove the CodeRabbit
    from your project
 
+### Azure DevOps
+
+#### Uninstalling CodeRabbit from your Azure DevOps project
+
+1. Navigate to your <strong>Project Settings</strong> in the Azure DevOps UI where CodeRabbit is installed.
+2. Under <strong>Project Settings</strong>, go to <strong>Service Hooks</strong>.
+3. Select the webhooks that are added by CodeRabbit.
+4. Click the <strong>Delete</strong> icon at the top of the page.
+5. Remove the CodeRabbit user or delete the <strong>Personal Access Token</strong> associated with the user used for reviews.
+
 :::warning
 
 The steps are necessary to completely off-board CodeRabbit from your
diff --git a/docs/introduction.md b/docs/introduction.md
@@ -4,7 +4,7 @@ title: Introduction
 sidebar_label: Introduction
 sidebar_position: 1
 description:
-  CodeRabbit is an innovative, AI-first code reviewer. It provides context-aware
+  CodeRabbit is an innovative, AI-powered code reviewer. It provides context-aware
   review feedback on a pull request within minutes, thereby significantly
   reducing the time and effort associated with manual code reviews.
 slug: "/"
@@ -14,7 +14,7 @@ slug: "/"
   <iframe src="https://www.youtube.com/embed/3SyUOSebG7E?si=i0oT9RAnH0PW81lY" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerPolicy="strict-origin-when-cross-origin" allowFullScreen></iframe>
 </div>
 
-**CodeRabbit** is an innovative, AI-first code reviewer. It provides
+**CodeRabbit** is an innovative, AI-powered code reviewer. It provides
 context-aware review feedback on a pull request within minutes, thereby
 significantly reducing the time and effort associated with manual code reviews.
 Additionally, it brings a different perspective to the reviews and finds issues
@@ -46,7 +46,7 @@ Data storage: Code downloaded during the review process is temporarily stored in
 memory and deleted once the review is completed. The code is not stored or used for
 any other purpose. However, CodeRabbit enhances future reviews for your organization by
 storing the embeddings of the learnings generated from chat conversations. Additionally,
-it integrates embeddings from issues in workflow systems (Liner, Jira, GitHub/GitLab issues)
+it integrates embeddings from issues in workflow systems (Linear, Jira, GitHub/GitLab issues)
 to assess the impact of code changes on existing issues.
 
 Compliance and Data Privacy: Your data is kept confidential, isolated by the
diff --git a/docs/platforms/azure-devops.md b/docs/platforms/azure-devops.md
@@ -1,75 +1,101 @@
 ---
 title: Integrating CodeRabbit with Azure DevOps
 description: Integrate CodeRabbit with Azure DevOps.
-sidebar_label: Azure DevOps (Beta)
+sidebar_label: Azure DevOps
 sidebar_position: 5
 ---
 
-This guide will assist you in effectively integrating CodeRabbit with Azure DevOps.
+This guide will assist you in effectively integrating CodeRabbit with Azure
+DevOps.
 
 ## Prerequisites
 
-* An active Azure DevOps account.
-* Use of organizational email addresses is required; personal email addresses are not supported for this integration.
+- An active Azure DevOps account.
+- Use of organizational email addresses is required; personal email addresses
+  are not supported for this integration.
 
 ## Integration Instructions
+
 1. Log in to the CodeRabbitAI application.
-2. After logging in, you will be redirected to a page displaying Microsoft Apps consent requests. Please forward these requests to your administrator for approval.
+2. After logging in, you will be redirected to a page displaying Microsoft Apps
+   consent requests. Please forward these requests to your administrator for
+   approval.
 
 :::warning
 
-If you are an administrator, you may approve the applications directly. If not, please contact your administrator to request approval for the applications.
+If you are an administrator, you may approve the applications directly. If not,
+please contact your administrator to request approval for the applications.
 
 :::
 
 ![azure devops apps consent](/img/integrations/azure_apps_consent_page.png)
 
 3. Once your administrator has approved the applications, click "Continue."
-4. You will be redirected to the "Onboarding" page, where you can select the organization you wish to integrate with.
-5. On the "Azure DevOps User" page, enter your Personal Access Token for Azure DevOps.
-![azure devops user page](/img/integrations/azure_devops_user_page.png)
-6. To install CodeRabbit on a repository, toggle the switch on the "Repositories" page.
+4. You will be redirected to the "Onboarding" page, where you can select the
+   organization you wish to integrate with.
+5. On the "Azure DevOps User" page, enter your Personal Access Token for Azure
+   DevOps.
+   ![azure devops user page](/img/integrations/azure_devops_user_page.png)
+6. To install CodeRabbit on a repository, toggle the switch on the
+   "Repositories" page.
 
 ## How it works
 
-For the CodeRabbit app to post reviews on merge requests, it needs to interact with the Azure DevOps API, which requires a Personal Access Token. This token can be generated by creating a Personal Access Token from one of your existing users.
+For the CodeRabbit app to post reviews on merge requests, it needs to interact
+with the Azure DevOps API, which requires a Personal Access Token. This token
+can be generated by creating a Personal Access Token from one of your existing
+users.
 
-You can create a new user in Azure DevOps and generate a Personal Access Token for that user, following [our recommendations](#recommendations).
+You can create a new user in Azure DevOps and generate a Personal Access Token
+for that user, following [our recommendations](#recommendations).
 
 ## Azure DevOps Personal Access Tokens
 
-To interact with the Azure DevOps API, a **Personal Access Token** is required. This token can be generated by creating a **Personal Access Token** from one of your existing users.
+To interact with the Azure DevOps API, a **Personal Access Token** is required.
+This token can be generated 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 add the Personal Access Token.
+Upon first login to the application (immediately after the onboarding screen),
+you will need to add the Personal Access Token.
 
 ![azure devops user modal](/img/integrations/azure_personal_access_token_add.png)
 
 ### 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").
+- **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 "AzureDevOps User" page in the sidebar.
-  * Add the new token and click save.
+- 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 "AzureDevOps User" page in the sidebar.
+  - Add the new token and click save.
 
 ### Generating a Personal Access Token
 
-Azure DevOps provides an option to generate a personal access token for a user. Follow these steps to generate the token:
+Azure DevOps provides an option to generate a personal access token for a user.
+Follow these steps to generate the token:
 
 1. Log in as the user intended for CodeRabbit reviews.
 2. Next to your avatar on the headers right side is a settings icon, click it.
 3. Choose "Personal Access Tokens"
 4. Click "New Token"
-5. Select the organization you want to use the token with or select "All accessible organizations."
+5. Select the organization you want to use the token with or select "All
+   accessible organizations."
 6. Enter a name and an expiry date for the token.
-7. We need to have read & write access to "Work Items" & "Code" to post reviews on pull requests.
+7. We need to have read & write access to "Work Items" & "Code" to post reviews
+   on pull requests.
 8. Click "Create"
 
 ![Generate Personal Access Token](/img/integrations/azure-access-token.png)
diff --git a/docs/platforms/github-enterprise-server.md b/docs/platforms/github-enterprise-server.md
@@ -1,18 +1,20 @@
 ---
 title: CodeRabbit for GitHub Enterprise Server
 description: Integrate CodeRabbit with your GitHub Enterprise Server.
-sidebar_label: Github Enteprise Server
+sidebar_label: GitHub Enterprise Server
 sidebar_position: 3
 ---
 
 :::info
 
 This page is for GitHub Enterprise Server (Self-Hosted) users only.  
-If you're using github.com, [log in to CodeRabbit](https://app.coderabbit.ai) and add your repositories from there
+If you're using github.com, [log in to CodeRabbit](https://app.coderabbit.ai)
+and add your repositories from there
 
 :::
 
-This page guides you through the process of integrating your Self-Managed GitHub with CodeRabbit.
+This page guides you through the process of integrating your Self-Managed GitHub
+with CodeRabbit.
 
 To initiate the integration, we require specific information. This is essential
 for the initial setup of CodeRabbit within your domain. Once this setup is
@@ -31,26 +33,33 @@ organization and if we find an existing one, we will start the login process.
 
 ![Untitled](/img/integrations/self-hosted-github-host-url.png)
 
-If the self-managed GitHub instance is not found, you will be required to enter more details for the onboarding.
+If the self-managed GitHub instance is not found, you will be required to enter
+more details for the onboarding.
 
 ### **Step 2: GitHub OAuth App**
 
-Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow the steps below to [create an OAuth App](https://docs.github.com/en/enterprise-server@latest/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app):
+Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow the
+steps below to
+[create an OAuth App](https://docs.github.com/en/enterprise-server@latest/apps/oauth-apps/building-oauth-apps/creating-an-oauth-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** > **OAuth Apps**.
 4. Click **New OAuth App**.
 5. Set the following fields:
    - **Application name**: `CodeRabbit OAuth`
    - **Homepage URL**: `https://coderabbit.ai`
-   - **Application description**: `OAuth application for signing into CodeRabbit`
+   - **Application description**:
+     `OAuth application for signing into CodeRabbit`
    - **Authorization callback URL**: `https://app.coderabbit.ai/login`
 6. Click **Register application**.
 
 ![GitHub Create OAuth App](/img/integrations/github-create-oauth-app.png)
 
-Once the OAuth App has been created, click on **Generate a new client secret** under the 'Client secrets' section and copy the secret as it will be visible once only
+Once the OAuth App has been created, click on **Generate a new client secret**
+under the 'Client secrets' section and copy the secret as it will be visible
+once only
 
 Keep the following details handy:
 
@@ -61,10 +70,13 @@ Keep the following details handy:
 
 ### **Step 3: GitHub App**
 
-Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow the 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):
+Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow the
+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:
@@ -100,9 +112,12 @@ Navigate to your GitHub Enterprise Server (Self-Hosted) Instance and follow the
        - Release
 6. Click **Create GitHub App**.
 
-Once the GitHub App has been created, click on **Generate a new client secret** under the 'Client secrets' section and copy the secret as it will be visible once only.
+Once the GitHub App has been created, click on **Generate a new client secret**
+under the 'Client secrets' section and copy the secret as it will be visible
+once only.
 
-Scroll down and click on **Generate a private key** under the 'Private keys' section and download the PEM file.
+Scroll down and click on **Generate a private key** under the 'Private keys'
+section and download the PEM file.
 
 Keep the following details handy:
 
@@ -127,18 +142,21 @@ Submit the details that were accumulated in previous steps:
 - GitHub App Webhook Secret
 - GitHub App Private Key
 
-Click on Submit and the login process will be initiated.
-On subsequent visits, your setup will be automatically detected, allowing for direct login.
+Click on Submit and the login process will be initiated. On subsequent visits,
+your setup will be automatically detected, allowing for direct login.
 
 ### **Step 5: Install the GitHub App**
 
-Navigate to the GitHub App that was created from your Github Enterprise Server (self-hosted) instance and click on the **Install App** tab.
-Then, install the GitHub App to your organization(s).
+Navigate to the GitHub App that was created from your GitHub Enterprise Server
+(self-hosted) instance and click on the **Install App** tab. Then, install the
+GitHub App to your organization(s).
 
 :::warning
 
-If you performed this step before Step 4, the installation event likely will have failed, and you will need to re-send the installation event.  
-Navigate to the **Advanced** tab in the GitHub App and click on the **Redeliver** button for the failed `installation.created` event.
+If you performed this step before Step 4, the installation event likely will
+have failed, and you will need to re-send the installation event.  
+Navigate to the **Advanced** tab in the GitHub App and click on the
+**Redeliver** button for the failed `installation.created` event.
 
 :::
 
diff --git a/docs/platforms/platforms.md b/docs/platforms/platforms.md
@@ -18,15 +18,15 @@ CodeRabbit supports various Git platforms to provide code review for your reposi
 
 | Host                | Support                            |
 | ------------------- | ---------------------------------- |
-| GitLab.com          | [Supported](gitlab-com.md)        |
+| GitLab.com          | [Supported](gitlab-com.md)         |
 | GitLab Self Managed | [Supported](self-hosted-gitlab.md) |
 
 ## Azure DevOps
 
 | Host                | Support                            |
 | ------------------- | ---------------------------------- |
-| Azure DevOps        | [Supported](azure-devops.md)  |
-| Azure DevOps Server | Coming soon                        |
+| Azure DevOps        | [Supported](azure-devops.md)       |
+| Azure DevOps Server | [Supported]                        |
 
 ## Bitbucket
 
diff --git a/docs/tools/actionlint.md b/docs/tools/actionlint.md
@@ -4,11 +4,12 @@ sidebar_label: Actionlint
 description: CodeRabbit's guide to Actionlint.
 ---
 
-[Actionlint](https://github.com/rhysd/actionlint/) is a static checker for GitHub Actions workflow files.
+[Actionlint](https://github.com/rhysd/actionlint/) is a static checker for
+GitHub Actions workflow files.
 
 ## Files
 
-We look for `Github Action` files specifically in the following directory:
+We look for `GitHub Action` files specifically in the following directory:
 
 - `.github/workflows/**/*.yml`
 - `.github/workflows/**/*.yaml"`
diff --git a/docs/tools/semgrep.md b/docs/tools/semgrep.md
@@ -0,0 +1,62 @@
+---
+title: Semgrep
+sidebar_label: Semgrep
+description: CodeRabbit's guide to Semgrep.
+---
+
+[Semgrep](https://semgrep.dev/) is a static analysis tool designed to scan code for security vulnerabilities and code quality issues..
+
+## Files
+
+Semgrep will run on the following files and extensions:
+
+- `Apex`
+- `Bash` 
+- `.c`
+- `.cpp`
+- `.cs`
+- `.clj`
+- `.dart`
+- `Dockerfile`
+- `.ex` 
+- `.html`
+- `.go`
+- `.java`
+- `.js`
+- `.jsx`
+- `.json`
+- `.jl`
+- `.jsonnet`
+- `.kt`
+- `.kts`
+- `Lisp`
+- `.lua`
+- `.ml`
+- `.php`
+- `.py`
+- `.r`
+- `.rb`
+- `.rs` 
+- `.scala`
+- `Scheme`
+- `.sol`
+- `.swift`
+- `.tf`
+- `.ts`
+- `.tsx`
+- `.yaml`
+- `.xml`
+- `ERB`
+- `Jinja`
+
+## Configuration
+
+Semgrep uses a YAML style configuration file.
+
+Semgrep supports the following config files:
+
+- User-defined config file set at `reviews.tools.semgrep.config_file` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → Semgrep → Config File" field in CodeRabbit's settings page.
+
+## Links
+
+- [Semgrep Cli Reference](https://semgrep.dev/docs/cli-reference)
diff --git a/docs/tools/tools.md b/docs/tools/tools.md
diff --git a/static/schema/schema.v2.json b/static/schema/schema.v2.json
