feat: add live GitHub stars CTA and redesign README banner#46
Conversation
- Add live star count to navbar with star icon and bordered button - Add GitHub Star CTA button in hero with live count from GitHub API - Update description to "open source package manager" - Replace plain ASCII README header with SVG banner - Fix video visibility with clickable thumbnail fallback - Add GitHub stars badge to README badges row
|
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 pull request enhances the documentation and component UI by redesigning the README with improved visual hierarchy, structured tables, and updated marketing copy. It introduces GitHub star counts into the Hero component via a new optional prop and updates App.tsx to pass statistics data through the component hierarchy. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 47-55: The README contains an invalid placeholder URL
"https://github.com/user-attachments/assets/skillkit-demo" which will render
broken; either replace that placeholder with the real uploaded GitHub asset URL
following the pattern "https://github.com/user-attachments/assets/<uuid>" or
remove the entire placeholder line since the clickable thumbnail "[](https://raw.githubusercontent.com/rohitg00/skillkit/main/docs/video/skillkit.mp4)"
already links to the demo; update the README.md by editing the placeholder URL
string or deleting the line accordingly.
🧹 Nitpick comments (3)
docs/skillkit/components/Hero.tsx (2)
164-181: Consider formatting the star count for readability.When
starsexceeds ~999, a raw number like1543can look cramped inside the button. A compact formatter (e.g.,1.5k) would improve readability, especially on narrow viewports.💡 Optional helper
function formatCount(n: number): string { return n >= 1000 ? `${(n / 1000).toFixed(1)}k` : String(n); }Then use
{formatCount(stars)}at Line 178 instead of{stars}.
164-181: Duplicate inline SVG icons across files.The GitHub logo SVG path (Line 169) and star SVG path (Line 176) are duplicated verbatim in
App.tsx(lines 20-23, 123-125). Consider extracting shared icon constants to reduce duplication and ease future changes.README.md (1)
3-7: Both<source>elements point to the same image —<picture>adds no value.Both the dark and light
prefers-color-schemesources referencedocs/img/banner.svg. You can simplify this to a plain<img>tag, or provide a distinct light-mode variant.Simplified version
-<picture> - <source media="(prefers-color-scheme: dark)" srcset="docs/img/banner.svg"> - <source media="(prefers-color-scheme: light)" srcset="docs/img/banner.svg"> - <img alt="SkillKit - One Skill. 32 Agents." src="docs/img/banner.svg" width="100%"> -</picture> +<img alt="SkillKit — One Skill. 32 Agents." src="docs/img/banner.svg" width="100%">
Summary
github/starsshields.io badgeChanges
docs/skillkit/App.tsx- Navbar GitHub stars button with live countdocs/skillkit/components/Hero.tsx- Star CTA button, updated descriptiondocs/img/banner.svg- New dark-themed SVG bannerREADME.md- Redesigned header, video fix, stars badgeTest plan
Summary by CodeRabbit
New Features
Documentation