Skip to content

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

Open
Umang-Khemka wants to merge 1 commit into
AOSSIE-Org:mainfrom
Umang-Khemka:fix/readme-improvements
Open

docs: improve README - reorder badges, add downloads, fix dark/light diagram, fix contributor note#1281
Umang-Khemka wants to merge 1 commit into
AOSSIE-Org:mainfrom
Umang-Khemka:fix/readme-improvements

Conversation

@Umang-Khemka
Copy link
Copy Markdown

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

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 new Downloads section with platform-specific release badges for Windows, macOS, and Linux to streamline access to latest releases.
    • Reorganized social media links for improved layout and readability.
    • Enhanced architecture diagram display formatting.
    • Corrected contributor attribution in the documentation.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 23, 2026

Walkthrough

README.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.

Changes

README Documentation Updates

Layer / File(s) Summary
Social badges and downloads section
README.md
Social badge order is rearranged to Discord, X, LinkedIn, Medium, Telegram, and a new Downloads section with centered badges is added linking to Windows, macOS, and Linux releases on GitHub.
Architecture diagram dark mode support
README.md
Architecture diagram rendering is updated from <picture>/<source> markup to two <img> tags with GitHub light/dark mode selectors for proper theme switching.
Contributor thanks correction
README.md
Contributor appreciation text is corrected to say "PictoPy" instead of "TODO".

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • AOSSIE-Org/PictoPy#1258: Overlapping README refactor work on social badge section and architecture diagram markup.

Suggested labels

Documentation

Suggested reviewers

  • rohan-pandeyy

Poem

🐰 A README takes flight,
With badges shining bright,
Downloads now in view,
Dark mode gets its due,
PictoPy thanks alight! ✨

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes all four main changes: reordering badges, adding downloads, fixing the dark/light diagram, and fixing the contributor note.
Linked Issues check ✅ Passed All four tasks from issue #1277 are addressed: social badges reordered, downloads section added with platform release badges, architecture diagram fixed for light/dark mode switching, and contributor note corrected from TODO to PictoPy.
Out of Scope Changes check ✅ Passed All changes are within scope—only README.md was modified with documentation improvements directly addressing the four tasks outlined in issue #1277.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ 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
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

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
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

1 participant