Skip to content

docs: refresh README cover image and remove stale screenshots#3589

Merged
oliverlaz merged 1 commit into
developfrom
docs/refresh-readme-cover
May 11, 2026
Merged

docs: refresh README cover image and remove stale screenshots#3589
oliverlaz merged 1 commit into
developfrom
docs/refresh-readme-cover

Conversation

@oliverlaz
Copy link
Copy Markdown
Member

🎯 Goal

Refresh the SDK's README cover image and clean up the long-unused screenshots/ directory.

πŸ›  Implementation details

  • Added new cover at .readme-assets/stream-chat-react-native-cover.png.
  • Updated README.md and examples/SampleApp/README.md to reference the new asset via relative paths (also improved alt text).
  • Deleted the entire screenshots/ directory (~16 MB, last touched in 2022). References to it from package/CHANGELOG.md are historical entries with already-broken relative paths and are intentionally left untouched.

🎨 UI Changes

No app-side UI changes β€” README cover image only.

πŸ§ͺ Testing

  • Verified the new image renders in both READMEs locally.
  • Confirmed no remaining non-historical references to screenshots/.

β˜‘οΈ Checklist

  • I have signed the Stream CLA (required)
  • PR targets the develop branch
  • Documentation is updated
  • New code is tested in main example apps, including all possible scenarios
    • SampleApp iOS and Android
    • Expo iOS and Android

@oliverlaz oliverlaz requested review from isekovanic and szuperaz May 11, 2026 11:59
@oliverlaz oliverlaz merged commit e3fe6c7 into develop May 11, 2026
5 checks passed
@oliverlaz oliverlaz deleted the docs/refresh-readme-cover branch May 11, 2026 12:02
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.

2 participants