WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Conversation

@Elphazy
Copy link

@Elphazy Elphazy commented Dec 3, 2025

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=""

🔍 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.

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.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 3, 2025

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between 780c3c8 and 05a7f72.

📒 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.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant