Skip to content

Add a Learnings overview page. #454

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 6 commits into from
Jul 30, 2025
Merged

Add a Learnings overview page. #454

merged 6 commits into from
Jul 30, 2025

Conversation

jmacdotorg
Copy link
Contributor

@jmacdotorg jmacdotorg commented Jul 15, 2025 •
edited
Loading

@jmacdotorg jmacdotorg requested a review from a team as a code owner July 15, 2025 21:00
@jmacdotorg jmacdotorg requested review from helizaga and sleep-404 July 15, 2025 21:00
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 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
Loading

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 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 60fa30f and 9f0b665.

📒 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 branch learnings

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 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 Cloudflare Workers and Pages
Copy link

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

Deploying coderabbit-docs with  Cloudflare Pages  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

@jmacdotorg jmacdotorg requested review from SahanaVP and 89hardy and removed request for a team, helizaga and sleep-404 July 21, 2025 19:23
@edgarcerecerez edgarcerecerez self-requested a review July 21, 2025 21:27
89hardy
89hardy reviewed Jul 24, 2025
View reviewed changes
Copy link

@89hardy 89hardy left a comment

Choose a reason for hiding this comment

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

Suggested some minor changes. Rest looks good.

@jmacdotorg jmacdotorg requested a review from 89hardy July 28, 2025 18:28
@jmacdotorg jmacdotorg enabled auto-merge (squash) July 30, 2025 16:56
@jmacdotorg jmacdotorg merged commit 4842c64 into main Jul 30, 2025
4 checks passed
@jmacdotorg jmacdotorg deleted the learnings branch July 30, 2025 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

@aravindputrevu aravindputrevu Awaiting requested review from aravindputrevu

@SahanaVP SahanaVP Awaiting requested review from SahanaVP

@edgarcerecerez edgarcerecerez Awaiting requested review from edgarcerecerez

@89hardy 89hardy Awaiting requested review from 89hardy

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

We need a page about Learnings
2 participants
@jmacdotorg @89hardy
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy