Merge branch 'main' into patch-1

Author: harjotgill

docs/changelog.md

@@ -5,6 +5,14 @@ description: The latest updates and changes to CodeRabbit.
 sidebar_position: 13
 ---
 
+## January 13, 2025
+
+### GitLab Pipeline Failure Detection and Remediation
+
+We've expanded our pipeline error detection capabilities to GitLab Users! Just like with GitHub Actions, you can now automatically detect and fix pipeline failures in your GitLab CI/CD workflows.
+
+---
+
 ## January 2, 2025
 
 ### GitHub Action Failure Detection and Remediation

docs/faq.md

@@ -124,12 +124,12 @@ In-trial and open-source plans have lower rate limits than the paid plan. In all
 
 The following limits enforced _per developer_:
 
-| Feature          | Free Plan                                  | Trial Plan                    | OSS Plan                      | Pro/Lite Plan                 |
-| ---------------- | ------------------------------------------ | ----------------------------- | ----------------------------- | ----------------------------- |
-| Files per hour   | 200/hour                                   | 150/hour                      | 150/hour                      | 300/hour                      |
-| Files per PR     | 125                                        | 75                            | 75                            | 150                           |
-| Reviews per hour | 3 back-to-back, then 3/hour (Summary only) | 3 back-to-back, then 2/hour   | 2 back-to-back, then 2/hour   | 4 back-to-back, then 4/hour   |
-| Chat             | N/A                                        | 25 back-to-back, then 50/hour | 10 back-to-back, then 25/hour | 25 back-to-back, then 50/hour |
+| Feature          | Free Plan                                  | Trial Plan                    | OSS Plan                      | Lite Plan                     | Pro Plan                      |
+| ---------------- | ------------------------------------------ | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
+| Files per hour   | 200/hour                                   | 150/hour                      | 150/hour                      | 300/hour                      | 300/hour                      |
+| Files per PR     | 125                                        | 75                            | 75                            | 150                           | 150                           |
+| Reviews per hour | 3 back-to-back, then 3/hour (Summary only) | 3 back-to-back, then 2/hour   | 2 back-to-back, then 2/hour   | 4 back-to-back, then 4/hour   | 8 back-to-back, then 8/hour   |
+| Chat             | N/A                                        | 25 back-to-back, then 50/hour | 10 back-to-back, then 25/hour | 25 back-to-back, then 50/hour | 25 back-to-back, then 50/hour |
 
 ## Integration Guide {#integration-guide}
 

docs/finishing-touches/docstrings.md

@@ -54,28 +54,28 @@ The presence of an unsupported software forge in this list does not constitute a
 
 The checked languages are supported:
 
-- [ ] Bash
-- [ ] C
+- [x] Bash
+- [x] C
 - [x] C++
-- [ ] C#
+- [x] C#
 - [x] Elixir
 - [x] Go
 - [ ] Haskell
 - [x] Java
 - [x] JavaScript
-- [ ] Kotlin
-- [ ] Lua
-- [ ] Php
+- [x] Kotlin
+- [x] Lua
+- [x] Php
 - [x] Python
-- [ ] React TypeScript
+- [x] React TypeScript
 - [x] Ruby
-- [ ] Rust
+- [x] Rust
 - [ ] Scala
