docs: improve README - reorder badges, add downloads, fix dark/light diagram, fix contributor note#1281
Conversation
…ture diagram, fix contributor note
WalkthroughREADME.md is updated with four documentation improvements: social badge reordering and new Downloads section for platform releases, architecture diagram dark mode selector fix, and corrected contributor thanks message. ChangesREADME Documentation Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 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
🧹 Nitpick comments (1)
README.md (1)
110-111: README assets: referenced architecture SVGs exist (no broken-link risk)
Bothdocs/assets/architectual-design-light.svganddocs/assets/architectual-design-dark.svgare present, matching theREADME.mdimagesrcvalues.
Optional: consider renamingarchitectual→architecturalin filenames + README for spelling consistency.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 110 - 111, Rename the two SVG assets and their references in the README from "architectual" to the correct spelling "architectural": rename docs/assets/architectual-design-light.svg → docs/assets/architectural-design-light.svg and docs/assets/architectual-design-dark.svg → docs/assets/architectural-design-dark.svg, then update the <img> src values in README.md to match those new filenames (and search the repo for any other occurrences of "architectual" to update). Ensure the updated alt text or captions remain accurate if you change them.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 12: The README contains a non-canonical Discord invite link; update the
anchor href in README.md to use the canonical invite URL defined in mkdocs.yml
(the social.discord entry referenced around lines 84-100) so both locations
point to the same invite and avoid fragmenting community entry points.
---
Nitpick comments:
In `@README.md`:
- Around line 110-111: Rename the two SVG assets and their references in the
README from "architectual" to the correct spelling "architectural": rename
docs/assets/architectual-design-light.svg →
docs/assets/architectural-design-light.svg and
docs/assets/architectual-design-dark.svg →
docs/assets/architectural-design-dark.svg, then update the <img> src values in
README.md to match those new filenames (and search the repo for any other
occurrences of "architectual" to update). Ensure the updated alt text or
captions remain accurate if you change them.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Summary
docs: improve README - reorder badges, add downloads, fix dark/light architecture diagram, fix contributor note
Addressed Issues:
Fixes #1277
Screenshots/Recordings:
N/A - README-only changes. Architecture diagram light/dark switching verified on GitHub.
Additional Notes:
All changes are limited to README.md only. No code, tests, or other files were modified.
Check one of the checkboxes below:
Checklist
Summary by CodeRabbit