-
Notifications
You must be signed in to change notification settings - Fork 4.4k
Improve alt text in README for accessibility #41441
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: release
Are you sure you want to change the base?
Conversation
Updated the alt text for the Appsmith logo in README.md to be more descriptive for screen readers. This is a small beginner-friendly contribution.
WalkthroughUpdated the alt attribute of the Appsmith logo in README.md from "Appsmith Logo" to "Appsmith Logo – Open Source Low-Code Platform" and removed leading whitespace from the img tag for formatting consistency. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
16-16: Follow-up: Missing alt attribute on Docker badge.While reviewing the file, I noticed Line 16 (Docker pulls badge) lacks an alt attribute, which creates an accessibility gap. Consider adding descriptive alt text to this image as part of a broader accessibility pass.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
*.md
📄 CodeRabbit inference engine (.cursor/rules/task-list.mdc)
Create task lists in a markdown file (in the project root): Use a descriptive name relevant to the feature (e.g.,
ASSISTANT_CHAT.md)
Files:
README.md
🧠 Learnings (2)
📓 Common learnings
Learnt from: brayn003
Repo: appsmithorg/appsmith PR: 40462
File: app/client/src/git/components/ImportOverrideModal/ImportOverrideModalView.tsx:34-40
Timestamp: 2025-04-28T16:16:02.155Z
Learning: The Appsmith team prefers not to include HTML markup in string constants. Text styling or emphasis should be handled through proper React components rather than HTML tags in strings.
📚 Learning: 2024-09-20T14:55:06.929Z
Learnt from: abhvsn
Repo: appsmithorg/appsmith PR: 36458
File: deploy/docker/fs/opt/appsmith/baseline-ce/plugin.jsonl:17-18
Timestamp: 2024-09-20T14:55:06.929Z
Learning: In the product, icon URLs are referred to using 'https://s3.us-east-2.amazonaws.com/assets.appsmith.com/...'.
Applied to files:
README.md
🔇 Additional comments (1)
README.md (1)
1-5: Strong alt text improvement for accessibility.The updated alt text "Appsmith Logo – Open Source Low-Code Platform" provides clear semantic context for screen readers and is more descriptive than the previous "Appsmith Logo". This is a solid accessibility win for the main hero image.
Updated the alt text for the Appsmith logo in README.md to be more descriptive for screen readers. This is a small beginner-friendly contribution.
Description
Tip
Add a TL;DR when the description is longer than 500 words or extremely technical (helps the content, marketing, and DevRel team).
Please also include relevant motivation and context. List any dependencies that are required for this change. Add links to Notion, Figma or any other documents that might be relevant to the PR.
Fixes #
Issue Numberor
Fixes
Issue URLWarning
If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.
Automation
/ok-to-test tags=""
🔍 Cypress test results
Caution
If you modify the content in this section, you are likely to disrupt the CI result for your PR.
Communication
Should the DevRel and Marketing teams inform users about this change?
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.