This repository was archived by the owner on Aug 16, 2025. It is now read-only.

coderabbitai/coderabbit-docsPublic archive

NotificationsYou must be signed in to change notification settings
Fork69
Star114

Add a Learnings overview page.#454

Merged

jmacdotorg merged 6 commits intomainfromlearnings

Jul 30, 2025

Merged

Add a Learnings overview page.#454

jmacdotorg merged 6 commits intomainfromlearnings

Jul 30, 2025

Conversation

Copy link

Contributor

jmacdotorg commentedJul 15, 2025•
edited
Loading

Fixes#362.

Staged:

New page:https://learnings.coderabbit-docs.pages.dev/guides/learnings
New section in the existing configuration overview page:https://learnings.coderabbit-docs.pages.dev/guides/configuration-overview#learnings
New link from the existing knowledge base page:https://learnings.coderabbit-docs.pages.dev/integrations/knowledge-base#learnings

jmacdotorg added2 commits

July 15, 2025 16:25

Add a new page about Learnings.

8f04914

Tweaks

b8c15b0

jmacdotorg requested a review fromaravindputrevu

July 15, 2025 21:00

jmacdotorg requested a review froma team as acode owner

July 15, 2025 21:00

jmacdotorg requested review fromhelizaga andsleep-404

July 15, 2025 21:00

Copy link

Contributor

coderabbitaibot commentedJul 15, 2025•
edited
Loading

Walkthrough

The documentation was updated to introduce and explain the "learnings" feature, which allows CodeRabbit to remember and apply team-specific code review preferences. A new guide was added, references and navigation were updated, and sidebar navigation was adjusted to include the new page. Existing documentation was revised for clarity and consistency.

Changes

File(s)	Change Summary
New Learnings Guide `docs/guides/learnings.md`	Added a new guide detailing the "learnings" feature, usage, configuration, and best practices.
Configuration Overview `docs/guides/configuration-overview.md`	Added "Learnings" and "What's next" sections, referencing the new guide and improving navigation.
Initial Configuration `docs/guides/initial-configuration.md`	Updated the link for review preferences to point to the new learnings guide.
Knowledge Base Overview `docs/integrations/knowledge-base.md`	Retitled to "Knowledge base overview" and replaced video reference with a link to the new guide.
Sidebar Configuration `sidebars.ts`	Inserted "guides/learnings" into the sidebar under "Configure CodeRabbit".

Sequence Diagram(s)

sequenceDiagram    participant User    participant CodeRabbit    participant WebInterface    User->>CodeRabbit: Comments with review preference on PR/Issue    CodeRabbit-->>User: Acknowledges and stores learning    User->>WebInterface: Views or manages learnings    WebInterface-->>User: Displays, filters, or allows editing/deletion of learnings    CodeRabbit->>CodeRabbit: Applies relevant learnings during future code reviews

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

The changes primarily involve adding and updating documentation files with moderate content volume and some cross-references. No complex code logic or algorithms were introduced.

Assessment against linked issues

Objective	Addressed	Explanation
Add a page about Learnings (#362)	✅
Include a link to the existing video (#362)	❌	The new Learnings guide does not include a link to the existing video as requested in the issue.

Assessment against linked issues: Out-of-scope changes

Code Change	Explanation
Removal of video tutorial section (docs/integrations/knowledge-base.md, lines ~10-25)	The removal of the video tutorial reference was not requested in issue#362 and is unrelated to the Learnings page objective.

Poem

In docs we grow a garden new,
Where learnings bloom in every queue.
CodeRabbit listens, stores with care,
Your team's review style everywhere.
With guides and links, the path is clear—
Hop along, improvements near!
🐇✨

Pre-Merge Checks (3 passed, 2 warnings)

❌ Failed Checks (2 warnings)

Check Name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The description is minimal and lacks context, rationale, and the required link to the existing video as per issue#362.	Expand the description to include background context, detailed summaries of the changes (including linking to the existing video tutorial per issue#362), and consider adding a PR template to ensure consistency.
Linked Issues Assessment	⚠️ Warning	The new Learnings page meets the requirement to create a Learnings page but omits the link to the existing video tutorial [#362].	Update the Learnings page and related documentation to include the existing video tutorial link to fully satisfy issue#362.

✅ Passed Checks (3 passed)

Check Name	Status	Explanation
Title Check	✅ Passed	The title clearly indicates that a Learnings overview page is being added and accurately reflects the changes.
Out-of-scope Changes Assessment	✅ Passed	All changes are directly related to introducing the Learnings page, updating relevant links, and modifying navigation.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Note

⚡️ Unit Test Generation is now available in beta!

Learn morehere, or try it out under "Finishing Touches" below.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between60fa30f and9f0b665.

📒 Files selected for processing (1)

sidebars.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

sidebars.ts

🧰 Additional context used

🔍 MCP Research (2 servers)

Context7: - The pull request adds a new documentation page "Teach CodeRabbit your review preferences" at docs/guides/learnings.md detailing the CodeRabbit learnings feature (docs/guides/learnings.md).

Learnings enable CodeRabbit to store natural-language instructions from team interactions to tailor code review behavior, complementing.coderabbit.yaml and web settings (docs/guides/learnings.md).
Learnings can be managed via the web interface with filtering, editing, and deletion options; configuration allows opting out or setting scope (auto,global,local) (docs/guides/learnings.md).
The new learnings page is linked from configuration-overview.md, integrations/knowledge-base.md (renamed "Knowledge base overview"), and added to the sidebar under "Configure CodeRabbit" (configuration-overview.md, integrations/knowledge-base.md, sidebars.ts).

Linear: ""

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branchlearnings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat withCodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on oursupport 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)

@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 togenerate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@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 theconfiguration 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 ourDocumentation for detailed information on how to use CodeRabbit.
Join ourDiscord Community to get help, request features, and share feedback.
Follow us onX/Twitter for updates and announcements.

Merge branch 'main' into learnings

d3f127f

Copy link

cloudflare-workers-and-pagesbot commentedJul 15, 2025•
edited
Loading

Deploying coderabbit-docs with Cloudflare Pages

Latest commit:	`9f0b665`
Status:	✅ Deploy successful!
Preview URL:	https://bf046130.coderabbit-docs.pages.dev
Branch Preview URL:	https://learnings.coderabbit-docs.pages.dev

View logs