diff --git a/docs/guides/daily-standup-report.md b/docs/guides/daily-standup-report.md new file mode 100644 index 00000000..6829d760 --- /dev/null +++ b/docs/guides/daily-standup-report.md @@ -0,0 +1,58 @@ +--- +title: Daily Standup Report +sidebar_label: Daily Standup Report +description: + Coderabbit allows users to setup daily standup reporting in their slack workspace +--- + +Coderabbit allows you to set up daily standup reports in your slack workspace. +It summarizes the activities of developers based on the pull requests they have made. + +Follow the steps below to set up reports: + +### **Step 1: Navigate to the Reports page** + +Log in to Coderabbit and click on 'Reports' in the sidebar. +Click on the 'Enable Reporting' button to enable daily standup reporting + +![Disabled reporting page](./images/report-disabled.png) + +### **Step 2: Setup Reporting Schedule** + +Select the time, timezone and days as to when you would like the reports to be posted and click on the 'Submit' button to save + +![Report schedule](./images/report-schedule.png) + +:::note + +Reports will contain PRs/MRs made by the developers since the last selected day. + +For instance, if you schedule the report on Monday and Friday, the report on Monday will have the PRs/MRs that were created since Friday and the report on Friday will have PRs/MRs created since Monday. + +If the report is scheduled on all days, every report will have the PRs/MRs made in the last 24 hours + +::: + +### **Step 3: Connect Slack** + +Click on the 'Connect' button to connect your Slack workspace. +You will be redirected to the Slack integration page. +Click on 'Allow' to allow CodeRabbit access to your Slack workspace so that it can post the report + +![Slack Access](./images/slack-access.png) + +### **Step 4: Select Slack Channel** + +Once you're back on the reports page, enable Slack and select the channel where you would like the report to be posted and click on the 'Submit' button to save + +![Slack Channel](./images/report-slack.png) + +You should see the report get posted in the selected Slack channel based on the schedule that was selected + +![Report](./images/report.png) + +:::info + +Reports could take a minute or two to generate. + +::: diff --git a/docs/guides/images/report-disabled.png b/docs/guides/images/report-disabled.png new file mode 100644 index 00000000..096e8592 Binary files /dev/null and b/docs/guides/images/report-disabled.png differ diff --git a/docs/guides/images/report-schedule.png b/docs/guides/images/report-schedule.png new file mode 100644 index 00000000..6f33cc6c Binary files /dev/null and b/docs/guides/images/report-schedule.png differ diff --git a/docs/guides/images/report-slack.png b/docs/guides/images/report-slack.png new file mode 100644 index 00000000..a4c1cd58 Binary files /dev/null and b/docs/guides/images/report-slack.png differ diff --git a/docs/guides/images/report.png b/docs/guides/images/report.png new file mode 100644 index 00000000..7508f1fd Binary files /dev/null and b/docs/guides/images/report.png differ diff --git a/docs/guides/images/slack-access.png b/docs/guides/images/slack-access.png new file mode 100644 index 00000000..efca14ee Binary files /dev/null and b/docs/guides/images/slack-access.png differ diff --git a/sidebars.ts b/sidebars.ts index 3d051844..d69dcf2b 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -35,6 +35,7 @@ const sidebars: SidebarsConfig = { "guides/customize-coderabbit", "guides/prompt-customization", "guides/coderabbit-commands", + "guides/daily-standup-report" ], }, {