Skip to content

Fix README.md#1283

Merged
rohan-pandeyy merged 3 commits into
AOSSIE-Org:mainfrom
rohan-pandeyy:update-readme
May 24, 2026
Merged

Fix README.md#1283
rohan-pandeyy merged 3 commits into
AOSSIE-Org:mainfrom
rohan-pandeyy:update-readme

Conversation

@rohan-pandeyy
Copy link
Copy Markdown
Contributor

@rohan-pandeyy rohan-pandeyy commented May 24, 2026

Summary by CodeRabbit

  • Documentation
    • Updated README visuals with new banner, demo, and architecture diagrams.
    • Simplified the Download section to use inline image-based links for a cleaner look.
    • Replaced prior external/icon imagery with local readme asset variants for consistent branding.

Review Change Stack

@rohan-pandeyy rohan-pandeyy added the bug Something isn't working label May 24, 2026
@github-actions
Copy link
Copy Markdown
Contributor

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 24, 2026

Warning

Review limit reached

@rohan-pandeyy, we couldn't start this review because you've used your available PR reviews for now.

Your plan currently allows 2 reviews/hour. Refill in 18 minutes and 36 seconds.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more review capacity refills, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 trial, open-source, and free plans. In all cases, review capacity refills continuously over time.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: ea1924e1-9ccc-4fac-be14-f6a28b129084

📥 Commits

Reviewing files that changed from the base of the PR and between 9ea322f and 8bcbd00.

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

Walkthrough

The PR updates README.md branding and asset references: banner, demo, and architecture diagram sources now point to docs/assets/readme-assets/. The Download section’s CTA is refactored to inline-flex anchor buttons using local btn-*.svg images while preserving existing download URLs.

Changes

README Branding and Asset Refresh

Layer / File(s) Summary
Visual assets and branding paths
README.md
Banner, demonstration, and architecture diagram image sources are updated to point to docs/assets/readme-assets/ variants for both light and dark modes.
Download CTA button markup refresh
README.md
Download call-to-action rewritten to use a <strong>Download:</strong> label and inline-flex anchors wrapping local btn-windows.svg, btn-macos.svg, btn-debian.svg, and btn-github.svg, retaining the same release download targets.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • AOSSIE-Org/PictoPy#1281: Overlapping README.md changes that update branding and asset links for header, demo, and architecture diagram imagery.
  • AOSSIE-Org/PictoPy#1258: Related README.md updates to header/banner imagery and architecture diagram assets.

Suggested labels

Documentation

Poem

🐰 I hopped through lines of markdown bright,
Swapped banners and demos to look just right,
Buttons now snug with tiny SVG eyes,
Readme-assets gleam beneath project skies,
A tiny rabbit pats the README with delight.

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Fix README.md' is vague and does not convey what specific changes were made to the README or why they were necessary. Use a more descriptive title that explains the specific changes, such as 'Update README.md to reference new image assets in docs/assets/readme-assets/' or 'Simplify README.md Download section markup with local SVG assets'.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

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

🤖 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`:
- Around line 39-46: The README contains hardcoded hrefs mixing
"/releases/latest/download" with a versioned filename (seen on the Windows,
macOS, and Debian download anchor tags / images), which will 404 when the latest
release changes; update those three anchor hrefs either to fully pinned URLs
using the release tag and matching filenames (e.g.,
"/releases/download/v1.1.0/…") or change them to point users to the OS-specific
release page (e.g., the repository's "/releases/latest" or the general release
page) so filenames aren't required; ensure the Windows download anchor, the
macOS download anchor, and the Debian download anchor are all updated
consistently and verify the alt text/button images remain the same.
🪄 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: c94eaadb-fc65-42af-b051-6ad924ac628c

📥 Commits

Reviewing files that changed from the base of the PR and between 80ba26e and 480edab.

⛔ Files ignored due to path filters (8)
  • docs/assets/readme-assets/architectual-design-dark.svg is excluded by !**/*.svg
  • docs/assets/readme-assets/architectual-design-light.svg is excluded by !**/*.svg
  • docs/assets/readme-assets/banner.png is excluded by !**/*.png
  • docs/assets/readme-assets/btn-debian.svg is excluded by !**/*.svg
  • docs/assets/readme-assets/btn-github.svg is excluded by !**/*.svg
  • docs/assets/readme-assets/btn-macos.svg is excluded by !**/*.svg
  • docs/assets/readme-assets/btn-windows.svg is excluded by !**/*.svg
  • docs/assets/readme-assets/demo.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
Comment on lines +39 to +46
<a href="https://github.com/AOSSIE-Org/PictoPy/releases/latest/download/PictoPy_1.1.0_x64-setup.exe" style="display:inline-flex;align-items:center;">
<img src="docs/assets/readme-assets/btn-windows.svg" alt="Windows download button" style="height:34px;width:auto;" />
</a>
<a href="https://github.com/AOSSIE-Org/PictoPy/releases/latest/download/PictoPy_aarch64.app.tar.gz" style="display:inline-flex;align-items:center;">
<img src="docs/assets/readme-assets/btn-macos.svg" alt="macOS download button" style="height:34px;width:auto;" />
</a>
<a href="https://github.com/AOSSIE-Org/PictoPy/releases/latest/download/PictoPy_1.1.0_amd64.deb" style="display:inline-flex;align-items:center;">
<img src="docs/assets/readme-assets/btn-debian.svg" alt="Debian download button" style="height:34px;width:auto;" />
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.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Use stable release-link strategy for OS download URLs.

These links mix releases/latest/download with versioned artifact names (PictoPy_1.1.0_...). When “latest” advances and filenames change, these URLs can 404.

Prefer either:

  • pinning both tag and filename (e.g. /releases/download/v1.1.0/...), or
  • linking users to the latest release page per OS instead of versioned direct assets.

As per coding guidelines, "Confirm that the code meets the project's requirements and objectives".

🤖 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 39 - 46, The README contains hardcoded hrefs mixing
"/releases/latest/download" with a versioned filename (seen on the Windows,
macOS, and Debian download anchor tags / images), which will 404 when the latest
release changes; update those three anchor hrefs either to fully pinned URLs
using the release tag and matching filenames (e.g.,
"/releases/download/v1.1.0/…") or change them to point users to the OS-specific
release page (e.g., the repository's "/releases/latest" or the general release
page) so filenames aren't required; ensure the Windows download anchor, the
macOS download anchor, and the Debian download anchor are all updated
consistently and verify the alt text/button images remain the same.

@github-actions
Copy link
Copy Markdown
Contributor

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

Updated download links for various platforms in the README.
@github-actions
Copy link
Copy Markdown
Contributor

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

@rohan-pandeyy rohan-pandeyy merged commit a20c1bb into AOSSIE-Org:main May 24, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant