Skip to content

Commit f6d829a

Browse files
adding notes and fix position
1 parent 3602c05 commit f6d829a

File tree

3 files changed

+15
-3
lines changed

3 files changed

+15
-3
lines changed

docs/guides/custom-reports.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Custom Reports
33
sidebar_label: Custom Reports
44
description: Learn how to create custom reports with CodeRabbit Pro's flexible reporting system
5-
sidebar_position: 8
5+
sidebar_position: 7
66
---
77

88
```mdx-code-block

docs/guides/ondemand-reports.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: On-demand Reports
33
sidebar_label: On-demand Reports
44
description: CodeRabbit offers a way to generate on-demand reports using a simple API request
5-
sidebar_position: 6
5+
sidebar_position: 8
66
---
77

88
```mdx-code-block
@@ -12,6 +12,18 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1212
<ProPlanNotice />
1313
```
1414

15+
## Overview
16+
17+
CodeRabbit's reporting feature helps you track and analyze pull request activity across your repositories. There are two ways to generate reports:
18+
19+
1. **[Scheduled Reports](./scheduled-reports.md)** - Set up automated recurring reports that are delivered on a schedule to your preferred channels (email, Slack, MS Teams). This is the recommended way to keep your team informed about development progress.
20+
21+
2. **On-demand Reports** (this guide) - Generate reports programmatically through our API when you need them. This is useful for integration with your own tools and workflows.
22+
23+
If you're new to CodeRabbit's reporting features, we recommend starting with [Scheduled Reports](./scheduled-reports.md) to understand the available options and capabilities.
24+
25+
## API Access
26+
1527
CodeRabbit offers a way to generate on-demand reports using the [CodeRabbit API](https://api.coderabbit.ai/api/swagger/).
1628
You will need an API Key to access the CodeRabbit API and generate an on-demand report.
1729

docs/guides/scheduled-reports.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Scheduled Reports
33
sidebar_label: Scheduled Reports
44
description: Learn how to set up automated recurring reports with CodeRabbit Pro
5-
sidebar_position: 7
5+
sidebar_position: 6
66
---
77

88
```mdx-code-block

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy