docs(ui,llc): update sdk readmes#2724
Merged
Merged
Conversation
Contributor
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## v10.0.0 #2724 +/- ##
===========================================
+ Coverage 67.84% 68.16% +0.32%
===========================================
Files 411 413 +2
Lines 24632 24851 +219
===========================================
+ Hits 16711 16940 +229
+ Misses 7921 7911 -10 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 12
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/stream_chat_flutter_core/README.md`:
- Line 15: The "### Changelog" heading violates markdown hierarchy (MD001);
update the heading text "### Changelog" to a second-level heading "## Changelog"
so it fits the surrounding sections and resolves the lint error.
- Line 33: Replace the invalid placeholder dependency line in README.md so it’s
copy-pasteable: change "stream_chat_flutter_core: ^latest_version" to either a
real semver (e.g. "stream_chat_flutter_core: ^4.7.0") or an explicit placeholder
like "stream_chat_flutter_core: <latest_version>" and add a short note after the
snippet stating "<latest_version> must be replaced with a real version in your
pubspec.yaml"; update the README snippet near the dependency example to reflect
this change so users won’t get a pub resolution error when pasting.
In `@packages/stream_chat_flutter/README.md`:
- Line 17: Change the Changelog heading from "### Changelog" to "## Changelog"
in the README so heading levels are normalized; update the line containing the
"Changelog" heading text to use two hashes instead of three to avoid skipping
heading levels.
- Line 3: Replace the empty alt label in the hero image markdown with a
meaningful description to improve accessibility: update the
``
line in README.md to use a descriptive alt text (for example ``) so
the image token conveys its content to screen readers and markdown renderers.
In `@packages/stream_chat_localizations/README.md`:
- Line 112: In the README sentence starting "For translations to work on **iOS**
you need to add supported locales..." replace the non-descriptive anchor text
"here" with a meaningful label such as "Flutter docs: Localizing for iOS —
updating the iOS app bundle" (or similar descriptive text) so the link clearly
describes its destination; update the markdown link text while keeping the same
URL.
- Line 15: The "Changelog" heading uses "### Changelog" which skips a level
after the README H1; update the heading to "## Changelog" so the markdown
heading hierarchy is consistent (replace the token "### Changelog" with "##
Changelog" in the README.md).
- Line 41: Replace the legacy pub.dartlang.org URL with the canonical pub.dev
URL in the README: update the markdown link and badge target that currently
point to "https://pub.dartlang.org/packages/stream_chat_localizations" to
"https://pub.dev/packages/stream_chat_localizations" (and ensure the badge
image/link references use pub.dev instead of pub.dartlang.org).
In `@packages/stream_chat_persistence/README.md`:
- Line 76: Replace the ambiguous link text "here" with a descriptive label to
improve accessibility and scanability; update the README sentence that mentions
"sql-wasm.js" and "sql-wasm.wasm" so the link text reads something like "sql.js
releases" (e.g., "You can grab the latest version of `sql-wasm.js` and
`sql-wasm.wasm` from the sql.js releases and copy them into your `/web`
folder.") so the anchor clearly describes the destination.
- Line 15: Update the Markdown heading "### Changelog" to use a level-2 heading
"## Changelog" so the document's heading hierarchy is consistent; locate the
heading string "### Changelog" in README.md and replace it with "## Changelog".
In `@packages/stream_chat/README.md`:
- Line 15: The Changelog heading uses "### Changelog" which skips a level;
update the markdown heading to "## Changelog" so the document heading hierarchy
is correct and sequential (replace the "### Changelog" line in the README with
"## Changelog").
In `@README.md`:
- Line 3: The hero image markdown lacks alt text; update the image tag that
references
https://raw.githubusercontent.com/GetStream/stream-chat-flutter/master/images/sdk_hero_v10.png
to include a descriptive alt string (e.g. change
 to something like ), ensuring the alt text succinctly
describes the image for accessibility and to satisfy MD045.
- Line 124: The README link labeled "versioning policy documentation" currently
points to the Flutter SDK installation path; update the href so the label and
target match by replacing the URL
"https://getstream.io/chat/docs/sdk/flutter/basics/installation/" with the
actual versioning policy page URL (or alternatively change the link text to
"installation" if you prefer to keep the current target) so the sentence's link
target aligns with the label.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 916e58cc-6f7d-4d88-b2a1-ee9e43b75c64
⛔ Files ignored due to path filters (2)
images/sdk_hero_v10.pngis excluded by!**/*.pngimages/sdk_hero_v4.pngis excluded by!**/*.png
📒 Files selected for processing (7)
README.mdpackages/stream_chat/README.mdpackages/stream_chat_flutter/README.mdpackages/stream_chat_flutter_core/README.mdpackages/stream_chat_localizations/README.mdpackages/stream_chat_persistence/README.mdsample_app/README.md
xsahil03x
approved these changes
Jun 9, 2026
renefloor
force-pushed
the
docs/update-readmes
branch
from
7e3e3b1 to
359c8dd
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Submit a pull request
CLA
Description of the pull request
This updates the content and the structure of the readmes of the sdks and the repo. It also refreshes the banner.
Summary by CodeRabbit