Skip to content

docs: improve README - reorder badges, add downloads, fix dark/light diagram, fix contributor note#1281

Merged
rohan-pandeyy merged 3 commits into
AOSSIE-Org:mainfrom
Umang-Khemka:fix/readme-improvements
May 24, 2026
Merged

docs: improve README - reorder badges, add downloads, fix dark/light diagram, fix contributor note#1281
rohan-pandeyy merged 3 commits into
AOSSIE-Org:mainfrom
Umang-Khemka:fix/readme-improvements

Conversation

@Umang-Khemka

@Umang-Khemka Umang-Khemka commented May 23, 2026

Copy link
Copy Markdown
Contributor

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:

  • This PR does not contain AI-generated code at all.
  • This PR contains AI-generated code. I have read the AI Usage Policy and this PR complies with this policy. I have tested the code locally and I am responsible for it.

Checklist

  • My PR addresses a single issue, fixes a single bug or makes a single improvement.
  • My code follows the project's code style and conventions
  • If applicable, I have made corresponding changes or additions to the documentation
  • If applicable, I have made corresponding changes or additions to tests
  • My changes generate no new warnings or errors
  • I have joined the Discord server and I will share a link to this PR with the project maintainers there
  • I have read the Contribution Guidelines
  • Once I submit my PR, CodeRabbit AI will automatically review it and I will address CodeRabbit's comments.
  • I have filled this PR template completely and carefully, and I understand that my PR may be closed without review otherwise.

Summary by CodeRabbit

  • Documentation
    • Added a centered Downloads row with platform-specific links (Windows, macOS, Debian) and a GitHub Releases link.
    • Reordered and reflowed centered social badges for improved sequence and layout while keeping the YouTube badge.
    • Switched architecture diagram to separate light/dark-mode images for clearer rendering.
    • Updated contributor acknowledgment text to reference “PictoPy”.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 23, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 220ed9f7-5751-443c-93bf-52eddc5fafe8

📥 Commits

Reviewing files that changed from the base of the PR and between 30fceea and 31d8e35.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

Walkthrough

README.md updates: social badge order revised, a centered Downloads row with platform links added, architecture diagram markup switched to light/dark <img> elements, and the contributor thanks line corrected to “PictoPy”.

Changes

README Documentation Updates

Layer / File(s) Summary
Social badges and downloads section
README.md
Social badges reordered (Discord, X, LinkedIn, Medium, Telegram, YouTube kept) and a centered "Download" row added with Windows, MacOS, Debian links and a "GitHub Releases" link.
Architecture diagram light/dark images
README.md
Replaces <picture>/<source> markup with two mode-specific <img> elements so the High Level Architecture diagram displays correctly in light and dark themes.
Contributor thanks correction
README.md
Updates the contributor appreciation line to use "PictoPy" instead of "TODO".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

Documentation

Poem

🐰 A README hops in line,
Badges tidy, links to find,
Downloads perched in view,
Diagrams match dark and light,
PictoPy thanks — a cheerful bite.

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title clearly and concisely summarizes the main README improvements: badge reordering, downloads section, dark/light diagram fix, and contributor note update.
Linked Issues check ✅ Passed All four objectives from issue #1277 are addressed: badges reordered correctly, download links added with platform options, diagram markup fixed for light/dark mode, and TODO replaced with PictoPy.
Out of Scope Changes check ✅ Passed All changes are limited to README.md and directly aligned with issue #1277 objectives; no unrelated modifications detected.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 23, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
README.md (1)

110-111: README assets: referenced architecture SVGs exist (no broken-link risk)
Both docs/assets/architectual-design-light.svg and docs/assets/architectual-design-dark.svg are present, matching the README.md image src values.
Optional: consider renaming architectualarchitectural in 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

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: f386bb22-216c-4afd-b30f-5000a88eff8b

📥 Commits

Reviewing files that changed from the base of the PR and between 84985f6 and 770c820.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md

@rohan-pandeyy rohan-pandeyy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution @Umang-Khemka

@rohan-pandeyy rohan-pandeyy merged commit 80ba26e into AOSSIE-Org:main May 24, 2026
7 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request May 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation good first issue Good for newcomers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: Improve README Socials, Downloads, Theme Support & Contributor Note

2 participants