Skip to content

docs: resolve MD045 warnings by adding alt attributes to README icons - #521

Merged
Ryan-Millard merged 3 commits into
Ryan-Millard:devfrom
matteogristina:docs/fix-readme-alt-tags
Jul 14, 2026
Merged

docs: resolve MD045 warnings by adding alt attributes to README icons#521
Ryan-Millard merged 3 commits into
Ryan-Millard:devfrom
matteogristina:docs/fix-readme-alt-tags

Conversation

@matteogristina

Copy link
Copy Markdown
Contributor

Changes & Reason

Changes

  • Added alt attributes to the C, C++, JavaScript, and Python language and package icons in the Multi-Language Support section of README.md.
  • Added empty alt="" attributes to purely decorative JS and Python icons (lines 134 and 165).

Reason

To resolve MD045 warnings, improving the repository's documentation accessibility.

Related Issues

Fixes: #491

Testing & Verification

  • Ran markdownlint-cli locally and verified all MD045 warnings were resolved.
  • Rendered README.md to confirm table layout and formatting remained visually unchanged.

Additional Resources

@coderabbitai

coderabbitai Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 577ef6fd-6208-4519-a148-cb2a2e486a89

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

README image tags for language icons and badges now include explicit alt attributes in the Multi-Language Support table and Quick Start sections.

Changes

README accessibility

Layer / File(s) Summary
Add alt text to README images
README.md
Language icons and package badges in the Multi-Language Support table and Quick Start sections now include explicit alt attributes.

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

Possibly related PRs

Suggested labels: documentation

Suggested reviewers: ryan-millard

Poem

A bunny hops through README light,
Adding alt text crisp and bright.
C and Python, JS too,
Badges gain descriptions new.
Hop, hop, accessibility through!

🚥 Pre-merge checks | ✅ 8
✅ Passed checks (8 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the README alt-text accessibility fix and uses the required Conventional Commit prefix.
Description check ✅ Passed The description matches the README alt-attribute changes and explains the MD045 accessibility motivation.
Linked Issues check ✅ Passed The PR satisfies #491 by adding appropriate alt text to the affected icon images and resolving MD045 warnings.
Out of Scope Changes check ✅ Passed The changes stay focused on README alt attributes and do not introduce unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
No Ai Slop Pr Description ✅ Passed The PR description names the exact README alt-text changes and the reason (fix MD045/accessibility); remaining template text is standard boilerplate, not slop.
No Strangely-Named Root Markdown Files ✅ Passed PR diff only changes README.md; no added root-level markdown files appear in the range.
Coderabbit Config Needs Update ✅ Passed The diff only touches README.md; no new languages, lint/config files, extensions, or CI tooling are introduced, so no .coderabbit.yaml update is needed.
✨ 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.

coderabbitai[bot]
coderabbitai Bot previously approved these changes Jul 14, 2026

@Ryan-Millard Ryan-Millard left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Hi. Welcome to Img2Num!🦔🦔🦔🦔

This looks great! Thank you so much.

It looks like you missed two alt attributes, so please will you update them according to the suggestions I left below. Once that's done this can be merged.

Thanks again. :)

Comment thread README.md Outdated
Comment thread README.md Outdated
@Ryan-Millard
Ryan-Millard changed the base branch from main to dev July 14, 2026 07:39
@Ryan-Millard
Ryan-Millard dismissed coderabbitai[bot]’s stale review July 14, 2026 07:39

The base branch was changed.

Co-authored-by: Ryan Millard <142347829+Ryan-Millard@users.noreply.github.com>
@coderabbitai coderabbitai Bot removed the ux label Jul 14, 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

🤖 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 134: Update the JavaScript icon at README.md lines 134-134 and the Python
icon at README.md lines 165-165 to use empty alt text, `alt=""`, so both
decorative Quick Start icons are hidden from assistive technology.
🪄 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: ASSERTIVE

Plan: Pro

Run ID: 2bfe84ac-b331-41da-a1c6-cdfbbd4fec8e

📥 Commits

Reviewing files that changed from the base of the PR and between d6ba11a and 495ff15.

📒 Files selected for processing (1)
  • README.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md

📄 CodeRabbit inference engine (.editorconfig)

**/*.md: Do not trim trailing whitespace in Markdown files
Use 2-space indentation for Markdown files
Do not enforce maximum line length for Markdown files

Files:

  • README.md
🧠 Learnings (1)
📚 Learning: 2026-02-22T15:20:15.304Z
Learnt from: Ryan-Millard
Repo: Ryan-Millard/Img2Num PR: 263
File: docs/docs/internal/core/api-reference.md:13-13
Timestamp: 2026-02-22T15:20:15.304Z
Learning: In Docusaurus projects, Markdown files (*.md, *.mdx) may contain anchor tags with onClick={(e) => { e.preventDefault(); window.location.href = '...'; }} to force a full page navigation, bypassing React SPA routing for static/external paths. Treat this as intentional and do not flag it as redundant in docs contexts. Apply this guidance broadly to Markdown docs across the repository (not just the single file) and focus reviews on more impactful patterns such as accessibility, SEO, and navigation consistency.

Applied to files:

  • README.md
🔇 Additional comments (1)
README.md (1)

102-105: LGTM!

Comment thread README.md

@Ryan-Millard Ryan-Millard left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thank you! I'm just going to wait for the workflows to run successfully and then I'll merge this.

Have a nice day further!🦔

@Ryan-Millard
Ryan-Millard merged commit d2eb97a into Ryan-Millard:dev Jul 14, 2026
9 checks passed
@Ryan-Millard

Copy link
Copy Markdown
Owner

Thank you again for the great contribution!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add alt text to icon-only badge images in README.md

2 participants