Add an overview page about reports. #367
Conversation
…es a bit, to build a couple of user journeys. Reorder the pages in the ToC.
WalkthroughA new documentation guide providing a conceptual overview of report generation in CodeRabbit was added. Existing guides on custom, scheduled, and on-demand reports were updated to reference this overview and improve navigation. The sidebar configuration was also updated to reorder and highlight the new overview and scheduled reports guides. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs_Sidebar
participant ReportsOverview
participant ScheduledReports
participant OnDemandReports
participant CustomReports
User->>Docs_Sidebar: Navigates to "Generate reports"
Docs_Sidebar->>ReportsOverview: Shows conceptual overview
ReportsOverview->>User: Explains report types and customization
ReportsOverview->>ScheduledReports: Links to scheduled reports guide
ReportsOverview->>OnDemandReports: Links to on-demand reports guide
ReportsOverview->>CustomReports: Links to custom reports guide
Assessment against linked issues
Assessment against linked issues: Out-of-scope changesNo out-of-scope changes found. Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate Unit Tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Deploying coderabbit-docs with
|
| Latest commit: |
2889379
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://763c4968.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://reports.coderabbit-docs.pages.dev |
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/guides/reports-overview.md (1)
8-9: Remove unused ReportSchema import
ReportSchemais imported but never used in this file. To reduce confusion, consider removing it.
Proposed diff:- import ReportSchema from "@site/src/components/ReportSchema";
🛑 Comments failed to post (1)
docs/guides/ondemand-reports.md (1)
15-18:
⚠️ Potential issueFix typo and update link path
There's a typo ("theh" → "then") and the link should use an absolute site path.
Apply this diff:- If you're new to CodeRabbit's reporting features, theh we recommend starting with [Scheduled reports](./scheduled-reports.md) to understand the available options and capabilities. + 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.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.This page is about using the CodeRabbit API to generate on-demand reports about your organization's usage of CodeRabbit. For a conceptual overview of reports in CodeRabbit, see [Generate reports](/guides/reports-overview). 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.🤖 Prompt for AI Agents
In docs/guides/ondemand-reports.md around lines 15 to 18, fix the typo by changing "theh" to "then" and update the link to use an absolute site path by replacing "./scheduled-reports.md" with "/guides/scheduled-reports".
Update the existing reporting pages a bit, to build a couple of user journeys. Reorder the pages in the ToC.
Fixes #310.
Staged: