appsmith icon indicating copy to clipboard operation
appsmith copied to clipboard

Improve alt text in README for accessibility

Open Elphazy opened this issue 4 weeks ago • 1 comments

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 Number
or
Fixes Issue URL

[!WARNING]
If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags=""

:mag: 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?

  • [ ] Yes
  • [ ] No

Summary by CodeRabbit

  • Documentation
    • Updated the platform logo description text in the README for improved clarity and accessibility.

✏️ Tip: You can customize this high-level summary in your review settings.

Elphazy avatar Dec 03 '25 10:12 Elphazy

Walkthrough

Updated 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

Cohort / File(s) Summary
Documentation
README.md
Updated logo alt text for improved accessibility/SEO; removed leading indentation before img tag

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

📝 A logo's alt text grew a heart so grand,
From simple words to vision—now all understand.
Whitespace trimmed, the README stands tall,
Accessibility blooms with metadata for all! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete. The author provided context about the change but didn't populate the required 'Fixes' field with an issue reference, which is flagged as requiring maintainer check per the template. Add a reference to the related issue (Fixes #<issue_number>) or confirm with maintainers if no issue exists, as required by the template.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: improving alt text for accessibility in the README. It's specific, concise, and directly reflects the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment

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.

coderabbitai[bot] avatar Dec 03 '25 10:12 coderabbitai[bot]

This PR has not seen activitiy for a while. It will be closed in 7 days unless further activity is detected.

github-actions[bot] avatar Dec 10 '25 16:12 github-actions[bot]

This PR has been closed because of inactivity.

github-actions[bot] avatar Dec 17 '25 16:12 github-actions[bot]