Merge branch 'main' into feature/issue/160

alexcoderabbitai · web-flow · commit fde0147cb413 · 2025-06-06T13:20:36.000-04:00
diff --git a/README.md b/README.md
@@ -37,20 +37,25 @@ Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the co
 
 ## Getting Started
 
-1. Clone this repository:
+1. Make sure that you have the following prerequisites installed:
+
+   - [Node.js](https://nodejs.org/)
+   - [pnpm](https://pnpm.io/installation)
+
+2. Clone this repository:
 
    ```sh
    git clone https://github.com/coderabbit-ai/coderabbit-docs.git
    cd coderabbit-docs
    ```
 
-2. Install dependencies:
+3. Install Node.js dependencies using `pnpm`:
 
    ```sh
    pnpm install
    ```
 
-3. Start the development server:
+4. Start the development server:
 
    ```sh
    pnpm start
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -5,13 +5,15 @@ description: The latest updates and changes to CodeRabbit.
 sidebar_position: 13
 ---
 
-### May 30, 2025
+## June 5, 2025
 
-#### New Static Analysis Tool
+### Enhanced Static Analysis: Dotenv Linter and Pylint Support
 
-We're excited to announce that [Pylint](https://github.com/PyCQA/pylint) is now supported on CodeRabbit!
+We're excited to announce that two new static analysis tools are now supported on CodeRabbit!
 
-- **Pylint**: A widely used static analysis and code quality tool for Python. It checks for errors, enforces a coding standard, and looks for code smells in your Python codebase by analyzing Python files.
+- [Dotenv Linter](https://github.com/dotenv-linter/dotenv-linter) is a fast, opinionated linter for `.env` files that helps prevent misconfigurations by detecting typos, invalid syntax, and duplicated keys.
+
+- [Pylint](https://github.com/PyCQA/pylint) is a widely used static analysis and code quality tool for Python. It checks for errors, enforces coding standards, and looks for code smells in your Python codebase.
 
 ## May 25, 2025
 
diff --git a/docs/finishing-touches/docstrings.md b/docs/finishing-touches/docstrings.md
@@ -50,36 +50,32 @@ code_generation:
 
 These software forges are supported:
 
-- [x] Azure DevOps
-- [ ] Bitbucket Cloud
-- [ ] Bitbucket Data Center
-- [x] GitHub
-- [x] GitLab
+- Azure DevOps
+- GitHub
+- GitLab
 
 While Bitbucket is not officially supported, docstrings can still be generated. However, they will be posted in a comment under the pull request. Full support for Bitbucket is planned.
 
 ## Supported languages
 
 These languages are supported:
 
-- [x] Bash
-- [x] C
-- [x] C#
-- [x] C++
-- [x] Elixir
-- [x] Go
-- [ ] Haskell
-- [x] Java
-- [x] JavaScript
-- [x] Kotlin
-- [x] Lua
-- [x] Php
-- [x] Python
-- [x] React TypeScript
-- [x] Ruby
-- [x] Rust
-- [ ] Scala
-- [x] Swift
-- [x] TypeScript
+- Bash
+- C
+- C#
+- C++
+- Elixir
+- Go
+- Java
+- JavaScript
+- Kotlin
+- Lua
+- Php
+- Python
+- React TypeScript
+- Ruby
+- Rust
+- Swift
+- TypeScript
 
 CodeRabbit uses `ast-grep` to parse the code. If you want a new language to be supported, please look into [Add New Language to ast-grep](https://ast-grep.github.io/contributing/add-lang.html#add-new-language-to-ast-grep) first.
diff --git a/docs/guides/code-review-best-practices.md b/docs/guides/code-review-best-practices.md
@@ -1,7 +1,7 @@
 ---
 title: Code review best practices
 description: Best practices for managing CodeRabbit code reviews.
-sidebar_label: Best practices
+sidebar_label: Code reviews
 ---
 
 This page lists best practices for performing code reviews with CodeRabbit.
diff --git a/docs/guides/setup-best-practices.md b/docs/guides/setup-best-practices.md
@@ -0,0 +1,133 @@
+---
+title: "Setup and configuration best practices"
+description: Best practices for seting up CodeRabbit.
+sidebar_label: Setup and configuration
+---
+
+This page contains our best-practice advice for setting up CodeRabbit, and then
+configuring its code review behavior.
+
+## Setup best practices {#setup}
+
+This section lists our recommendations for setting up CodeRabbit with your
+Git platform, and integrating CodeRabbit with other tools and services.
+
+### Give CodeRabbit its own user account {#user}
+
+CodeRabbit works best when it has a user account all to itself on your Git platform.
+Your team treats this account as a bot or service account—even on platforms that don't
+have a formal concept of separate service accounts, such as Bitbucket Cloud.
+
+If you use GitHub, then CodeRabbit sets up a service account named `CoderabbitAI` for you as soon as you connect your GitHub organization to CodeRabbit. On other platforms, such as Bitbucket Cloud or Gitlab, you must set this account up yourself.
+
+For platform-specific instructions about setting up this user, see
+[Integrate with Git platforms](/platforms/).
+
+### Let CodeRabbit read your issue tracker {#issues}
+
+CodeRabbit can report on whether the changes proposed by a pull request
+successfully address specific, ticketed issues referenced by that pull request.
+
+For this to work, CodeRabbit needs read access to your team's issue management system.
+
+If you use the built-in issue management of either GitHub or GitLab, then
+CodeRabbit issue integration works without any further setup.
+
+If you use issue management systems external from your Git platform, then you need to
+take additional steps to integrate CodeRabbit with your team's issues.
+
+These are the external issue management systems that CodeRabbit supports:
+
+- Jira
+- Linear
+
+For more information, see [Integrate issue tracking](/integrations/issue-integrations/).
+
+### Set up basic reports for your team {#reports}
+
+CodeRabbit has a flexible reporting feature that can help keep your whole team
+up-to-date about the latest changes to your repositories. We recommend setting
+up at least the following scheduled reports, using templates available
+through the CodeRabbit web interface:
+
+- A daily standup report, grouped by contributor.
+- Regular release notes, grouped by repository.
+
+For more information, see [Generate reports](/guides/reports-overview).
+
+## Configuration best practices {#configuration}
+
+This section lists our recommendations for configuring the way that CodeRabbit
+works with your individual repositories.
+
+### Fine-tune reviews using YAML files {#yaml}
+
+CodeRabbit gives you two ways to configure how it works with your team's repositories:
+
+- The [Repositories](https://app.coderabbit.ai/settings/repositories) page of the
+  Dashboard
+- A [`coderabbit.yaml` file](/getting-started/configure-coderabbit/) in your repository
+
+The graphical UI of the Repositories page lets you set up your per-repository
+preferences more rapidly, and can help you get familiar with CodeRabbit configuration options.
+
+Once you are ready to fine-tune the ways that CodeRabbit works with your repositories,
+we recommend adding a `coderabbit.yaml` file to each one. This file has several
+advantages over using only the Dashboard:
+
+- It applies version control to your repository's CodeRabbit settings.
+- During code reviews, CodeRabbit loads the file along with rest of your repository. This means that you can include setting changes as part of a pull request, and CodeRabbit both analyzes and applies these settings during its review.
+- The file makes the repository's CodeRabbit settings transparent to all of the repository's contributors.
+
+Repository-level settings defined by a `coderabbit.yaml` take precedence over the
+settings defined for that repository in the Dashboard.
+
+For more information, see [Add a configuration file](/getting-started/configure-coderabbit/).
+
+### Speed up reviews by adding path filters {#filters}
+
+If your repository contains a lot of data or other content that CodeRabbit
+doesn't need for code review context, then you can include _path filters_ in
+your repository configuration. For example, a filter of `!dist/**` tells CodeRabbit
+to disregard everything in your reposistory's top-level `dist` directory when
+preparing a code review.
+
+Reducing the number of contextual files that CodeRabbit needs to read and analyze
+when preparing a code review can help make its code reviews faster.
+
+You can define path filters using the CodeRabbit
+web interface, or with [a configuration file](/getting-started/configure-coderabbit/).
+
+### Trust the defaults {#defaults}
+
+CodeRabbit gives you control over a number of its core code-review features, letting you deactivate them entirely for your repositories if needed. We have chosen the default settings to meet the needs of most organizations and situations, and recommend leaving these settings at their default values if possible:
+
+- **Cache**: Keep [the cache](/reference/caching) enabled to let CodeRabbit temporarily remember details about your repository
+  between reviews, which improves review speed.
+- **Tools**: By default, CodeRabbit is allowed to use all of the [open-source linters and analyzer
+  tools](/tools) that are available to it during code reviews. This helps CodeRabbit keep its reviews broad and flexible.
+- **Knowledge base**: CodeRabbit [knowledge base](/integrations/knowledge-base/) features, including learnings and issue tracking, can require data retention. If your organization needs to meet stricter data-retention policies, then you can opt out of using these features.
+
+You can configure your use of the above features using the CodeRabbit web interface, or [a configuration file](/getting-started/configure-coderabbit/).
+
+### Write specific CI/CD error messages {#pipeline}
+
+CodeRabbit can analyze the logs of continuous integration (CI) or continuous
+deployment (CD) tools in your pipeline. CodeRabbit can provide better remediation
+advice about CI/CD failures during code reviews if your tools' error messages
+are as specific as possible when reporting failures.
+
+For CodeRabbit to provide the best advice, configure your CI/CD failure output to include the following information:
+
+- File names associated with the failure.
+- Line numbers that identify where the failure occurred in those files.
+- An explanation of the failure, including relevant error codes or diffs.
+
+[This pull request](https://github.com/ff14-advanced-market-search/temp-fe/pull/47/files) shows an example of expanding the context of a CI error,
+in this case including a diff to show why a code-formatter check failed.
+
+---
+
+## What's next {#whats-next}
+
+- [Code review best practices](/guides/code-review-best-practices)
diff --git a/docs/platforms/bitbucket-cloud.md b/docs/platforms/bitbucket-cloud.md
@@ -19,7 +19,8 @@ To enable CodeRabbit to interact with your Bitbucket repositories, an app passwo
 
 1. Create a new Bitbucket account specifically for CodeRabbit and treat it as a service account.
 2. Name the account "CodeRabbit".
-3. Generate an App Password to enable seamless integration between CodeRabbit and your Bitbucket repositories.
+3. If your Bitbucket workspace requires two-step verification, then you must also enable two-step verification on this new account.
+4. Generate an App Password to enable seamless integration between CodeRabbit and your Bitbucket repositories.
 
 We recommend creating a new user as a service account, associating this user to the workspace you'd like to install CodeRabbit on, and providing CodeRabbit with the app password to allow access. During the installation process, CodeRabbit will automatically configure the required webhook for seamless integration.
 
diff --git a/docs/tools/dotenv.md b/docs/tools/dotenv.md
@@ -0,0 +1,33 @@
+---
+title: Dotenv Linter
+sidebar_label: Dotenv Linter
+description: CodeRabbit's guide to Dotenv Linter.
+---
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+<ProPlanNotice />
+```
+
+[Dotenv Linter](https://github.com/dotenv-linter/dotenv-linter) is a lightning-fast linter for `.env` files. It helps ensure your environment files are consistent, typo-free, and follow best practices.
+
+:::note
+
+Dotenv Linter does not require configuration to run and automatically anlysises `.env` files. If no configuration file is found, it will use default settings.
+
+:::
+
+## Features
+
+Dotenv Linter can detect:
+
+- Key duplication
+- Missing values
+- Incorrect formatting
+- Invalid characters
+- And many more issues
+
+## Links
+
+- [Dotenv Linter GitHub Repository](https://github.com/dotenv-linter/dotenv-linter)
diff --git a/docs/tools/list.md b/docs/tools/list.md
@@ -18,6 +18,7 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
 | Cppcheck                    | [Cppcheck][Cppcheck]                                       | Code Quality                                        |
 | CSS                         | [Biome][Biome]                                             | Code Quality                                        |
 | Docker                      | [Hadolint][Hadolint], [Checkov][Checkov]                   | Code Quality, Code Security                         |
+| Environment Files (.env)    | [Dotenv Linter][DotenvLinter]                              | Code Quality                                        |
 | GitHub Actions              | [actionlint][actionlint], [Pipeline Remediation][Pipeline] | Code Quality, CI/CD Failure Remediation             |
 | GitLab Pipelines            | [Pipeline Remediation][Pipeline]                           | CI/CD Failure Remediation                           |
 | Go                          | [golangci-lint][golangci-lint]                             | Code Quality                                        |
@@ -78,3 +79,4 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
 [Brakeman]: /tools/brakeman.md
 [Clippy]: /tools/clippy.md
 [Pylint]: /tools/pylint.md
+[DotenvLinter]: /tools/dotenv.md
diff --git a/sidebars.ts b/sidebars.ts
@@ -87,7 +87,6 @@ const sidebars: SidebarsConfig = {
 				"guides/code-review-overview",
 				"guides/commands",
 				"guides/generate-improvements",
-				"guides/code-review-best-practices",
 				"guides/code-review-troubleshooting",
 				"guides/agent_chat",
 				{
@@ -135,6 +134,15 @@ const sidebars: SidebarsConfig = {
 				"guides/custom-reports",
 			],
 		},
+		{
+			type: "category",
+			collapsed: true,
+			label: "Best practices",
+			items: [
+				"guides/setup-best-practices",
+				"guides/code-review-best-practices",
+			],
+		},
 		{
 			type: "category",
 			collapsed: true,
diff --git a/src/css/custom.css b/src/css/custom.css
@@ -293,3 +293,8 @@ a[docid="docs"] > svg {
 		display: none;
 	}
 }
+
+/* Disable automatic next/previous pagination links */
+.pagination-nav {
+	display: none;
+}
diff --git a/static/schema/schema.v2.json b/static/schema/schema.v2.json
@@ -895,6 +895,19 @@
 									"additionalProperties": false,
 									"default": {},
 									"description": "Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications. | v7.0.2"
+								},
+								"dotenvLint": {
+									"type": "object",
+									"properties": {
+										"enabled": {
+											"type": "boolean",
+											"default": true,
+											"description": "Enable dotenv-linter | dotenv-linter is a tool for checking and fixing .env files for problems and best practices | v3.3.0"
+										}
+									},
+									"additionalProperties": false,
+									"default": {},
+									"description": "dotenv-linter is a tool for checking and fixing .env files for problems and best practices"
 								}
 							},
 							"additionalProperties": false,

Original file line number	Diff line number	Diff line change
`@@ -293,3 +293,8 @@ a[docid="docs"] > svg {`
`293`	`293`	`display: none;`
`294`	`294`	`}`
`295`	`295`	`}`
	`296`	`+`
	`297`	`+/* Disable automatic next/previous pagination links */`
	`298`	`+.pagination-nav {`
	`299`	`+ display: none;`
	`300`	`+}`