diff --git a/docs/about/pricing.md b/docs/about/pricing.md index 5c6aa8c0..4db71678 100644 --- a/docs/about/pricing.md +++ b/docs/about/pricing.md @@ -1,8 +1,7 @@ --- title: Pricing sidebar_label: Pricing -description: - Learn about the plans, pricing, and subscription management of CodeRabbit. +description: Learn about the plans, pricing, and subscription management of CodeRabbit. --- This section covers the plans, pricing, and subscription management of diff --git a/docs/guides/ondemand-reports.md b/docs/guides/ondemand-reports.md index cdd7a9b8..90c2db2f 100644 --- a/docs/guides/ondemand-reports.md +++ b/docs/guides/ondemand-reports.md @@ -1,8 +1,7 @@ --- title: On-demand Reports sidebar_label: On-demand Reports (Beta) -description: - CodeRabbit offers a way to generate on-demand reports using a simple API request +description: CodeRabbit offers a way to generate on-demand reports using a simple API request sidebar_position: 6 --- diff --git a/docs/introduction.md b/docs/introduction.md index 1ac09955..44ba725b 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -14,7 +14,6 @@ slug: "/" - **CodeRabbit** is an innovative, AI-first 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. diff --git a/docs/platforms/platforms.md b/docs/platforms/platforms.md index 9caf84b8..06136bf4 100644 --- a/docs/platforms/platforms.md +++ b/docs/platforms/platforms.md @@ -10,28 +10,28 @@ CodeRabbit supports various Git platforms to provide code review for your reposi ## GitHub | Host | Support | -|--------------------------|------------------------------------| +| ------------------------ | ---------------------------------- | | GitHub.com | [Supported][login] | | GitHub Enterprise Server | [Supported](self-hosted-github.md) | ## GitLab | Host | Support | -|---------------------|------------------------------------| +| ------------------- | ---------------------------------- | | GitLab.com | [Supported](saas-gitlab.md) | | GitLab Self Managed | [Supported](self-hosted-gitlab.md) | ## Azure DevOps | Host | Support | -|---------------------|-------------| +| ------------------- | ----------- | | Azure DevOps Cloud | Coming soon | | Azure DevOps Server | Coming soon | ## Bitbucket | Host | Support | -|-----------------------|-------------| +| --------------------- | ----------- | | Cloud | Coming soon | | Bitbucket Data Center | Coming soon | diff --git a/docs/platforms/saas-gitlab.md b/docs/platforms/saas-gitlab.md index aeb6dd4e..2d8d9fe8 100644 --- a/docs/platforms/saas-gitlab.md +++ b/docs/platforms/saas-gitlab.md @@ -39,18 +39,18 @@ If your organization opts to use another user within the organization, you can d #### 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 "GitLab User" page in the sidebar. - * Click the "Update" button on the displayed card to see the same modal as the initial login. +- 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 diff --git a/docs/platforms/self-hosted-github.md b/docs/platforms/self-hosted-github.md index 78f21cb0..4ec9a58a 100644 --- a/docs/platforms/self-hosted-github.md +++ b/docs/platforms/self-hosted-github.md @@ -20,7 +20,7 @@ complete, you can log in directly. ### **Step 1: Getting Started** -**Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and +**Visit CodeRabbit:** Visit our [Login](https://coderabbit.ai/login) page and select Self-Hosted GitHub ![login-page](/img/integrations/login-self-hosted-github.png) diff --git a/docs/tools/detekt.md b/docs/tools/detekt.md index b3877a98..b52e4ae0 100644 --- a/docs/tools/detekt.md +++ b/docs/tools/detekt.md @@ -15,7 +15,7 @@ Detekt will run on files with the following extensions: ## Configuration -Detekt uses a YAML style configuration file. +Detekt uses a YAML style configuration file. Detekt supports the following config files: diff --git a/docs/tools/tools.md b/docs/tools/tools.md index efacaa86..a941b8af 100644 --- a/docs/tools/tools.md +++ b/docs/tools/tools.md @@ -37,7 +37,7 @@ Remove extraneous f prefix ## Supported Tools | Technology | Tools | -|:----------------------------|:-----------------------------------------------------------| +| :-------------------------- | :--------------------------------------------------------- | | All | [Gitleaks][Gitleaks] | | CloudFormation | [Checkov][Checkov] | | CSS | [Biome][Biome] | @@ -64,7 +64,6 @@ Remove extraneous f prefix | Typescript | [Biome][Biome] | | YAML | [YamlLint][YamlLint] | - [ShellCheck]: ./shellcheck.md [Ruff]: ./ruff.md [Markdownlint]: ./markdownlint.md @@ -81,4 +80,4 @@ Remove extraneous f prefix [Rubocop]: ./rubocop.md [Buf]: ./buf.md [Actionlint]: ./actionlint.md -[Regal]: ./regal.md \ No newline at end of file +[Regal]: ./regal.md