Add a Learnings overview page. #454

jmacdotorg · 2025-07-15T21:00:38Z

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

coderabbitai · 2025-07-15T21:00:45Z

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

No out-of-scope changes were identified. All modifications relate directly to creating and integrating the Learnings documentation and related navigation updates as per the linked issue.

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 (2 passed, 3 warnings)

❌ Failed Checks (3 warnings)

Check Name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The description only lists staged changes without providing context, rationale, or details about the Learnings feature, and there is no pull request template to guide completeness.	Please expand the PR description with context on the Learnings feature, its purpose, detailed change summaries, and add a pull request template to the repository for consistency.
Linked Issues Assessment	⚠️ Warning	The pull request adds the Learnings page and related links but does not include the requested link to the existing video tutorial from issue #362.	Please update the new Learnings overview page and relevant documentation to include a link to the existing Learnings video per issue #362.
Out-of-scope Changes Assessment	⚠️ Warning	The PR removes the video tutorial reference from the knowledge base page, which is unrelated to the Learnings page objective and not requested by the linked issue.	Please revert the removal of the video tutorial section in docs/integrations/knowledge-base.md, as this change is unrelated to issue #362's objectives.

✅ Passed Checks (2 passed)

Check Name	Status	Explanation
Title Check	✅ Passed	The title clearly conveys the addition of a Learnings overview page, matching the primary objective of the pull request.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, 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 between d3f127f and 60fa30f.

📒 Files selected for processing (1)

docs/guides/configuration-overview.md (1 hunks)

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

docs/guides/configuration-overview.md

🧰 Additional context used

🔍 MCP Research (2 servers)

Context7: The Learnings feature enables natural-language customization of CodeRabbit’s review behavior, complementing .coderabbit.yaml and UI settings, with scoped application (auto, global, local) to respect repo privacy. Documentation updates add a dedicated guide detailing workflows for adding, viewing, and managing learnings, emphasizing replying to bot comments for precision. Reviewers should verify consistent, clear linking across docs, proper sidebar integration, and explicit warnings on data retention and privacy controls.

Linear: The Learnings feature uses natural-language chat to customize review preferences, complementing .coderabbit.yaml and UI settings, reflecting a hybrid config pattern. Learnings are scoped (auto/global/local) per repo or org, stored in an internal DB linked to Git accounts, with vector-based search for retrieval. Documentation updates emphasize data privacy via opt-out and deletion options. Reviewers should verify link accuracy, sidebar integration, and consistent terminology around Learnings and data retention policies.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: test

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch learnings

🪧 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.
- 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 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)

@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.
@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 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.

cloudflare-workers-and-pages · 2025-07-15T21:04:41Z

Deploying coderabbit-docs with Cloudflare Pages

Latest commit:	`60fa30f`
Status:	✅ Deploy successful!
Preview URL:	https://bd174f87.coderabbit-docs.pages.dev
Branch Preview URL:	https://learnings.coderabbit-docs.pages.dev

View logs

89hardy

Suggested some minor changes. Rest looks good.

89hardy · 2025-07-24T12:33:03Z

docs/guides/configuration-overview.md

based on your interactions with CodeRabbit bot over time

and your team's coding styles.

…t-docs into learnings

jmacdotorg added 2 commits July 15, 2025 16:25

Add a new page about Learnings.

8f04914

Tweaks

b8c15b0

jmacdotorg requested a review from aravindputrevu July 15, 2025 21:00

jmacdotorg requested a review from a team as a code owner July 15, 2025 21:00

jmacdotorg requested review from helizaga and sleep-404 July 15, 2025 21:00

Merge branch 'main' into learnings

d3f127f

jmacdotorg requested review from SahanaVP and 89hardy and removed request for a team, helizaga and sleep-404 July 21, 2025 19:23

edgarcerecerez self-requested a review July 21, 2025 21:27

89hardy reviewed Jul 24, 2025

View reviewed changes

docs/guides/configuration-overview.md

Copy link

89hardy Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

based on your interactions with CodeRabbit bot over time

and your team's coding styles.

jmacdotorg added 2 commits July 28, 2025 14:21

Requested tweak

d57d90b

Merge branch 'learnings' of https://github.com/coderabbitai/coderabbi…

60fa30f

…t-docs into learnings

coderabbitai bot approved these changes Jul 28, 2025

View reviewed changes

jmacdotorg requested a review from 89hardy July 28, 2025 18:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add a Learnings overview page. #454

Add a Learnings overview page. #454

jmacdotorg commented Jul 15, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 15, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

cloudflare-workers-and-pages bot commented Jul 15, 2025 •

edited

Loading

Uh oh!

89hardy left a comment

Uh oh!

89hardy Jul 24, 2025

Uh oh!

Uh oh!

Add a Learnings overview page. #454

Are you sure you want to change the base?

Add a Learnings overview page. #454

Conversation

jmacdotorg commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Assessment against linked issues

Assessment against linked issues: Out-of-scope changes

Poem

Pre-Merge Checks (2 passed, 3 warnings)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

cloudflare-workers-and-pages bot commented Jul 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying coderabbit-docs with Cloudflare Pages

Uh oh!

89hardy left a comment

Choose a reason for hiding this comment

Uh oh!

89hardy Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jmacdotorg commented Jul 15, 2025 •

edited

Loading

coderabbitai bot commented Jul 15, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

cloudflare-workers-and-pages bot commented Jul 15, 2025 •

edited

Loading