Skip to content

Update README cover image #6282

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.

Sign up for GitHub

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

Merged
andremion merged 2 commits into from
Mar 23, 2026
Merged

Update README cover image #6282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
701f178
Update README cover image
andremion Mar 23, 2026
23d5bf8
Merge branch 'develop' into update-github-cover
andremion Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<p align="center">
<a href="https://getstream.io/tutorials/android-chat/">
<img src="/docs/sdk-hero-android.png"/>
<img src="/docs/stream-chat-android-github-cover.png"/>
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Mar 23, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Add alt text to the README hero image.

The <img> tag is missing alt, which triggers MD045 and hurts accessibility/readability in non-visual contexts.

Suggested fix 
-    <img src="/docs/stream-chat-android-github-cover.png"/>
+    <img src="/docs/stream-chat-android-github-cover.png" alt="Stream Chat Android SDK cover image"/>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<img src="/docs/stream-chat-android-github-cover.png"/>
<img src="/docs/stream-chat-android-github-cover.png" alt="Stream Chat Android SDK cover image"/>
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 5-5: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 5, The README hero <img> element is missing an alt
attribute (MD045); update the <img
src="/docs/stream-chat-android-github-cover.png"/> tag in README.md to include a
concise, descriptive alt text (for example alt="Stream Chat Android GitHub
cover" or similar) so the image is accessible to screen readers and non-visual
contexts.

</a>
</p>

Expand Down
Binary file removed docs/sdk-hero-android.png
View file
Open in desktop
Binary file not shown.
Binary file added docs/stream-chat-android-github-cover.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading