Skip to content

Documentation: Issue:1257 fix: download section alignment and remove link underlines in README#1384

Merged
rohan-pandeyy merged 1 commit into
AOSSIE-Org:mainfrom
Takitxt:documentation-01
Jul 19, 2026
Merged

Documentation: Issue:1257 fix: download section alignment and remove link underlines in README#1384
rohan-pandeyy merged 1 commit into
AOSSIE-Org:mainfrom
Takitxt:documentation-01

Conversation

@Takitxt

@Takitxt Takitxt commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Addressed Issues:

Fixes #1257 : insert issue number here if you have one>

Screenshots/Recordings:

Documentation Before:
Screenshot 2026-07-18 at 10 37 35 PM

Documentation After:

Screenshot 2026-07-18 at 11 16 52 PM

Problem:

Download section alignment was not proper and there was blue lines behind the download links.

Additional Notes:

Alignment Fix: GitHub's markdown parser strips inline style attributes for security reasons. Swapped CSS for standard HTML align="absmiddle" and height="34" on the <img> tags to force proper vertical alignment with the "Download:" text.

  • Spacing: Added non-breaking spaces (&nbsp;) to give the text breathing room from the buttons.
  • Link Underline Fix: Removed line breaks and whitespaces inside the <a> tags. GitHub was treating the invisible whitespace as link text and rendering default blue underlines next to the images.

AI Usage Disclosure:

We encourage contributors to use AI tools responsibly when creating Pull Requests. While AI can be a valuable aid, it is essential to ensure that your contributions meet the task requirements, build successfully, include relevant tests, and pass all linters. Submissions that do not meet these standards may be closed without warning to maintain the quality and integrity of the project. Please take the time to understand the changes you are proposing and their impact. AI slop is strongly discouraged and may lead to banning and blocking. Do not spam our repos with AI slop.

Check one of the checkboxes below:

  • This PR does not contain AI-generated code at all.
  • [ x ] 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.

I have used the following AI models and tools: TODO

Checklist

  • [ x ] My PR addresses a single issue, fixes a single bug or makes a single improvement.
  • [ x ] My code follows the project's code style and conventions
  • [ x ] If applicable, I have made corresponding changes or additions to the documentation
  • [ x ] If applicable, I have made corresponding changes or additions to tests
  • [ x ] My changes generate no new warnings or errors
  • [ x ] I have joined the Discord server and I will share a link to this PR with the project maintainers there
  • [ x ] I have read the Contribution Guidelines
  • [ x ] Once I submit my PR, CodeRabbit AI will automatically review it and I will address CodeRabbit's comments.
  • [ x ] 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
    • Updated the README download buttons with consistent, simplified formatting.
    • Standardized button image sizing and alignment across platform and GitHub Releases links.

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

coderabbitai Bot commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: 241e4b28-ec59-4886-8c95-f376b57c0499

📥 Commits

Reviewing files that changed from the base of the PR and between 6517bb6 and 45ce31b.

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

Walkthrough

The README download section was reformatted to use compact anchor markup and consistent image attributes while preserving all release links.

Changes

Documentation updates

Layer / File(s) Summary
Download button markup
README.md
Platform and GitHub Releases buttons now use compact <a> tags and images with height="34" and align="absmiddle", removing inline styles.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Suggested labels: Documentation

Suggested reviewers: rohan-pandeyy

Poem

I’m a bunny polishing buttons bright,
Compact little links aligned just right.
Release paths remain in place,
Images hop into a tidier space.
README shines with softer grace! 🐇

🚥 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 title clearly describes the README download-section alignment and underline fix, matching the main change.
Linked Issues check ✅ Passed The README download-section polish aligns with issue #1257's documentation presentation and readability goals.
Out of Scope Changes check ✅ Passed The changes are limited to README documentation formatting and do not introduce unrelated scope.
✨ 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.

@Takitxt

Takitxt commented Jul 18, 2026

Copy link
Copy Markdown
Contributor Author

@rohan-pandeyy can you please review this PR.

@rohan-pandeyy
rohan-pandeyy merged commit 7f7c87c into AOSSIE-Org:main Jul 19, 2026
9 checks passed
@rohan-pandeyy

Copy link
Copy Markdown
Member

Thank you @Takitxt

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: Visual & Structural Improvements (Multi-assignable issue)

2 participants