docs: resolve MD045 warnings by adding alt attributes to README icons - #521
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughREADME image tags for language icons and badges now include explicit ChangesREADME accessibility
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Suggested labels: Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 8✅ Passed checks (8 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Ryan-Millard
left a comment
There was a problem hiding this comment.
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. :)
The base branch was changed.
Co-authored-by: Ryan Millard <142347829+Ryan-Millard@users.noreply.github.com>
There was a problem hiding this comment.
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
📒 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!
Ryan-Millard
left a comment
There was a problem hiding this comment.
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!🦔
|
Thank you again for the great contribution! |
Changes & Reason
Changes
altattributes to the C, C++, JavaScript, and Python language and package icons in the Multi-Language Support section ofREADME.md.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
markdownlint-clilocally and verified all MD045 warnings were resolved.README.mdto confirm table layout and formatting remained visually unchanged.Additional Resources