Skip to content

Commit e819423

Browse files
Merge branch 'main' into fix/configure-cr-notes
2 parents c8ce049 + 21e967f commit e819423

38 files changed

+195
-265
lines changed

docs/about/_category_.yaml

-4
This file was deleted.

docs/about/features.md

-93
This file was deleted.

docs/about/pricing.md

-146
This file was deleted.

docs/changelog.md

+6
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ description: The latest updates and changes to CodeRabbit.
55
sidebar_position: 13
66
---
77

8+
## December 12, 2024
9+
10+
### Docstrings(Beta)
11+
12+
We have launched a new functionality as part of our finishing touches initiative to allow developers to generate docstrings on a pull request. This feature lets you generate docstrings by commenting `@coderabbitai generate docstrings` on any pull request. This works for both new and existing documentation. See [our documentation](https://docs.coderabbit.ai/finishing-touches/docstrings) for details.
13+
814
## November 25, 2024
915

1016
### Code Review Performance Enhancements with Improved Comment Resolution Logic

docs/faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ In-trial and open-source plans have lower rate limits than the paid plan. In all
133133
3. That's it. CodeRabbit will automatically start reviewing your PRs
134134

135135
:::tip Need Help?
136-
Visit our [Support](/about/support) page for additional assistance or reach out to our team on [Discord](http://discord.gg/coderabbit).
136+
Visit our [Support](/getting-started/support) page for additional assistance or reach out to our team on [Discord](http://discord.gg/coderabbit).
137137
:::
138138

139139
## Account Management {#account-management}
+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
label: Finishing Touches
2-
position: 12
2+
position: 8
33
collapsible: true
44
collapsed: true

docs/finishing-touches/docstrings.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,20 @@ sidebar_label: Docstrings (Beta)
44
description: Automated docstrings pull requests with CodeRabbit
55
---
66

7+
```mdx-code-block
8+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
9+
10+
<ProPlanNotice />
11+
```
12+
713
# Docstrings
814

915
Docstrings generation is part of the [finishing touches](/future-developments#finishing-touches) initiative.
1016

11-
:::warning
12-
The [docstrings](/finishing-touches/docstrings) feature is in [beta](/early-access#beta).
17+
:::info
18+
19+
This feature is in [beta](/early-access#beta).
20+
1321
:::
1422

1523
## Usage
@@ -60,7 +68,7 @@ The checked languages are supported:
6068
- [ ] Php
6169
- [x] Python
6270
- [ ] React TypeScript
63-
- [ ] Ruby
71+
- [x] Ruby
6472
- [ ] Rust
6573
- [ ] Scala
6674
- [ ] Swift

docs/getting-started/configure-coderabbit.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description:
55
CodeRabbit offers various configuration options to tailor the reviews to your
66
specific requirements. Configuration can be made using one of the below
77
options.
8-
sidebar_position: 3
8+
sidebar_position: 2
99
---
1010

1111
```mdx-code-block

docs/about/support.md renamed to docs/getting-started/support.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: Support
33
sidebar_label: Support
44
description: Get help with CodeRabbit and find answers to common questions.
5+
sidebar_position: 3
56
---
67

78
Welcome to CodeRabbit Support. Please refer to the following sections for

docs/guides/ondemand-reports.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,24 @@
11
---
22
title: On-demand Reports
3-
sidebar_label: On-demand Reports (Beta)
3+
sidebar_label: On-demand Reports
44
description: CodeRabbit offers a way to generate on-demand reports using a simple API request
55
sidebar_position: 6
66
---
77

88
```mdx-code-block
99
import ReportSchema from "@site/src/components/ReportSchema";
10-
```
11-
12-
:::info
10+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1311
14-
This feature is in beta
15-
16-
:::
12+
<ProPlanNotice />
13+
```
1714

18-
CodeRabbit offers a way to generate on-demand reports using the [CodeRabbit API](https://api.coderabbit.ai/api/swagger/).
15+
CodeRabbit offers a way to generate on-demand reports using the [CodeRabbit API](https://api.coderabbit.ai/api/swagger/).
1916
You will need an API Key to access the CodeRabbit API and generate an on-demand report.
2017

2118
## Create an API key
2219

23-
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.
24-
Click on the **Create API Key** button and enter a name for the API Key.
20+
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.
21+
Click on the **Create API Key** button and enter a name for the API Key.
2522
Copy the API key, and keep it safe as it won't be visible again.
2623

2724
![API Keys](/img/guides/api_keys.png)

docs/guides/review-instructions.md

+6
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ reviews:
4848
4949
## Abstract Syntax Tree (AST) based instructions {#ast-based}
5050
51+
```mdx-code-block
52+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
53+
54+
<ProPlanNotice />
55+
```
56+
5157
CodeRabbit offers review instructions based on Abstract Syntax Tree (AST)
5258
patterns. Under the hood, CodeRabbit uses
5359
[`ast-grep`](https://ast-grep.github.io) to power this feature. `ast-grep` is

docs/integrations/knowledge-base.md

+10
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ The issues knowledge base allows CodeRabbit to use the context from linked and r
1313

1414
### Jira {#jira}
1515

16+
```mdx-code-block
17+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
18+
19+
<ProPlanNotice />
20+
```
21+
1622
#### CodeRabbit App
1723

1824
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
2632

2733
### Linear {#Linear}
2834

35+
```mdx-code-block
36+
<ProPlanNotice />
37+
```
38+
2939
#### CodeRabbit App
3040

3141
1. Navigate to [integrations][integrations] in the CodeRabbit app.

0 commit comments

Comments
 (0)