Skip to content

We need a page about Learnings #362

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.

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

Open
jmacdotorg opened this issue May 27, 2025 · 2 comments
Open

We need a page about Learnings #362

jmacdotorg opened this issue May 27, 2025 · 2 comments
Labels
needs triage A new docs bug that needs to be processed and planned by the docs project owners

Comments

@jmacdotorg
Copy link
Collaborator

And it should link to the video that already exists.

@jmacdotorg jmacdotorg added the needs triage A new docs bug that needs to be processed and planned by the docs project owners label May 27, 2025
Copy link

linear bot commented May 27, 2025

Copy link

traycerai bot commented May 27, 2025

Plan

Observations

The documentation site uses Docusaurus with all content under docs/. Videos are embedded via a <div class="video-container"> wrapper and a raw HTML <iframe>, styled by .video-container in src/css/custom.css. The sidebar is manually defined in sidebars.ts, with a "Get started with CodeRabbit" category containing "overview/introduction" and "getting-started/quickstart". All naming conventions and routing are standard, and no conflicts exist for a new learnings.md page.

Approach

  1. Create a new Markdown file under docs/overview/learnings.md with proper frontmatter and a brief introduction.
  2. Embed the existing YouTube video (Yu0cmmOYA-U) using the documented HTML pattern and .video-container class.
  3. Modify sidebars.ts to add "overview/learnings" in the "Get started with CodeRabbit" items array immediately after "overview/introduction".
  4. Run the local dev server to verify rendering, navigation, and responsiveness.

Reasoning

I reviewed the codebase structure, confirmed embedding patterns and CSS support, inspected the sidebar configuration, and validated docs directory conventions. All assumptions were clarified via targeted analysis of docs/overview/introduction.md, src/css/custom.css, sidebars.ts, and related files.

Proposed File Changes

📄 docs/overview/learnings.md (NEW) 🔗

References

Create a new Markdown document at docs/overview/learnings.md with the following structure:

  1. Frontmatter:
---
id: learnings
title: Learnings
sidebar_label: Learnings
sidebar_position: 3
description: Insights and learnings captured from code reviews to enhance future development.
---
  1. Content:
  • Briefly describe the purpose of "Learnings" in CodeRabbit.
  • Embed the video using the .video-container wrapper:
<div class="video-container">
  <iframe src="https://www.youtube.com/embed/Yu0cmmOYA-U" title="CodeRabbit Learnings Video" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerPolicy="strict-origin-when-cross-origin" allowFullScreen></iframe>
</div>
  • Optionally add a call to action encouraging users to watch and explore.
📄 sidebars.ts (MODIFY) 🔗

References

Open sidebars.ts, locate the docsSidebar entry for the "Get started with CodeRabbit" category, and update its items array by inserting "overview/learnings" after "overview/introduction". The new snippet should read:

items: [
  "overview/introduction",
  "overview/learnings",
  "getting-started/quickstart"
]

Import In IDE

VSCode Icon Cursor Icon Windsurf Icon

Developer Humor

Here’s a brand-new page to explore,
A video and insights to adore! 🎥
Learnings now have their own home,
No more hunting—no need to roam.
CodeRabbit knowledge, forevermore! 🐇✨


Execution Information

Branch: main
Commit: 002a4b4


💡 Tips

Supported Commands (Inside Comments)

  • Use @traycerai generate to iterate on the previous version of the implementation plan.

Supported Commands (Inside Description)

  • Add @traycerai ignore anywhere in the ticket description to prevent this ticket from being processed.
  • Add @traycerai branch:<branch-name> anywhere in the ticket description to specify the target branch for the implementation plan.

Community

  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs triage A new docs bug that needs to be processed and planned by the docs project owners
Projects
None yet
Development

No branches or pull requests

1 participant