Merge branch 'main' into add-faq

aravindputrevu · web-flow · commit 881d97187734 · 2024-11-11T14:31:17.000+01:00
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -5,6 +5,12 @@ description: The latest updates and changes to CodeRabbit.
 sidebar_position: 9
 ---
 
+## November 8, 2024
+
+### ESLint Support
+
+We've introducded support for ES Lint, including .vue, .svelte, and .astro, alongside traditional .js, .ts, and .jsx extensions. We've worked on monorepo compatibility with improved Yarn and PNPM workspace support, ensuring seamless integration across your projects. While maintaining your existing ESLint configurations, we simply require all dependencies to be properly defined in your package.json. Note that private plugins aren't currently supported, but we're committed to making code quality maintenance as efficient as possible across all your web development needs
+
 ## October 31, 2024
 
 ### Learnings and Metrics Iteration for CodeRabbit Self-Hosted Customers
diff --git a/docs/configure-coderabbit.md b/docs/configure-coderabbit.md
@@ -5,7 +5,7 @@ description:
   CodeRabbit offers various configuration options to tailor the reviews to your
   specific requirements. Configuration can be made using one of the below
   options.
-sidebar_position: 4
+sidebar_position: 3
 ---
 
 ```mdx-code-block
diff --git a/docs/guides/_category_.yml b/docs/guides/_category_.yml
@@ -1,4 +1,4 @@
 label: Guides
-position: 7
+position: 6
 collapsible: true
 collapsed: true
diff --git a/docs/integrations/_category_.yml b/docs/integrations/_category_.yml
@@ -1,4 +1,4 @@
 label: Integrations
-position: 8
+position: 7
 collapsible: true
 collapsed: true
diff --git a/docs/platforms/_category_.yaml b/docs/platforms/_category_.yaml
@@ -1,4 +1,4 @@
 label: Supported Git Platforms
-position: 6
+position: 5
 collapsible: true
 collapsed: true
diff --git a/docs/platforms/azure-devops.md b/docs/platforms/azure-devops.md
@@ -28,14 +28,14 @@ DevOps.
 
    :::
 
-   ![azure devops apps consent](/img/integrations/azure_apps_consent_page.png)
+   ![CodeRabbit admin consent page for Azure DevOps integration](/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)
+   ![CodeRabbit azure devOps integration settings page](/img/integrations/azure_devops_user_page.png)
 6. To install CodeRabbit on a repository, toggle the switch on the
    "Repositories" page.
 
@@ -58,7 +58,7 @@ your existing users.
 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)
+![CodeRabbit azure devOps integration modal](/img/integrations/azure_personal_access_token_add.png)
 
 ### Recommendations
 
@@ -98,4 +98,4 @@ Follow these steps to generate the token:
    on pull requests.
 8. Click "Create"
 
-![Generate Personal Access Token](/img/integrations/azure-access-token.png)
+![CodeRabbit azure devOps personal access token creation form](/img/integrations/azure-access-token.png)
diff --git a/docs/platforms/github-enterprise-server.md b/docs/platforms/github-enterprise-server.md
@@ -25,13 +25,13 @@ complete, you can log in directly.
 **Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and
 select Self-Hosted GitHub
 
-![login-page](/img/integrations/login-self-hosted-github.png)
+![CodeRabbit login page](/img/integrations/login-self-hosted-github.png)
 
 On this page, enter the URL of your self-managed GitHub instance and click
 submit. Once, you submit, we check our database for a record of your
 organization and if we find an existing one, we will start the login process.
 
-![Untitled](/img/integrations/self-hosted-github-host-url.png)
+![Self-hosted gitHub enterprise connection page for CodeRabbit](/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.
diff --git a/docs/platforms/gitlab-com.md b/docs/platforms/gitlab-com.md
@@ -67,4 +67,4 @@ GitLab provides an option to generate a personal access token for a new user. Fo
 9. Click "Create Personal Access Token."
 10. Note down the token as it will only be displayed once.
 
-![Untitled](/img/integrations/admin-access-token.png)
+![GitLab personal access token configuration page](/img/integrations/admin-access-token.png)
diff --git a/docs/platforms/self-hosted-gitlab.md b/docs/platforms/self-hosted-gitlab.md
@@ -22,15 +22,15 @@ upgrading your GitLab instance to obtain the intended experience.
 **Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and
 select Self-Hosted GitLab
 
-![login-page](/img/integrations/login-self-hosted-gitlab.png)
+![CodeRabbit login](/img/integrations/login-self-hosted-gitlab.png)
 
 ### Step 2: Enter your Self-Managed GitLab URL
 
 On this page, enter the URL of your self-managed GitLab instance and click
 submit. Once, you submit, we check our database for a record of your
 organization and if we find an existing one, we are starting the login process.
 
-![Untitled](/img/integrations/self-hosted-gitlab-host-url.png)
+![Self-hosted Gitlab enterprise connection page](/img/integrations/self-hosted-gitlab-host-url.png)
 
 If the self-managed GitLab instance is not found, we initiate the onboarding
 process, which can be either manual or automated.
@@ -39,7 +39,7 @@ process, which can be either manual or automated.
 
 #### 1. Automated onboarding
 
-![Untitled](/img/integrations/automated-onboarding.png)
+![Self-managed GitLab connection page](/img/integrations/automated-onboarding.png)
 
 #### **Why do we need the Admin Access Token?**
 
@@ -55,7 +55,7 @@ add CodeRabbit manually on the projects you wish, as the next step.
 For the manual onboarding process we need to create the
 [CodeRabbit user](#creating-coderabbit-user) and the
 [OAuth2 GitLab application](#creating-oauth2-application).
-![Untitled](/img/integrations/manual-onboarding.png)
+![Self-managed GitLab connection page](/img/integrations/manual-onboarding.png)
 
 #### **Creating CodeRabbit user**
 
@@ -105,14 +105,14 @@ the token, please follow the process outlined below:
 9. Select Create personal access token.
 10. Please note down this token as this will be visible one time only
 
-![Untitled](/img/integrations/admin-access-token.png)
+![GitLab personal access token configuration page](/img/integrations/admin-access-token.png)
 
 ### **Step 4: Paste the details and click submit**
 
 - Submit the form.
 - We will handle the setup process for you.
 - On subsequent visits, your setup will be automatically detected, allowing for
-  direct login. ![Untitled](/img/integrations/self-hosted-page.png)
+  direct login. ![CodeRabbit authentication options page](/img/integrations/self-hosted-page.png)
 
 ### **Step 5: Whitelist CodeRabbit IP address**
 
diff --git a/docs/self-hosted/_category_.yaml b/docs/self-hosted/_category_.yaml
@@ -1,4 +1,4 @@
 label: Self-Hosted CodeRabbit
-position: 3
+position: 8
 collapsible: true
 collapsed: true
diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md
@@ -5,6 +5,12 @@ description: Instructions to self-host CodeRabbit and integrate it with Azure De
 sidebar_position: 3
 ---
 
+:::note
+
+The self-hosted option is only available for CodeRabbit Enterprise customers with 500 user seats or more. Please contact [CodeRabbit Sales](mailto:sales@coderabbit.ai) to learn more about the CodeRabbit Enterprise plan.
+
+:::
+
 ## Create a Azure DevOps User
 
 - **Username**: Set the username to "CodeRabbit" for easier identification (optional).
diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md
@@ -5,6 +5,12 @@ description: Instructions to self-host CodeRabbit and integrate it with GitHub.
 sidebar_position: 1
 ---
 
+:::note
+
+The self-hosted option is only available for CodeRabbit Enterprise customers with 500 user seats or more. Please contact [CodeRabbit Sales](mailto:sales@coderabbit.ai) to learn more about the CodeRabbit Enterprise plan.
+
+:::
+
 ## Create a GitHub App
 
 Set the following Repository permissions:
diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md
@@ -5,6 +5,12 @@ description: Instructions to self-host CodeRabbit and integrate it with GitLab.
 sidebar_position: 2
 ---
 
+:::note
+
+The self-hosted option is only available for CodeRabbit Enterprise customers with 500 user seats or more. Please contact [CodeRabbit Sales](mailto:sales@coderabbit.ai) to learn more about the CodeRabbit Enterprise plan.
+
+:::
+
 ## Create a GitLab User
 
 - **Username**: Set the username to "CodeRabbit" for easier identification (optional).
diff --git a/docs/tools/_category_.yml b/docs/tools/_category_.yml
@@ -1,4 +1,4 @@
 label: Supported Tools
-position: 5
+position: 4
 collapsible: true
 collapsed: true
diff --git a/docs/tools/eslint.md b/docs/tools/eslint.md
@@ -0,0 +1,33 @@
+---
+title: ESLint
+sidebar_label: ESLint
+description: CodeRabbit's guide to ESLint.
+---
+
+[ESLint](https://eslint.org/) is a linter for JavaScript, TypeScript, JSX, TSX, CSS, etc.
+
+## Files
+
+ESLint will run on files with the following extensions:
+
+- `.js`
+- `.ts`
+- `.cjs`
+- `.mjs`
+- `.d.cts`
+- `.d.mts`
+- `.jsx`
+- `.tsx`
+- `.css`
+- `.vue`
+- `.svelte`
+- `.astro`
+
+## Configuration
+
+- ESLint configuration is read from the repository and is used as is. No additional configuration is required.
+- Please ensure that all ESLint dependencies are defined in your `package.json` file(s).
+- Yarn and PNPM workspaces are supported.
+- Private ESLint plugins or configurations are not supported at the moment. Please reach out to us on Discord if you would like us to add support for this.
+- For `@typescript-eslint`, linting with type information at the moment. The [type checking rules](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/disable-type-checked.ts) are disabled.
+- For `eslint-plugin-import`, the `import/no-unresolved` rule is disabled.
diff --git a/src/theme/Footer/cr-logo.js b/src/theme/Footer/cr-logo.js
diff --git a/src/theme/Footer/index.js b/src/theme/Footer/index.js
