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

Commit42a07ca

Browse files
authored
Add an overview page about reports. (coderabbitai#367)
* Add an overview page about reports. Update the existing reporting pages a bit, to build a couple of user journeys. Reorder the pages in the ToC.* Fix formatting.* Typo fix.
1 parentdd7cf35 commit42a07ca

File tree

5 files changed

+59
-10
lines changed

5 files changed

+59
-10
lines changed

‎docs/guides/custom-reports.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1111

1212
CodeRabbit Pro allows you to create custom reports tailored to your specific needs using a flexible prompt-based system. This guide will help you understand how to create effective custom reports.
1313

14+
For a conceptual overview of reports in CodeRabbit, see[Generate reports](/guides/reports-overview).
15+
1416
##Understanding Custom Reports
1517

1618
Custom reports allow you to:
@@ -558,6 +560,6 @@ These are the available emojis and the type of change they represent. Do not usi
558560

559561
##Related Resources
560562

561-
-[Scheduled Reports](./scheduled-reports.md)
562-
-[On-demand Reports](./ondemand-reports.md)
563+
-[Schedule reports](/guides/scheduled-reports)
564+
-[Generate reports on demand](/guides/ondemand-reports)
563565
-[API Documentation](https://api.coderabbit.ai/api/swagger/)

‎docs/guides/ondemand-reports.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title:Generate reports
2+
title:Generate reports on demand
33
description:CodeRabbit offers a way to generate on-demand reports using a simple API request
44
---
55

@@ -12,13 +12,9 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1212

1313
##Overview
1414

15-
CodeRabbit's reporting feature helps you track and analyze pull request activity acrossyourrepositories. There are two ways to generatereports:
15+
This page is about using the CodeRabbit API to generate on-demand reports aboutyourorganization's usage of CodeRabbit. For a conceptual overview of reports in CodeRabbit, see[Generatereports](/guides/reports-overview).
1616

17-
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.
18-
19-
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.
20-
21-
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.
17+
If you're new to CodeRabbit's reporting features, then we recommend starting with[Scheduled reports](/guides/scheduled-reports) to understand the available options and capabilities.
2218

2319
##API Access
2420

@@ -73,3 +69,8 @@ The on-demand report generation endpoints take in inputs as per the schema shown
7369
```
7470

7571
[API Reference](https://api.coderabbit.ai/api/swagger/)
72+
73+
##What's next
74+
75+
-[Customize reports](/guides/custom-reports)
76+
-[Scheduled reports](/guides/scheduled-reports)

‎docs/guides/reports-overview.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title:Generate reports
3+
description:Learn about CodeRabbit's reporting capabilities, including scheduled and on-demand reports, and how to customize them
4+
sidebar_label:Overview
5+
---
6+
7+
```mdx-code-block
8+
import ReportSchema from "@site/src/components/ReportSchema";
9+
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
10+
11+
<ProPlanNotice />
12+
```
13+
14+
You can track and analyze pull request activity across your organization's repositories by using the CodeRabbit reporting feature.
15+
16+
##Scheduled and on-demand reports {#types}
17+
18+
There are two ways to generate reports:
19+
20+
-**[Scheduled Reports](/guides/scheduled-reports)**: Set up automated, recurring reports that are delivered to your team on a set schedule. Supported delivery channels include the following:
21+
22+
- Email
23+
- Discord
24+
- Slack
25+
- Teams
26+
27+
-**[On-demand Reports](/guides/ondemand-reports)**: If you require customized integration of reports with your own tools and workflows, then you can generate reports programmatically through our API.
28+
29+
For your first reports, we recommend exploring scheduled reports. Its web-based UI can help you get familiar with the options available to you.
30+
31+
##Customize reports using natural language {#customize}
32+
33+
For both scheduled and on-demand reports, you define the shape and content of your reports by providing a prompt that instructs CodeRabbit about report that you want, using natural language. The scheduled reports interface includes several example prompts that you can choose from, or you can write your own prompt. For more information, see[Customize reports](/guides/custom-reports).
34+
35+
##What's next {#whats-next}
36+
37+
-[Schedule reports](/guides/scheduled-reports)
38+
-[Generate reports on demand](/guides/ondemand-reports)

‎docs/guides/scheduled-reports.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1111

1212
CodeRabbit Pro offers automated recurring reports that provide insights into your GitHub organization's activities. These reports can be customized and delivered through various channels to help teams stay informed about development progress.
1313

14+
For a conceptual overview of reports in CodeRabbit, see[Generate reports](/guides/reports-overview).
15+
1416
##Setting Up a Recurring Report
1517

1618
1. Navigate to**Recurring Reports** in the[CodeRabbit dashboard](https://app.coderabbit.ai/reports/recurring)
@@ -248,3 +250,8 @@ Deleting a report will immediately stop all scheduled runs and remove access to
248250
-[Custom Reports](./custom-reports.md)
249251
-[On-demand Reports](./ondemand-reports.md)
250252
-[API Documentation](https://api.coderabbit.ai/api/swagger/)
253+
254+
##What's next
255+
256+
-[Customize reports](/guides/custom-reports)
257+
-[Generate reports on demand](/guides/ondemand-reports)

‎sidebars.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,10 @@ const sidebars: SidebarsConfig = {
129129
collapsed:true,
130130
label:"Generate reports",
131131
items:[
132+
"guides/reports-overview",
133+
"guides/scheduled-reports",
132134
"guides/ondemand-reports",
133135
"guides/custom-reports",
134-
"guides/scheduled-reports",
135136
],
136137
},
137138
{

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp