docs: Introduced Learning page into Docs #362

[syedalinaqihasni]

Fixes: #362
Requester: @jmacdotorg

Summary

This PR adds a new “Learnings” documentation page to the CodeRabbit docs, showcasing code review insights, AI behaviors, and architectural context via curated video content.

Details

• Created a new file at docs/overview/learnings.md.
• Embedded 12 YouTube videos from the CodeRabbit YouTube channel that highlight:
  • Real-world code review walkthroughs
  • Best practices and learnings from open-source projects
  • Architectural and training deep-dives
  • IDE/plugin integrations and setup demos
• Each video section includes:
  • A clear title as a heading
  • A short caption/description
  • Responsive video embed using the .video-container pattern

Motivation

To help users:

• Learn from practical examples and real pull request reviews
• Understand CodeRabbit’s training and architecture
• Explore how AI-enhanced code reviews are applied across real projects

This page is also intended to improve onboarding and help developers build intuition around how CodeRabbit operates.

Reviewer Notes

• Confirm embed layout and responsiveness across breakpoints
• Review descriptions for clarity, tone, and alignment with CodeRabbit voice
• Feel free to suggest any additional video sections or restructuring

[coderabbitai]

Caution

Review failed

Failed to post review comments.

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

📥 Commits

Reviewing files that changed from the base of the PR and between f17aa48 and 70e1e31.

📒 Files selected for processing (3)

• docs/overview/introduction.md (1 hunks)
• docs/overview/learnings.md (1 hunks)
• sidebars.ts (1 hunks)

🔇 Additional comments (1)

sidebars.ts (1)

35-39: Ordering looks good – no issues

The new “overview/learnings” entry is correctly positioned between “introduction” and “quickstart”, matches the sidebar_position in the doc, and the trailing comma is fine in TS. 👍

Walkthrough

A new "Learnings" documentation page was added under the overview section, featuring curated educational resources and embedded videos. The introduction page was updated to link to this new page, and the sidebar configuration was modified to include the "Learnings" page in the navigation flow.

Changes

File(s)	Change Summary
docs/overview/introduction.md	Added a "What's next" bullet linking to the new "Learnings" page.
docs/overview/learnings.md	Created a new "Learnings" documentation page with curated content and embedded YouTube videos.
sidebars.ts	Updated sidebar to include "overview/learnings" in the "Get started with CodeRabbit" category.

Assessment against linked issues

Objective	Addressed	Explanation
Create a "Learnings" page and link to the existing video (#362)	✅

Poem

In the docs, a new page shines bright,
With lessons and videos, pure delight!
The sidebar now guides you to learn and explore,
With summaries and links, there’s knowledge galore.
Hop along, dear coder, and see what’s in store—
For every review is a chance to learn more!
🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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