diff --git a/docs/about/_category_.yaml b/docs/about/_category_.yaml deleted file mode 100644 index 46bff42b..00000000 --- a/docs/about/_category_.yaml +++ /dev/null @@ -1,4 +0,0 @@ -label: Platform -position: 8 -collapsible: true -collapsed: false diff --git a/docs/about/features.md b/docs/about/features.md deleted file mode 100644 index b1decf5d..00000000 --- a/docs/about/features.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: CodeRabbit Features -sidebar_label: Features -description: Learn how CodeRabbit works in a pull request review. ---- - -### 1. Pull Request Summary {#pull-request-summary} - -Generated upon the creation of a pull request and subsequently updated with each -incremental request. - -**High-Level Summary**: This offers a concise overview of the changes in the pull -request. It helps the team, including those without technical expertise, to -quickly understand the changes and the impact on the product. - -![CodeRabbit- Pull Request Summary](/img/about/Summary-Overview.png) - -**Walkthrough**: A detailed code walkthrough to understand the changes in each file -that is part of the pull request, followed by a celebratory poem about the -changes. - -![CodeRabbit- Pull Request Walkthrough Example](/img/about/Summary-Walkthrough.png) - -### 2. Code Review feedback {#code-review-feedback} - -**Code review** feedback is posted as review comments on the lines of the code that -changed for each file. - -> Code suggestions are given in a Diff format, which either -> be copied or committed within the pull request with a single click. - -![CodeRabbit- Code Review Feedback](/img/about/ReviewFeedback.png) - -A review status is generated for each commit that is reviewed. It displays the -commit IDs that were reviewed, the files examined and ignored, as well as the -additional comments generated for each review, and so on. - -:::info -Review status is useful for understanding the auxiliary context of the review. -::: - -![CodeRabbit- Review Status](/img/about/ReviewStatus.png) - -### 3. Chat with CodeRabbit {#chat-with-coderabbit} - -- **CodeRabbit** provides conversational capability that allows developers and the - reviewers to ask questions, generate code, and get feedback in the context of - changes. Just comment on the CodeRabbit review to start the conversation. - -- **CodeRabbit** learns from your interactions and gets smarter over time. The more - you chat, the better it gets. - -We support: - -- Inline Comments in Pull Request File Diffs -- Comments in Pull Requests -- Comments in Git Issues - -![Chat with CodeRabbit - Conversation in Pull Requests](/img/about/chat.png) - -### 4. Issue Validation {#issue-validation} - -**Pull request** changes are validated against the linked GitHub or GitLab issue and -identifies all other issues which might be affected by this change. - -![Issue Validation for GitHub/GitLab Issues - CodeRabbit](/img/about/issue-validation.png) - -### 5. Sequence Diagrams {#sequence-diagrams} - -**CodeRabbit** visualizes the changes occuring in any pull request using -[Mermaid Sequence Diagram Example](https://mermaid.live/). - -![Diagram](/img/about/diagram.png) - -![Advanced Sequence Diagram Example - CodeRabbit](/img/about/advanced-diagram.png) - -### 6. Commitable Suggestions {#commitable-suggestions} - -For quick fixes, **CodeRabbit** offers one button solution to commit AI recommended -changes. - -![AI Recommended Suggestions - CodeRabbit](/img/about/committable-suggestion.png) - -![Irony in Committable Suggestions - CodeRabbit](/img/about/ironic-committable.png) - -### 7. [Learnings](/integrations/knowledge-base#learnings) {#learnings} - -- **CodeRabbit** learns from user chat interactions to gain tribal knowledge on your - repositories and organization. -- **CodeRabbit** will apply and update these learnings - in future reviews. - -![Learnings from Interactions - CodeRabbit AI](/img/about/learnings.png) diff --git a/docs/about/pricing.md b/docs/about/pricing.md deleted file mode 100644 index 3e4554cf..00000000 --- a/docs/about/pricing.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: Pricing -sidebar_label: Pricing -description: Learn about the plans, pricing, and subscription management of CodeRabbit. ---- - -Find all the information you need about CodeRabbit's plans and how to manage your monthly bill. - -## Overview - -- **Transparent Pricing**: CodeRabbit offers a per-seat pricing model that - scales with your team size, ensuring you pay for what you need. -- **14-Day Free Trial**: All plans start with a generous 14-day free trial for - CodeRabbit Pro for the entire organization, ensuring a commitment-free - experience -- **No Credit Card Required**: You don't need a credit card to start your free - trial. -- **CodeRabbit Seats** Every developer who submits a pull request is counted as - a separate seat. Seats can be purchased for all or for a limited number of - developers. - ---- - -## Open Source - -:::note -CodeRabbit Pro is free for all Open Source projects. -::: - -- **Price**: $0/month -- Free forever -- No credit card required -- Unlimited public repositories - ---- - -## Lite Plan - -### Features - -- This plan begins with a 14-day free trial, with no credit card required. -- Summarization of pull requests. -- Includes line-by-line reviews of all changes in the Pull Request -- Ability to have conversations with CodeRabbit bot. -- Reviews on unlimited public and private repositories within the organization. - -### Pricing - -- **Monthly**: $15 per month per contributing developer. -- **Annual**: $12 per month, billed annually per contributing developer. - -### Usage Limits - -These are the hourly usage limits for each developer per repository: - -- Number of files reviewed per hour: **150 Files** -- Number of reviews per hour (includes incremental reviews): **8** -- Number of conversations per hour: **50** - ---- - -## Pro Plan - -### Features - -- Everything in Lite, plus: -- Linters and SAST tools support. -- Integrates with Jira & Linear. -- Product analytics dashboards. -- Customizable reports - -### Pricing - -- **Monthly**: $30 per month per contributing developer. -- **Annual**: $24 per month, billed annually per contributing developer. - -### Usage Limits - -These are the hourly usage limits for each developer per repository: - -- Number of files reviewed per hour: **150 Files** -- Number of reviews per hour (includes incremental reviews): **8** -- Number of conversations per hour: **50** - ---- - -## Free Plan - -### Features - -- Starts with a 14-day free trial of the Pro plan. -- Unlimited access for both public and private repositories. -- Summarization pull requests on private repositories. -- Reviews pull requests on public repositories. - -### Pricing - -- Free forever, no credit card required. - ---- - -## Plan Comparison - -| Feature | Free Plan | Lite Plan | Pro Plan | -| ------------------------------ | ------------------------------------ | ----------------- | ----------------- | -| **Free Trial** | Starts with 14-day free trial to Pro | 14-day free trial | 14-day free trial | -| **Public Repos** | Unlimited access | Unlimited access | Unlimited access | -| **Pull Request Summarization** | Included | Included | Included | -| **Private Repos** | Limited access | Limited access | Unlimited access | -| **Line-by-Line Reviews** | Public repos only | All repos | All repos | -| **Conversational Bot** | No | Yes | Yes | -| **Linters and SAST tools** | No | No | Yes | -| **Jira & Linear Integration** | No | No | Yes | -| **ROI Dashboards** | No | No | Yes | -| **Customizable Reports** | No | No | Yes | -| **Price** | Free forever | $15 per seat/mo | $30 per seat/mo | - ---- - -## Subscription Management - -### Pro/Lite Plan - -- GitHub/GitLab/Azure DevOps organization owners can purchase or introduce changes to the - subscription. -- You can promote a non-Git platform user as an admin to administer the subscription. -- You can choose to manually purchase seats and assign them to developers, or - have them assigned automatically as developers create pull requests. -- During the trial period, seat assignment is automatic, but the number of seats - can be adjusted when purchasing the subscription. - -![Seat Management for CodeRabbit Subscription](/img/about/cr_seat_manage_dark.png#gh-dark-mode-only) -![Seat Management for CodeRabbit Subscription](/img/about/cr_seat_manage_light.png#gh-light-mode-only) - -### Free Plan - -- Seats are assigned to new developers immediately - -![Free Plan Seat Assignment - CodeRabbit](/img/about/cr_seat_free_dark.png#gh-dark-mode-only) -![Free Plan Seat Assignment - CodeRabbit](/img/about/cr_seat_free_light.png#gh-light-mode-only) - -:::note -The subscription is limited to human users; bot users are not -supported. Thus, pull requests or merge requests created by bots will not be -reviewed. -::: diff --git a/docs/faq.md b/docs/faq.md index d6659df2..451562f4 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -133,7 +133,7 @@ In-trial and open-source plans have lower rate limits than the paid plan. In all 3. That's it. CodeRabbit will automatically start reviewing your PRs :::tip Need Help? -Visit our [Support](/about/support) page for additional assistance or reach out to our team on [Discord](http://discord.gg/coderabbit). +Visit our [Support](/getting-started/support) page for additional assistance or reach out to our team on [Discord](http://discord.gg/coderabbit). ::: ## Account Management {#account-management} diff --git a/docs/finishing-touches/_category_.yaml b/docs/finishing-touches/_category_.yaml index 8101ddcb..81a96253 100644 --- a/docs/finishing-touches/_category_.yaml +++ b/docs/finishing-touches/_category_.yaml @@ -1,4 +1,4 @@ label: Finishing Touches -position: 12 +position: 8 collapsible: true collapsed: true diff --git a/docs/finishing-touches/docstrings.md b/docs/finishing-touches/docstrings.md index 587db092..06b2bf0b 100644 --- a/docs/finishing-touches/docstrings.md +++ b/docs/finishing-touches/docstrings.md @@ -4,12 +4,20 @@ sidebar_label: Docstrings (Beta) description: Automated docstrings pull requests with CodeRabbit --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + # Docstrings Docstrings generation is part of the [finishing touches](/future-developments#finishing-touches) initiative. -:::warning -The [docstrings](/finishing-touches/docstrings) feature is in [beta](/early-access#beta). +:::info + +This feature is in [beta](/early-access#beta). + ::: ## Usage diff --git a/docs/getting-started/configure-coderabbit.md b/docs/getting-started/configure-coderabbit.md index b0e9d8e6..ce25532b 100644 --- a/docs/getting-started/configure-coderabbit.md +++ b/docs/getting-started/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: 3 +sidebar_position: 2 --- ```mdx-code-block diff --git a/docs/about/support.md b/docs/getting-started/support.md similarity index 99% rename from docs/about/support.md rename to docs/getting-started/support.md index 4e454caf..2014965c 100644 --- a/docs/about/support.md +++ b/docs/getting-started/support.md @@ -2,6 +2,7 @@ title: Support sidebar_label: Support description: Get help with CodeRabbit and find answers to common questions. +sidebar_position: 3 --- Welcome to CodeRabbit Support. Please refer to the following sections for diff --git a/docs/guides/ondemand-reports.md b/docs/guides/ondemand-reports.md index 90c2db2f..ae9bed7c 100644 --- a/docs/guides/ondemand-reports.md +++ b/docs/guides/ondemand-reports.md @@ -1,27 +1,24 @@ --- title: On-demand Reports -sidebar_label: On-demand Reports (Beta) +sidebar_label: On-demand Reports description: CodeRabbit offers a way to generate on-demand reports using a simple API request sidebar_position: 6 --- ```mdx-code-block import ReportSchema from "@site/src/components/ReportSchema"; -``` - -:::info +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; -This feature is in beta - -::: + +``` -CodeRabbit offers a way to generate on-demand reports using the [CodeRabbit API](https://api.coderabbit.ai/api/swagger/). +CodeRabbit offers a way to generate on-demand reports using the [CodeRabbit API](https://api.coderabbit.ai/api/swagger/). You will need an API Key to access the CodeRabbit API and generate an on-demand report. ## Create an API key -Sign in to your CodeRabbit account and navigate to the [**API Keys**](https://app.coderabbit.ai/settings/api-keys) page under 'Organization Settings' in the left sidebar. -Click on the **Create API Key** button and enter a name for the API Key. +Sign in to your CodeRabbit account and navigate to the [**API Keys**](https://app.coderabbit.ai/settings/api-keys) page under 'Organization Settings' in the left sidebar. +Click on the **Create API Key** button and enter a name for the API Key. Copy the API key, and keep it safe as it won't be visible again. ![API Keys](/img/guides/api_keys.png) diff --git a/docs/guides/review-instructions.md b/docs/guides/review-instructions.md index 0c73b291..dfb8ff70 100644 --- a/docs/guides/review-instructions.md +++ b/docs/guides/review-instructions.md @@ -48,6 +48,12 @@ reviews: ## Abstract Syntax Tree (AST) based instructions {#ast-based} +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + CodeRabbit offers review instructions based on Abstract Syntax Tree (AST) patterns. Under the hood, CodeRabbit uses [`ast-grep`](https://ast-grep.github.io) to power this feature. `ast-grep` is diff --git a/docs/integrations/knowledge-base.md b/docs/integrations/knowledge-base.md index b8e4f1d3..1aec8ba4 100644 --- a/docs/integrations/knowledge-base.md +++ b/docs/integrations/knowledge-base.md @@ -13,6 +13,12 @@ The issues knowledge base allows CodeRabbit to use the context from linked and r ### Jira {#jira} +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + #### CodeRabbit App 1. Navigate to [integrations][integrations] in the CodeRabbit app. @@ -26,6 +32,10 @@ Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira log ### Linear {#Linear} +```mdx-code-block + +``` + #### CodeRabbit App 1. Navigate to [integrations][integrations] in the CodeRabbit app. diff --git a/docs/tools/actionlint.md b/docs/tools/actionlint.md index c05171f5..0fa4f628 100644 --- a/docs/tools/actionlint.md +++ b/docs/tools/actionlint.md @@ -4,6 +4,12 @@ sidebar_label: Actionlint description: CodeRabbit's guide to Actionlint. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [Actionlint](https://github.com/rhysd/actionlint/) is a static checker for GitHub Actions workflow files. diff --git a/docs/tools/biome.md b/docs/tools/biome.md index 953debee..be71d385 100644 --- a/docs/tools/biome.md +++ b/docs/tools/biome.md @@ -4,6 +4,12 @@ sidebar_label: Biome description: CodeRabbit's guide to Biome. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [Biome](https://biomejs.dev/) is a linter for JavaScript, TypeScript, JSX, TSX, JSON, JSONC, CSS. ## Files diff --git a/docs/tools/buf.md b/docs/tools/buf.md index 51fbb446..70c2b70e 100644 --- a/docs/tools/buf.md +++ b/docs/tools/buf.md @@ -4,6 +4,12 @@ sidebar_label: Buf description: CodeRabbit's guide to Buf. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [Buf](https://buf.build/) offers linting for Protobuf files. ## Files diff --git a/docs/tools/checkov.md b/docs/tools/checkov.md index 93a7e3d1..a0b14cb7 100644 --- a/docs/tools/checkov.md +++ b/docs/tools/checkov.md @@ -4,6 +4,12 @@ sidebar_label: Checkov description: CodeRabbit's guide to Checkov. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [Checkov](https://www.checkov.io/) is a static code analysis tool for scanning Infrastructure as Code (IaC) files for misconfigurations. ## Files diff --git a/docs/tools/circleci.md b/docs/tools/circleci.md index 89fa0714..ebd2318a 100644 --- a/docs/tools/circleci.md +++ b/docs/tools/circleci.md @@ -4,14 +4,20 @@ sidebar_label: CircleCi description: CodeRabbit's guide to CircleCi. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [CircleCi](https://circleci.com/) is a static checker and validator for circleci config files. ## Files We look for `CircleCi Configuration` files specifically in the following directory: -- `.circleci/config.yml"` -- `.circleci/config.yaml"` +- `.circleci/config.yml` +- `.circleci/config.yaml` ## Configuration diff --git a/docs/tools/cppcheck.md b/docs/tools/cppcheck.md index 105d7bbd..a650ee49 100644 --- a/docs/tools/cppcheck.md +++ b/docs/tools/cppcheck.md @@ -4,6 +4,12 @@ sidebar_label: Cppcheck description: CodeRabbit's guide to Cppcheck. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [Cppcheck](https://cppcheck.sourceforge.io/) is a static code analysis tool for the C and C++ programming languages. ## Files diff --git a/docs/tools/detekt.md b/docs/tools/detekt.md index b52e4ae0..2a504a37 100644 --- a/docs/tools/detekt.md +++ b/docs/tools/detekt.md @@ -4,6 +4,12 @@ sidebar_label: Detekt description: CodeRabbit's guide to Detekt. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [Detekt](https://detekt.dev/) is a static code analysis tool specifically designed for Kotlin projects ## Files diff --git a/docs/tools/eslint.md b/docs/tools/eslint.md index bdf6d9b4..dd10bcf7 100644 --- a/docs/tools/eslint.md +++ b/docs/tools/eslint.md @@ -4,6 +4,12 @@ sidebar_label: ESLint description: CodeRabbit's guide to ESLint. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [ESLint](https://eslint.org/) is a linter for JavaScript, TypeScript, JSX, TSX, CSS, etc. ## Files diff --git a/docs/tools/gitleaks.md b/docs/tools/gitleaks.md index 1e725b06..5e722d84 100644 --- a/docs/tools/gitleaks.md +++ b/docs/tools/gitleaks.md @@ -4,6 +4,12 @@ sidebar_label: Gitleaks description: CodeRabbit's guide to Gitleaks. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [Gitleaks](https://gitleaks.io/) is a secret-scanner. ## Files diff --git a/docs/tools/golangci-lint.md b/docs/tools/golangci-lint.md index 541db7b9..ba140553 100644 --- a/docs/tools/golangci-lint.md +++ b/docs/tools/golangci-lint.md @@ -4,6 +4,12 @@ sidebar_label: golangci-lint description: CodeRabbit's guide to golangci-lint. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [golangci-lint](https://golangci-lint.run/) is a fast Go linters runner. ## Files diff --git a/docs/tools/hadolint.md b/docs/tools/hadolint.md index 044a561d..97c6c661 100644 --- a/docs/tools/hadolint.md +++ b/docs/tools/hadolint.md @@ -4,6 +4,12 @@ sidebar_label: Hadolint description: CodeRabbit's guide to Hadolint. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [Hadolint](https://github.com/hadolint/hadolint) is a Dockerfile linter. ## Files diff --git a/docs/tools/languagetool.md b/docs/tools/languagetool.md index 8ef4a59f..554bf70c 100644 --- a/docs/tools/languagetool.md +++ b/docs/tools/languagetool.md @@ -4,6 +4,12 @@ sidebar_label: LanguageTool description: CodeRabbit's guide to LanguageTool. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [LanguageTool](https://github.com/languagetool-org/languagetool) is a style and grammar checker. ## Files diff --git a/docs/tools/markdownlint.md b/docs/tools/markdownlint.md index 137eb56b..5b741843 100644 --- a/docs/tools/markdownlint.md +++ b/docs/tools/markdownlint.md @@ -4,6 +4,12 @@ sidebar_label: Markdownlint description: CodeRabbit's guide to Markdownlint. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [Markdownlint](https://github.com/DavidAnson/markdownlint) is a linter for Markdown. ## Files diff --git a/docs/tools/phpstan.md b/docs/tools/phpstan.md index a756f4c4..f67485d2 100644 --- a/docs/tools/phpstan.md +++ b/docs/tools/phpstan.md @@ -4,6 +4,12 @@ sidebar_label: PHPStan description: CodeRabbit's guide to PHPStan. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [PHPStan](https://phpstan.org/) is a static analysis tool for PHP. ## Files diff --git a/docs/tools/pmd.md b/docs/tools/pmd.md index 948083d1..31fc7144 100644 --- a/docs/tools/pmd.md +++ b/docs/tools/pmd.md @@ -4,7 +4,13 @@ sidebar_label: PMD description: CodeRabbit's guide to PMD. --- -[PMD](https://pmd.github.io/) is an extensible multilanguage static code analyzer. It’s mainly concerned with Java. +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + +[PMD](https://pmd.github.io/) is an extensible multilanguage static code analyzer. It's mainly concerned with Java. ## Files diff --git a/docs/tools/regal.md b/docs/tools/regal.md index eeca3664..0783ebdd 100644 --- a/docs/tools/regal.md +++ b/docs/tools/regal.md @@ -4,6 +4,12 @@ sidebar_label: Regal description: CodeRabbit's guide to Regal. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [Regal](https://docs.styra.com/regal/) is a linter and language server for Rego. ## Files diff --git a/docs/tools/rubocop.md b/docs/tools/rubocop.md index 4172bea4..9bb68286 100644 --- a/docs/tools/rubocop.md +++ b/docs/tools/rubocop.md @@ -4,6 +4,12 @@ sidebar_label: Rubocop description: CodeRabbit's guide to Rubocop. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [Rubocop](https://rubocop.org/) A Ruby static code analyzer and formatter, based on the community Ruby style guide. ## Files diff --git a/docs/tools/ruff.md b/docs/tools/ruff.md index 255ce816..fe897d7b 100644 --- a/docs/tools/ruff.md +++ b/docs/tools/ruff.md @@ -4,6 +4,12 @@ sidebar_label: Ruff description: CodeRabbit's guide to Ruff. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [Ruff](https://docs.astral.sh/ruff/) is a linter for Python. ## Files diff --git a/docs/tools/semgrep.md b/docs/tools/semgrep.md index 3098082a..0442acfb 100644 --- a/docs/tools/semgrep.md +++ b/docs/tools/semgrep.md @@ -4,6 +4,12 @@ sidebar_label: Semgrep description: CodeRabbit's guide to Semgrep. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [Semgrep](https://semgrep.dev/) is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. diff --git a/docs/tools/shellcheck.md b/docs/tools/shellcheck.md index 752e8675..98e2fbba 100644 --- a/docs/tools/shellcheck.md +++ b/docs/tools/shellcheck.md @@ -4,6 +4,12 @@ sidebar_label: ShellCheck description: CodeRabbit's guide to ShellCheck. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [ShellCheck](https://www.shellcheck.net/) is a linter for shell scripts. ## Files diff --git a/docs/tools/swiftlint.md b/docs/tools/swiftlint.md index 516d99af..c95c2d88 100644 --- a/docs/tools/swiftlint.md +++ b/docs/tools/swiftlint.md @@ -4,6 +4,12 @@ sidebar_label: SwiftLint description: CodeRabbit's guide to SwiftLint. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [SwiftLint](https://realm.github.io/SwiftLint/) is a linter for Swift. ## Files @@ -14,7 +20,7 @@ SwiftLint will run on files with the following extensions: ## Configuration -Ruff supports the following config files: +SwiftLint supports the following config files: - User-defined config file set at `reviews.tools.swiftlint.config_file` in your project's `.coderabbit.yaml` file or setting the "Review β†’ Tools β†’ SwiftLint β†’ Config File" field in CodeRabbit's settings page. - `.swiftlint.yaml` diff --git a/docs/tools/tools.md b/docs/tools/tools.md index 3dce7e93..27313ab9 100644 --- a/docs/tools/tools.md +++ b/docs/tools/tools.md @@ -5,6 +5,12 @@ description: Overview of CodeRabbit's supported linters and security analysis to sidebar_position: 1 --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + CodeRabbit supports various linters and security analysis tools to improve the code review process. The output of these tools is used to enhance the feedback provided by CodeRabbit, making it possible to provide 1-click fixes for common issues. ## Enabling/Disabling Tools diff --git a/docs/tools/yamllint.md b/docs/tools/yamllint.md index 962a2a78..293a4e57 100644 --- a/docs/tools/yamllint.md +++ b/docs/tools/yamllint.md @@ -4,6 +4,12 @@ sidebar_label: Yamllint description: CodeRabbit's guide to Yamllint. --- +```mdx-code-block +import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx'; + + +``` + [Yamllint](https://yamllint.readthedocs.io/en/stable/) is a linter for YAML. ## Files diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 0cc10d8d..affcf507 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -211,7 +211,7 @@ const config: Config = { position: "right", }, { - href: "https://github.com/coderabbitai", + href: "https://github.com/coderabbitai/coderabbit-docs", className: "github-link", "aria-label": "GitHub", position: "right", diff --git a/src/components/ProPlanNotice.mdx b/src/components/ProPlanNotice.mdx new file mode 100644 index 00000000..da4ac0e4 --- /dev/null +++ b/src/components/ProPlanNotice.mdx @@ -0,0 +1,7 @@ +{/* ProPlanNotice.mdx */} + +:::info Pro Plan Feature + +This feature is available exclusively as part of the Pro plan and is not included in the Lite plan. Please refer to our [pricing page](https://www.coderabbit.ai/pricing) for more information about our plans and features. + +:::