Skip to content

Update Documentation to Highlight Pro-Tier Tool Availability #171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Update Documentation to Highlight Pro-Tier Tool Availability #171

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
63d32ba
docs: add note about Pro-tier tools in knowledge base
aravindputrevu Dec 12, 2024
4ff759d
docs: add Pro-tier tools note to various tool guides
aravindputrevu Dec 12, 2024
c9aebc8
fix: update GitHub link to point to the correct repository
aravindputrevu Dec 12, 2024
371d446
docs: remove beta label and clarify Pro-tier availability for on-dema…
aravindputrevu Dec 12, 2024
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
Prev Previous commit
docs: remove beta label and clarify Pro-tier availability for on-dema… 
…nd reports
  • Loading branch information
@aravindputrevu
aravindputrevu committed Dec 12, 2024
commit 371d446baf06dbdf8f7fb2c9a1246ce2428a7fd4
16 changes: 7 additions & 9 deletions docs/guides/ondemand-reports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
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
---
Expand All @@ -9,19 +9,17 @@ sidebar_position: 6
import ReportSchema from "@site/src/components/ReportSchema";
```

:::info

This feature is in beta
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.

:::note
Reports are available under [Pro-tier](https://coderabbit.ai/pricing).
:::

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
Loading