docs: improve README formatting and add support sections#597
docs: improve README formatting and add support sections#597
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughThe README.md was restructured with an enhanced header featuring a new tagline, Discord badge, and product GIF. Environment variable configuration table was added. Community section was renamed to License, and a new Support section was introduced with relevant links. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Cherry-picked from #472: - Centered header with professional layout - Environment variables reference table - Contributing, License, and Support sections Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
3fee29b to
db06ab7
Compare
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary
Context
PR #472 proposed a full README rewrite, but was created before the code-graph-backend merge and its setup instructions are no longer accurate. This PR extracts only the formatting and structural improvements that are still valuable.
Test plan
Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com
Summary by CodeRabbit
Documentation