-- [ ] Swift
+- [x] Swift
 - [x] TypeScript
 
 The presence of an unsupported language in this list does not constitute a commitment to support it in the future. Remember that the docstrings feature is in [beta](/early-access#beta).
 
 :::note
-In the case of JavaScript and TypeScript, there are tons of ways to declare functions. At the moment, we only support the keyword `function` at the top level.
+In the case of JavaScript and TypeScript and the React versions of both, there are tons of ways to declare functions. At the moment, we only support the keyword `function` at the top level.
 :::

docs/getting-started/adding-organizations.md

@@ -0,0 +1,25 @@
+---
+title: Adding Organizations
+description: Learn how to add new organizations to CodeRabbit
+sidebar_label: Adding Organizations
+sidebar_position: 5
+---
+
+To add new organizations to CodeRabbit, follow these steps:
+
+1. Navigate to [coderabbit.ai](https://coderabbit.ai)
+2. Click the "Refresh" button next to your organizations list to check for new organizations
+3. Find the organization you want to add in the list
+4. Click the "Grant" button next to the organization name
+
+![Checking for new organizations](../../static/img/getting-started/check-for-new-orgs.png)
+
+![Granting permission to organization](../../static/img/getting-started/grant-permission.png)
+
+This will grant CodeRabbit access to the selected organization, allowing it to:
+
+- Read organization and team membership
+- Read organization projects
+- Access user email addresses (read-only)
+
+> Note: Organizations control which applications are allowed to access their private data. You may need organization admin approval to complete this process.

docs/guides/commands.md

@@ -1,24 +1,83 @@
----
-title: CodeRabbit Commands
-sidebar_label: CodeRabbit Commands
-description:
-  CodeRabbit offers various commands that can be invoked as PR comments to
-  control the review process.
-sidebar_position: 4
----
-
-The following commands are available (invoked as PR comments):
-
-- `@coderabbitai pause` to pause the reviews on a PR.
-- `@coderabbitai resume` to resume the paused reviews.
-- `@coderabbitai ignore` to ignore the reviews on a PR.
-- `@coderabbitai review` to trigger an incremental review. This is useful when
-  automatic reviews are disabled for the repository.
-- `@coderabbitai full review` to do a full review from scratch and review all
-  the files again.
-- `@coderabbitai summary` to regenerate the summary of the PR.
-- `@coderabbitai resolve` resolve all the CodeRabbit review comments.
-- `@coderabbitai configuration` to show the current CodeRabbit configuration for
-  the repository.
-- `@coderabbitai help` to get help.
-- `@coderabbitai generate docstrings` to generate docstrings for functions in the PR. Learn more about [docstrings generation](/finishing-touches/docstrings).
+# CodeRabbit Commands
+
+> Control your code reviews directly from pull request comments using CodeRabbit's command system. Each command starts with `@coderabbitai` followed by the specific action you want to take.
+
+## Review Control Commands
+
+### Managing Reviews
+
+| Command                     | Description                                          | Use Case                                                                     |
+| --------------------------- | ---------------------------------------------------- | ---------------------------------------------------------------------------- |
+| `@coderabbitai review`      | Triggers an incremental review of new changes        | When automatic reviews are disabled or you want to manually trigger a review |
+| `@coderabbitai full review` | Performs a complete review of all files from scratch | When you want to get fresh insights on the entire PR                         |
+| `@coderabbitai summary`     | Regenerates the PR summary                           | When you want an updated overview after making changes                       |
+
+### Review Flow Control
+
+| Command                | Description                              | Use Case                                            |
+| ---------------------- | ---------------------------------------- | --------------------------------------------------- |
+| `@coderabbitai pause`  | Temporarily stops reviews on the PR      | When you're making multiple rapid changes           |
+| `@coderabbitai resume` | Restarts reviews after a pause           | When you're ready for CodeRabbit to review again    |
+| `@coderabbitai ignore` | Permanently disables reviews for this PR | When you want to handle the review process manually |
+
+### Comment Management
+
+| Command                 | Description                             | Use Case                                                |
+| ----------------------- | --------------------------------------- | ------------------------------------------------------- |
+| `@coderabbitai resolve` | Resolves all CodeRabbit review comments | When you've addressed all feedback and want to clean up |
+
+### Documentation Commands
+
+| Command                             | Description                                  | Use Case                                            |
+| ----------------------------------- | -------------------------------------------- | --------------------------------------------------- |
+| `@coderabbitai generate docstrings` | Generates docstrings for functions in the PR | When you need automatic documentation for your code |
+| `@coderabbitai configuration`       | Shows current CodeRabbit settings            | When you need to check or export your configuration |
+
+### Help & Support
+
+| Command              | Description                                | Use Case                                   |
+| -------------------- | ------------------------------------------ | ------------------------------------------ |
+| `@coderabbitai help` | Displays available commands and usage info | When you need guidance on using CodeRabbit |
+
+## Best Practices
+
+### Review Workflow
+
+- Start with `@coderabbitai review` for checking new changes
+- Use `@coderabbitai full review` when major changes require a fresh perspective
+- Generate summaries after significant updates using `@coderabbitai summary`
+
+### Managing Large Changes
+
+- Use `@coderabbitai pause` before making multiple commits
+- Resume reviews with `@coderabbitai resume` when ready
+- Consider `@coderabbitai full review` after substantial changes
+
+### Documentation Flow
+
+- Run `@coderabbitai generate docstrings` after finalizing function implementations
+- Learn more about [docstring generation](/finishing-touches/docstrings)
+
+## Tips
+
+- Commands are case-insensitive (`@coderabbitai REVIEW` works the same as `@coderabbitai review`)
+- Commands can be issued by anyone with write access to the repository
+- Multiple commands can be used in sequence as needed
+- Use `@coderabbitai configuration` to export your settings before making changes
+
+## Command Response Time
+
+- Most commands (pause, resume, ignore) take effect immediately
+- Review commands typically complete within a few minutes, depending on PR size
+- Docstring generation time varies based on the number of functions
+
+## Troubleshooting
+
+If a command doesn't seem to work:
+
+1. Check that you have the necessary repository permissions
+2. Verify the command syntax
+3. Look for any response from CodeRabbit in the PR comments
+4. Use `@coderabbitai help` for command guidance
+
+Need help? Join our community on [Discord](https://discord.gg/coderabbit) or contact our support team.

docs/integrations/issue-integrations.md

@@ -0,0 +1,46 @@
+---
+title: Issue Integrations
+description: Learn about CodeRabbit's integrations with issue tracking systems like Jira and Linear.
+sidebar_label: Issue Integrations
+sidebar_position: 5
+---
+
+CodeRabbit integrates with popular issue tracking systems to provide context from linked and related issues while reviewing code.
+
+## Jira {#jira}
+
+```mdx-code-block
+import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
+
+<ProPlanNotice />
+```
+
+### CodeRabbit App
+
+1. Navigate to [integrations][integrations] in the CodeRabbit app.
+2. Toggle the Jira switch to enable the integration.
+
+Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira login page. Enter your Jira credentials to authenticate the integration.
+
+### CodeRabbit Configuration
+
+1. Add Jira's Project Keys to the `knowledge_base.jira.project_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`.
+
+## Linear {#Linear}
+
+```mdx-code-block
+<ProPlanNotice />
+```
+
+### CodeRabbit App
+
+1. Navigate to [integrations][integrations] in the CodeRabbit app.
+2. Toggle the Linear switch to enable the integration.
+
+Upon enabling the Linear integration, CodeRabbit will redirect you to the Linear login page. Enter your Linear credentials to authenticate the integration.
+
+### CodeRabbit Configuration
+
+1. Add Linear's Team Keys to the `knowledge_base.linear.team_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`.
+
+[integrations]: https://app.coderabbit.ai/integrations

docs/integrations/knowledge-base.md

@@ -7,78 +7,20 @@ sidebar_position: 4
 
 CodeRabbit utilizes an internal knowledge base that integrates with several external services to provide a seamless review and issue management experience.
 
-## Issues
+## Issue Tracking Integration
 
-The issues knowledge base allows CodeRabbit to use the context from linked and related issues while reviewing the code.
-
-### Jira {#jira}
-
-```mdx-code-block
-import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
-
-<ProPlanNotice />
-```
-
-#### CodeRabbit App
-
-1. Navigate to [integrations][integrations] in the CodeRabbit app.
-2. Toggle the Jira switch to enable the integration.
-
-Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira login page. Enter your Jira credentials to authenticate the integration.
-
-#### CodeRabbit Configuration
-
-1. Add Jira's Project Keys to the `knowledge_base.jira.project_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`.
-
-### Linear {#Linear}
-
-```mdx-code-block
-<ProPlanNotice />
-```
-
-#### CodeRabbit App
-
-1. Navigate to [integrations][integrations] in the CodeRabbit app.
-2. Toggle the Linear switch to enable the integration.
-
-Upon enabling the Linear integration, CodeRabbit will redirect you to the Linear login page. Enter your Linear credentials to authenticate the integration.
-
-#### CodeRabbit Configuration
-
-1. Add Linear's Team Keys to the `knowledge_base.linear.team_keys` field in your project's CodeRabbit configuration file at `.coderabbit.yaml`.
-
-[integrations]: https://app.coderabbit.ai/integrations
+CodeRabbit can integrate with your issue tracking systems to provide better context during code reviews. For details on setting up issue tracking integrations, see our [Issue Integrations](./issue-integrations.md) guide.
 
 ## Learnings {#learnings}
 
 You can tell the bot to remember things about either specific lines in files, or generally about the entire repository, or even across repositories.
 
-For example you can add a comment in a PR to chat directly with CodeRabbit. `@coderabbitai always remember to enforce camelCase`.
+For example, you can add a comment in a PR to chat directly with CodeRabbit. `@coderabbitai always remember to enforce camelCase`.
 
 Or you can comment directly on some lines of code in the PR. `@coderabbitai do not complain about lack of error handling here, it is handled higher up the execution stack.`
 
 :::tip Video Tutorial
-Watch our [video walkthrough on learnings](https://www.youtube.com/watch?v=Yu0cmmOYA-U) for more information.
-:::
-
-## Self-hosted knowledge base {#self-hosted}
-
-For self-hosted / on-premises deployments, you can enable the knowledge base features by setting `SELF_HOSTED_KNOWLEDGE_BASE=true` in the environment variables for your self-hosted docker image.
 
-You must also be running ChromaDB. Use image `chromadb/chroma:0.5.20`. In your CodeRabbit docker image environment variables, set `CHROMADB_URL` to point to the hostname where ChromaDB can be reached. For persistance of your ChromaDB data, mount `/chroma/chroma` in the container to a volume mount. For more information on ChromaDB docker deployment, including how to set up authentication, refer to the [official documentation](https://docs.trychroma.com/deployment/docker). CodeRabbit will use `CHROMA_CLIENT_AUTH_CREDENTIALS` if it is set.
-
-By default, CodeRabbit will store its data in the `coderabbitai/data` branch, unless you set a value for `SELF_HOSTED_KNOWLEDGE_BASE_BRANCH=<branch_name>`.
-
-### Walkthrough
-
-- Set up a ChromaDB service on your cloud provider of choice. There is extensive documentation for generic Docker deploys, as well as cloud native deployments, in the [official Chroma documentation](https://docs.trychroma.com/deployment)
-- Configure your environment variables for your CodeRabbit self-hosted deploy to be able to access Chroma. Documentation is available for [GitHub](/self-hosted/github#prepare-an-env-file).
-- Restart your CodeRabbit service so it has access to the new environment variable settings.
-- Create a new PR in your SCM platform.
-- Add a comment to the PR to tell CodeRabbit to remember something.
-
-`@coderabbitai always make sure to enforce camelCase`
+Watch our [video walkthrough on learnings](https://www.youtube.com/watch?v=Yu0cmmOYA-U) for more information.
 
-- CodeRabbit should respond that it has added a learning.
-- Check out the branch called `coderabbit/data` in the repository (or whatever branch name you have set for `SELF_HOSTED_KNOWLEDGE_BASE_BRANCH`). It should contain a file called learnings.json with an entry containing what you told it to remember.
-- Future PRs should utilize the contents of this learnings file. Congratulations! You have configured the CodeRabbit Self-hosted knowledge base.
+:::

docs/overview/why-coderabbit.md

@@ -348,7 +348,7 @@ CodeRabbit is built for production environments with:
 
 ### Three Steps to Better Code Reviews
 
-1. **Sign in** with [GitHub](/platforms/github-com), [GitLab](/platforms/gitlab-com), or [Azure DevOps](/platforms/azure-devops)
+1. **Sign in** with [GitHub](../platforms/github-com.md), [GitLab](../platforms/gitlab-com.mdx), or [Azure DevOps](../platforms/azure-devops.md)
 2. Select and add repositories in CodeRabbit dashboard
 3. That's it. You're good to go.