add reporting guide #187

alexcoderabbitai · 2025-01-03T18:43:24Z

closes: https://github.com/coderabbitai/mono/issues/2377

coderabbitai · 2025-01-03T18:43:33Z

Walkthrough

The pull request introduces new documentation pages for CodeRabbit Pro, specifically "Scheduled Reports" and "Custom Reports." The "Scheduled Reports" guide covers the setup and management of automated recurring reports, detailing configuration options such as frequency and customizable parameters. The "Custom Reports" page explains the creation of tailored reports using a prompt-based system, including formatting and filtering options. Additionally, updates were made to the existing "On-demand Reports" documentation to enhance its content and structure.

Changes

File	Change Summary
`docs/guides/scheduled-reports.md`	New documentation page added detailing Scheduled Reports feature, including setup process, report customization, delivery channels, and management guidelines.
`docs/guides/custom-reports.md`	New documentation page added outlining the creation of custom reports, including prompt-based systems, formatting options, filtering, and best practices.
`docs/guides/ondemand-reports.md`	Updated sidebar position, added "Overview" and "API Access" sections, and enhanced content around report generation methods.
`docs/guides/commands.md`	New command added to generate docstrings for functions in pull requests.

Assessment against linked issues

Objective	Addressed	Explanation
Explain available data for reporting (#[2377])	✅
Describe report customization options (#[2377])	❌	The documentation does not explicitly explain the available data for reporting.

Possibly related PRs

add ms teams changelog info #123: The changes in this PR involve adding a section about Microsoft Teams Stand Up Reporting, which relates to the communication channels for report delivery mentioned in the main PR.
added ignore command in the doc #131: This PR adds a command to ignore reviews on a PR, which could be relevant to managing report content and user interactions discussed in the main PR.
docs: add guide for CodeRabbit GitHub integration #133: This PR adds a guide for integrating CodeRabbit with GitHub, which may relate to the setup and management of automated reports as described in the main PR.
docs: Improve docs SEO #142: The updates in this PR enhance the clarity of integration instructions, which could be relevant to the setup process for scheduled reports mentioned in the main PR.
Flesh out knowledgebase docs a bit #150: This PR enhances the features documentation, which could relate to the customizable report parameters discussed in the main PR.

Suggested reviewers

aravindputrevu
dk03051996

Poem

🐰 In the land of reports, we hop with glee,
Scheduled and custom, as fine as can be!
With templates and prompts, our data takes flight,
CodeRabbit's magic, shining so bright!
Let insights abound, from morning till night! 📊✨

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

[dependabot skip]

cloudflare-workers-and-pages · 2025-01-03T18:43:54Z

Deploying coderabbit-docs with Cloudflare Pages

Latest commit:	`efc5c27`
Status:	✅ Deploy successful!
Preview URL:	https://fc190273.coderabbit-docs.pages.dev
Branch Preview URL:	https://reporting-guide.coderabbit-docs.pages.dev

View logs

coderabbitai

Actionable comments posted: 2

🧹 Nitpick comments (6)

docs/guides/scheduled-reports.md (6)

14-14: Consider enhancing the introduction with key benefits.

While the introduction is clear, consider adding 1-2 sentences highlighting key benefits such as time savings, consistency in reporting, or improved team visibility to better motivate users to adopt this feature.

-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.
+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. By automating report generation, teams save valuable time while ensuring consistent visibility into project metrics and development activities. This enables better decision-making and helps maintain alignment across distributed teams.

18-38: Add step for saving/applying changes.

The setup instructions are clear, but they should include a final step about saving or applying the configuration.

 3. Configure the following settings:

 ### Schedule Configuration

 - **Frequency**: Choose between weekly, monthly, or custom intervals
 - **Days**: Select specific days of the week or month
 - **Time**: Set the time for report generation in your timezone

+4. Click **Save Configuration** to apply your settings

50-59: Enhance the custom prompt example.

Consider adding more context and structure to the example prompt to better demonstrate the customization capabilities.

 Please provide a summary of:
 - All pull request activities
 - Related issues and comments
 - Code review discussions
 - Quality gate status
+- Test coverage changes
+- Technical debt metrics
+
+Format the output as:
+- High-level summary (2-3 sentences)
+- Detailed sections with bullet points
+- Metrics comparison with previous report

 Do not include:
 - Bot conversations
 - Sequence diagrams
+- Auto-generated comments
+- Dependencies updates

61-85: Add troubleshooting guidance for channel integrations.

Consider adding a troubleshooting subsection to help users resolve common integration issues.

 :::tip
 Create separate reports if you need to send to multiple channels with different formats
 :::
+
+### Troubleshooting Channel Integration
+
+Common issues and solutions:
+
+- **Webhook errors**: Verify webhook URL format and permissions
+- **Missing messages**: Check channel/email filters and spam settings
+- **OAuth connection issues**: Try disconnecting and reconnecting the integration

102-118: Add examples to illustrate best practices.

Consider adding concrete examples to better illustrate effective vs ineffective practices.

 2. **Content**

    - Keep prompts focused on actionable information
    - Use grouping to improve readability
    - Exclude unnecessary details that may create noise
+
+   Example effective prompt:
+   "Summarize PRs affecting core services with test coverage below 80%"
+
+   Example ineffective prompt:
+   "Show all GitHub activity from last week"

119-122: Add more relevant resources.

Consider adding links to other related documentation that would be helpful for users.

 ## Related Resources

 - [On-demand Reports](./ondemand-reports.md)
 - [API Documentation](https://api.coderabbit.ai/api/swagger/)
+- [Report Templates Gallery](./report-templates.md)
+- [Integration Setup Guide](./integrations.md)
+- [Best Practices for Report Design](./report-design.md)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 232d206 and 4933c77.

📒 Files selected for processing (1)

docs/guides/scheduled-reports.md (1 hunks)

🧰 Additional context used

🪛 Markdownlint (0.37.0)

docs/guides/scheduled-reports.md

49-49: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (1)

docs/guides/scheduled-reports.md (1)

1-12: LGTM! Well-structured frontmatter with Pro plan notice.

The frontmatter is properly configured with all necessary metadata, and the Pro plan notice is appropriately placed for this premium feature.

docs/guides/scheduled-reports.md

coderabbitai

Actionable comments posted: 0

♻️ Duplicate comments (2)

docs/guides/scheduled-reports.md (2)
52-62: ⚠️ Potential issue

Add language specification to the code block.

The code block should specify a language for proper syntax highlighting. This will also fix the pipeline failure.
-```
+```prompt
 Please provide a summary of:
 - All pull request activities
🧰 Tools

🪛 Markdownlint (0.37.0)

52-52: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🪛 GitHub Actions: Node.js CI

[error] 52-52: MD040/fenced-code-language: Fenced code blocks should have a language specified

91-106: 🛠️ Refactor suggestion

Add report lifecycle management details.

Consider adding information about editing, disabling, and deleting reports.
 This helps keep information organized for larger organizations or teams.

+### Report Lifecycle
+
+- **Edit Reports**: Update configuration of existing reports
+- **Disable Reports**: Temporarily pause report generation
+- **Delete Reports**: Remove unwanted reports permanently
+
+:::note
+Disabled reports can be re-enabled at any time without losing configuration
+:::

🧹 Nitpick comments (2)

docs/guides/scheduled-reports.md (2)

16-40: Add parameter constraints and default values.

Consider enhancing the documentation by adding:

Default values for frequency, days, and time

Any validation rules or constraints for each parameter

Examples of valid configurations

This will help users understand the boundaries and expectations when setting up reports.

64-90: Add security considerations for communication channels.

Consider adding information about:

Security implications of using distribution lists

OAuth token permissions and scopes

Webhook URL security best practices

Data privacy considerations when sharing reports

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4933c77 and f8d748c.

⛔ Files ignored due to path filters (2)

static/img/guides/report-params.png is excluded by !**/*.png, !**/*.png
static/img/guides/report-platforms.png is excluded by !**/*.png, !**/*.png

📒 Files selected for processing (1)

docs/guides/scheduled-reports.md (1 hunks)

🧰 Additional context used

🪛 Markdownlint (0.37.0)

docs/guides/scheduled-reports.md

52-52: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🪛 GitHub Actions: Node.js CI

docs/guides/scheduled-reports.md

[error] 52-52: MD040/fenced-code-language: Fenced code blocks should have a language specified

🔇 Additional comments (2)

docs/guides/scheduled-reports.md (2)

1-15: LGTM! Well-structured frontmatter and clear introduction.

The frontmatter provides all necessary metadata, and the introduction effectively communicates the purpose of scheduled reports.

124-127: Verify documentation links.

Please ensure that the linked documentation pages exist and are accessible:

./ondemand-reports.md

https://api.coderabbit.ai/api/swagger/

✅ Verification successful

Documentation links are valid and properly referenced

The verification confirms that:

The relative link ./ondemand-reports.md exists at docs/guides/ondemand-reports.md

The API documentation URL api.coderabbit.ai/api/swagger is consistently referenced across multiple documentation files
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Description: Verify that the linked documentation files exist

# Check if ondemand-reports.md exists in the docs/guides directory
fd -t f "ondemand-reports.md" docs/guides

# Check if the API documentation link is mentioned in other documentation files
rg -l "api.coderabbit.ai/api/swagger" docs/
Length of output: 182

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (2)

docs/guides/scheduled-reports.md (1)
Line range hint 235-235: Fix typo in text.

Add an apostrophe to "Heres".
-Heres a more advanced example of a custom report template:
+Here's a more advanced example of a custom report template:
🧰 Tools

🪛 LanguageTool

[style] ~69-~69: The double modal “needed Combined” is nonstandard (only accepted in certain dialects). Consider “to be Combined”.
Context: ...can be: - Added or removed as needed - Combined with other parameters for precise filte...

(NEEDS_FIXED)

[duplication] ~166-~166: Possible typo: you repeated a word
Context: ...Click the Save button to apply your changes - Changes take effect from the next scheduled run...

(ENGLISH_WORD_REPEAT_RULE)

[uncategorized] ~185-~185: Possible missing preposition found.
Context: ...utton (trash icon) next to the report - Confirm deletion in the modal - Note: This acti...

(AI_HYDRA_LEO_MISSING_TO)

[style] ~190-~190: Consider using a different verb to strengthen your wording.
Context: ...immediately stop all scheduled runs and remove access to historical reports. Consider ...

(REMOVE_REVOKE)

🪛 Markdownlint (0.37.0)

104-104: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🪛 GitHub Actions: Node.js CI

[error] 104-104: Fenced code blocks should have a language specified
docs/guides/custom-reports.md (1)
105-105: Capitalize "Markdown" as it's a proper noun.
-CodeRabbit supports markdown formatting in custom reports. You can use:
+CodeRabbit supports Markdown formatting in custom reports. You can use:
🧰 Tools

🪛 LanguageTool

[grammar] ~105-~105: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...Formatting Options CodeRabbit supports markdown formatting in custom reports. You can u...

(MARKDOWN_NNP)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f8d748c and 6392077.

📒 Files selected for processing (2)

docs/guides/custom-reports.md (1 hunks)
docs/guides/scheduled-reports.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/guides/custom-reports.md

[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...s: #### Pull Request Status - Merged: boolean (true/false) - Whether the PR h...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~60-~60: Loose punctuation mark.
Context: ...sic Information - Pull request number: number - The PR's identifier - Title:...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~70-~70: Loose punctuation mark.
Context: ...sed #### Additional Context - Labels: array of strings - All labels applied t...

(UNLIKELY_OPENING_PUNCTUATION)

[grammar] ~105-~105: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...Formatting Options CodeRabbit supports markdown formatting in custom reports. You can u...

(MARKDOWN_NNP)

docs/guides/scheduled-reports.md

[style] ~69-~69: The double modal “needed Combined” is nonstandard (only accepted in certain dialects). Consider “to be Combined”.
Context: ...can be: - Added or removed as needed - Combined with other parameters for precise filte...

(NEEDS_FIXED)

[duplication] ~166-~166: Possible typo: you repeated a word
Context: ...Click the Save button to apply your changes - Changes take effect from the next scheduled run...

(ENGLISH_WORD_REPEAT_RULE)

[uncategorized] ~185-~185: Possible missing preposition found.
Context: ...utton (trash icon) next to the report - Confirm deletion in the modal - Note: This acti...

(AI_HYDRA_LEO_MISSING_TO)

[style] ~190-~190: Consider using a different verb to strengthen your wording.
Context: ...immediately stop all scheduled runs and remove access to historical reports. Consider ...

(REMOVE_REVOKE)

🪛 Markdownlint (0.37.0)

docs/guides/custom-reports.md

31-31: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

80-80: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

118-118: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

131-131: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

147-147: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

162-162: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

199-199: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

217-217: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

237-237: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

docs/guides/scheduled-reports.md

104-104: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🪛 GitHub Actions: Node.js CI

docs/guides/custom-reports.md

[error] 31-31: Fenced code blocks should have a language specified

[error] 80-80: Fenced code blocks should have a language specified

[error] 118-118: Fenced code blocks should have a language specified

[error] 131-131: Fenced code blocks should have a language specified

[error] 147-147: Fenced code blocks should have a language specified

[error] 162-162: Fenced code blocks should have a language specified

[error] 199-199: Fenced code blocks should have a language specified

[error] 217-217: Fenced code blocks should have a language specified

[error] 237-237: Fenced code blocks should have a language specified

docs/guides/scheduled-reports.md

[error] 104-104: Fenced code blocks should have a language specified

🔇 Additional comments (3)

docs/guides/scheduled-reports.md (2)

104-114: Add language specification to the code block.

The code block should specify a language for proper syntax highlighting.
-```
+```prompt
 Please provide a summary of:
 - All pull request activities
🧰 Tools

🪛 Markdownlint (0.37.0)

104-104: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🪛 GitHub Actions: Node.js CI

[error] 104-104: Fenced code blocks should have a language specified

1-214: Well-structured and comprehensive documentation!

The documentation provides clear instructions, examples, and best practices for setting up scheduled reports. The content is logically organized and covers all essential aspects.

🧰 Tools

🪛 LanguageTool

[style] ~69-~69: The double modal “needed Combined” is nonstandard (only accepted in certain dialects). Consider “to be Combined”.
Context: ...can be: - Added or removed as needed - Combined with other parameters for precise filte...

(NEEDS_FIXED)

[duplication] ~166-~166: Possible typo: you repeated a word
Context: ...Click the Save button to apply your changes - Changes take effect from the next scheduled run...

(ENGLISH_WORD_REPEAT_RULE)

[uncategorized] ~185-~185: Possible missing preposition found.
Context: ...utton (trash icon) next to the report - Confirm deletion in the modal - Note: This acti...

(AI_HYDRA_LEO_MISSING_TO)

[style] ~190-~190: Consider using a different verb to strengthen your wording.
Context: ...immediately stop all scheduled runs and remove access to historical reports. Consider ...

(REMOVE_REVOKE)

🪛 Markdownlint (0.37.0)

104-104: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🪛 GitHub Actions: Node.js CI

[error] 104-104: Fenced code blocks should have a language specified
docs/guides/custom-reports.md (1)

1-340: Excellent documentation with comprehensive examples and best practices!

The documentation provides thorough coverage of custom reports, including:

Clear explanation of available data points

Detailed formatting options and examples

Advanced features and best practices

Comprehensive templates for different use cases

🧰 Tools

🪛 LanguageTool

[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...s: #### Pull Request Status - Merged: boolean (true/false) - Whether the PR h...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~60-~60: Loose punctuation mark.
Context: ...sic Information - Pull request number: number - The PR's identifier - Title:...

(UNLIKELY_OPENING_PUNCTUATION)

[uncategorized] ~70-~70: Loose punctuation mark.
Context: ...sed #### Additional Context - Labels: array of strings - All labels applied t...

(UNLIKELY_OPENING_PUNCTUATION)

[grammar] ~105-~105: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...Formatting Options CodeRabbit supports markdown formatting in custom reports. You can u...

(MARKDOWN_NNP)

🪛 Markdownlint (0.37.0)

31-31: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

80-80: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

118-118: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

131-131: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

147-147: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

162-162: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

199-199: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

217-217: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

237-237: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🪛 GitHub Actions: Node.js CI

[error] 31-31: Fenced code blocks should have a language specified

[error] 80-80: Fenced code blocks should have a language specified

[error] 118-118: Fenced code blocks should have a language specified

[error] 131-131: Fenced code blocks should have a language specified

[error] 147-147: Fenced code blocks should have a language specified

[error] 162-162: Fenced code blocks should have a language specified

[error] 199-199: Fenced code blocks should have a language specified

[error] 217-217: Fenced code blocks should have a language specified

[error] 237-237: Fenced code blocks should have a language specified

docs/guides/custom-reports.md

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (4)

docs/guides/scheduled-reports.md (4)
65-71: Enhance parameter combinations documentation.

While the note about parameter configuration is helpful, consider adding examples of common parameter combinations to make it more practical.
 Each parameter can be:

 - Added or removed as needed
 - Combined with other parameters for precise filtering
 - Modified using different operators
+
+Example combinations:
+- Repository + Label: Track specific types of PRs in selected repos
+- Team + Label: Monitor team progress on different PR categories
+- User + Repository: Track individual contributions across repos
   :::
🧰 Tools

🪛 LanguageTool

[style] ~69-~69: The double modal “needed Combined” is nonstandard (only accepted in certain dialects). Consider “to be Combined”.
Context: ...can be: - Added or removed as needed - Combined with other parameters for precise filte...

(NEEDS_FIXED)

116-142: Add security considerations for communication channels.

Consider adding security best practices for managing webhooks and distribution lists.
 :::tip
 Create separate reports if you need to send to multiple channels with different formats. Learn more about [custom report formats](./custom-reports.md).
 :::
+
+:::caution Security Best Practices
+- Regularly rotate webhook URLs
+- Review distribution lists periodically
+- Use private channels for sensitive information
+- Monitor channel access permissions
+:::
211-211: Strengthen wording in warning message.

Consider using stronger verbs to emphasize the permanence of deletion.
-Deleting a report will immediately stop all scheduled runs and remove access to historical reports.
+Deleting a report will immediately terminate all scheduled runs and permanently revoke access to historical reports.
🧰 Tools

🪛 LanguageTool

[style] ~211-~211: Consider using a different verb to strengthen your wording.
Context: ...immediately stop all scheduled runs and remove access to historical reports. Consider ...

(REMOVE_REVOKE)

214-235: Add examples to best practices.

Consider adding concrete examples to illustrate each best practice.
 1. **Scheduling**

    - Align report timing with your team's workflow
    - Consider timezone differences for distributed teams
+   Example: Schedule daily reports at 9 AM local time for each major timezone

 2. **Content**

    - Keep prompts focused on actionable information
    - Use grouping to improve readability
    - Exclude unnecessary details that may create noise
+   Example: "Show PRs pending review > 2 days" instead of "List all PRs"

 3. **Distribution**
    - Use channels your team actively monitors
    - Consider creating separate reports for different audiences
+   Example: Technical details in dev channels, high-level metrics in management channels

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6392077 and 3602c05.

📒 Files selected for processing (1)

docs/guides/scheduled-reports.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/guides/scheduled-reports.md

[style] ~69-~69: The double modal “needed Combined” is nonstandard (only accepted in certain dialects). Consider “to be Combined”.
Context: ...can be: - Added or removed as needed - Combined with other parameters for precise filte...

(NEEDS_FIXED)

[duplication] ~187-~187: Possible typo: you repeated a word
Context: ...Click the Save button to apply your changes - Changes take effect from the next scheduled run...

(ENGLISH_WORD_REPEAT_RULE)

[style] ~211-~211: Consider using a different verb to strengthen your wording.
Context: ...immediately stop all scheduled runs and remove access to historical reports. Consider ...

(REMOVE_REVOKE)

🪛 Markdownlint (0.37.0)

docs/guides/scheduled-reports.md

104-104: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🪛 GitHub Actions: Node.js CI

docs/guides/scheduled-reports.md

[error] 104-104: Fenced code blocks should have a language specified

🔇 Additional comments (2)

docs/guides/scheduled-reports.md (2)

1-15: Well-structured frontmatter and introduction!

The metadata and introduction effectively set up the context for the documentation.

104-114: Add language specification to the code block.

The code block should specify a language for proper syntax highlighting.
-```
+```prompt
 Please provide a summary of:
 - All pull request activities
 - Related issues and comments
 - Code review discussions
 - Quality gate status

 Do not include:
 - Bot conversations
 - Sequence diagrams
🧰 Tools

🪛 Markdownlint (0.37.0)

104-104: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🪛 GitHub Actions: Node.js CI

[error] 104-104: Fenced code blocks should have a language specified

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (6)

docs/guides/ondemand-reports.md (2)
Line range hint 44-63: Add syntax highlighting to the sample output

Add JSON syntax highlighting to make the output more readable.
-```sh
+```json
 [
   {
     "group": "Developer Activity",
Line range hint 65-69: Enhance the error message description

The error message could be more helpful by including common causes and solutions.
 :::info
-If you get a 401 UNAUTHORIZED error, check if you're passing the right API key in the `x-coderabbitai-api-key` header
+If you get a 401 UNAUTHORIZED error:
+- Verify that you're passing the correct API key
+- Ensure the API key is active and not expired
+- Check if the key has the necessary permissions
+- Confirm the header name is exactly `x-coderabbitai-api-key`
 :::
docs/guides/scheduled-reports.md (2)
69-71: Fix grammatical issue in parameter description

The sentence structure needs improvement.
-Each parameter can be:
+Parameters can be:
 
 - Added or removed as needed
-- Combined with other parameters for precise filtering
+- Combined with other parameters for precise filtering
🧰 Tools

🪛 LanguageTool

[style] ~69-~69: The double modal “needed Combined” is nonstandard (only accepted in certain dialects). Consider “to be Combined”.
Context: ...can be: - Added or removed as needed - Combined with other parameters for precise filte...

(NEEDS_FIXED)

187-189: Remove word repetition

The word "changes" is repeated unnecessarily.
-- Click the **Save** button to apply your changes
-- Changes take effect from the next scheduled run
+- Click the **Save** button to apply your changes
+- Updates take effect from the next scheduled run
🧰 Tools

🪛 LanguageTool

[duplication] ~187-~187: Possible typo: you repeated a word
Context: ...Click the Save button to apply your changes - Changes take effect from the next scheduled run...

(ENGLISH_WORD_REPEAT_RULE)
docs/guides/custom-reports.md (2)
105-105: Capitalize "Markdown" as a proper noun

"Markdown" should be capitalized as it's a proper noun.
-CodeRabbit supports markdown formatting in custom reports.
+CodeRabbit supports Markdown formatting in custom reports.
🧰 Tools

🪛 LanguageTool

[grammar] ~105-~105: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...Formatting Options CodeRabbit supports markdown formatting in custom reports. You can u...

(MARKDOWN_NNP)

235-235: Fix typo in heading text

There's a missing apostrophe in "Heres".
-Heres a more advanced example of a custom report template:
+Here's a more advanced example of a custom report template:

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3602c05 and f6d829a.

📒 Files selected for processing (3)

docs/guides/custom-reports.md (1 hunks)
docs/guides/ondemand-reports.md (2 hunks)
docs/guides/scheduled-reports.md (1 hunks)