Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

add admonitions for the pro plan#173

Merged
harjotgill merged 5 commits intomainfrompro_plan
Dec 13, 2024
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletionsdocs/about/_category_.yaml
View file
Open in desktop

This file was deleted.

93 changes: 0 additions & 93 deletionsdocs/about/features.md
View file
Open in desktop

This file was deleted.

146 changes: 0 additions & 146 deletionsdocs/about/pricing.md
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletiondocs/faq.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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}
Expand Down
2 changes: 1 addition & 1 deletiondocs/finishing-touches/_category_.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
label: Finishing Touches
position:12
position:8
collapsible: true
collapsed: true
12 changes: 10 additions & 2 deletionsdocs/finishing-touches/docstrings.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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';

<ProPlanNotice />
```

# 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
Expand Down
2 changes: 1 addition & 1 deletiondocs/getting-started/configure-coderabbit.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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
Expand Down
17 changes: 7 additions & 10 deletionsdocs/guides/ondemand-reports.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -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

:::
<ProPlanNotice />
```

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)
Expand Down
6 changes: 6 additions & 0 deletionsdocs/guides/review-instructions.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,6 +48,12 @@ reviews:

## Abstract Syntax Tree (AST) based instructions {#ast-based}

```mdx-code-block
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';

<ProPlanNotice />
```

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
Expand Down
10 changes: 10 additions & 0 deletionsdocs/integrations/knowledge-base.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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';

<ProPlanNotice />
```

#### CodeRabbit App

1. Navigate to [integrations][integrations] in the CodeRabbit app.
Expand All@@ -26,6 +32,10 @@ Upon enabling the Jira integration, CodeRabbit will redirect you to the Jira log

### Linear {#Linear}

```mdx-code-block
<ProPlanNotice />
```

#### CodeRabbit App

1. Navigate to [integrations][integrations] in the CodeRabbit app.
Expand Down
6 changes: 6 additions & 0 deletionsdocs/tools/actionlint.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,12 @@ sidebar_label: Actionlint
description: CodeRabbit's guide to Actionlint.
---

```mdx-code-block
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';

<ProPlanNotice />
```

[Actionlint](https://github.com/rhysd/actionlint/) is a static checker for
GitHub Actions workflow files.

Expand Down
6 changes: 6 additions & 0 deletionsdocs/tools/biome.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,12 @@ sidebar_label: Biome
description: CodeRabbit's guide to Biome.
---

```mdx-code-block
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';

<ProPlanNotice />
```

[Biome](https://biomejs.dev/) is a linter for JavaScript, TypeScript, JSX, TSX, JSON, JSONC, CSS.

## Files
Expand Down
Loading
Loading

[8]ページ先頭

©2009-2025 Movatter.jp