Edu 1954 Improves pub/sub flutter readme - #571
Conversation
|
Warning Rate limit exceeded@franrob-projects has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 53 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
WalkthroughThe README.md file was significantly rewritten to provide a concise, modern overview of the SDK. Detailed usage examples, API descriptions, and setup instructions were removed, replaced with high-level information, minimal usage guidance, and links to external documentation. Badges, warnings, and support links were updated and streamlined. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
README.md (3)
1-1: Alt-text incorrectly mentions “PHP”The hero image alt-text says “PHP Header” even though the document is for the Flutter SDK.
- +
41-45: Admonition syntax isn’t rendered on GitHub
[!NOTE]/[!IMPORTANT]are DocFX-style call-outs; on GitHub they show up literally.
Convert them to a plain blockquote or bold label so they render correctly.-> [!NOTE] -> If your project needs support … +> **Note** +> If your project needs support … ... -> [!IMPORTANT] -> SDK versions < 1.2.25 will be … +> **Important** +> SDK versions < 1.2.25 will be …
49-52: Duplicate section headersBoth “## Install” and “## Installation” appear back-to-back. Keep one to avoid noise.
-## Install - ## Installation
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
images/FlutterSDK-github.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md(1 hunks)
🪛 LanguageTool
README.md
[style] ~74-~74: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 2938 characters long)
Context: ...ter/ably_flutter.dart' as ably; ``` > [!NOTE] > When increasing the version of `...
(EN_EXCESSIVE_EXCLAMATION)
[style] ~121-~121: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...so view all Ably releases on changelog.ably.com. --- ...
(ADVERB_REPETITION_PREMIUM)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~74-~74: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 2938 characters long)
Context: ...ter/ably_flutter.dart' as ably; ``` > [!NOTE] > When increasing the version of `...
(EN_EXCESSIVE_EXCLAMATION)
[style] ~121-~121: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...so view all Ably releases on changelog.ably.com. --- ...
(ADVERB_REPETITION_PREMIUM)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: android (24)
- GitHub Check: ios (iPhone 15)
- GitHub Check: android (29)
- GitHub Check: android
780ed52 to
7e65303
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
README.md (2)
75-106: Code sample still does not compile – wrapper & stray braceSame issue flagged in a previous review: the snippet isn’t inside an
async main()(or other function) and the closing brace at the end is unmatched, so copy-pasting fails to compile.-```dart - // Initialize Ably Realtime client +```dart +void main() async { + // Initialize Ably Realtime client final clientOptions = ably.ClientOptions( @@ await channel.publish( name: 'test-event', data: 'hello world', ); -} +}
111-113: CHANGELOG link points to CONTRIBUTING.mdThe hyperlink label and target don’t match, sending users to the wrong document.
-The [CHANGELOG.md](./CONTRIBUTING.md) contains details of the latest releases for this SDK. +See the [CHANGELOG.md](./CHANGELOG.md) for details of the latest releases for this SDK.
🧹 Nitpick comments (2)
README.md (2)
1-3: Alt-text refers to PHP instead of FlutterThe header image alt-text reads “Ably Pub/Sub PHP Header”, which is misleading in a Flutter README.
- +
41-46: Admonition syntax renders poorly on GitHub
[!NOTE]/[!IMPORTANT]is a Docs-style extension not supported by GitHub Markdown, so readers will just see the raw markup.
Prefer a standard blockquote or bolded heading for better readability.-> [!NOTE] -If your project needs support for … +> **Note** +> If your project needs support for …
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~66-~66: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 2845 characters long)
Context: ...ter/ably_flutter.dart' as ably; ``` > [!NOTE] > When increasing the version of `...
(EN_EXCESSIVE_EXCLAMATION)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: ios
- GitHub Check: android (29)
- GitHub Check: android
- GitHub Check: ios (iPhone 15)
- GitHub Check: android (24)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
README.md (2)
75-105: Code sample still doesn’t compile
Same issue flagged previously: no wrappingmain()and one stray}.```dart - // Initialize Ably Realtime client +void main() async { + // Initialize Ably Realtime client final clientOptions = ably.ClientOptions( key: 'your-ably-api-key', clientId: 'me', ); … await channel.publish( name: 'test-event', data: 'hello world', ); -} +}
111-113: Link points to the wrong fileThe text says CHANGELOG.md but links to CONTRIBUTING.md – same issue as before.
-The [CHANGELOG.md](./CONTRIBUTING.md) contains details of the latest releases for this SDK. +See the [CHANGELOG.md](./CHANGELOG.md) for the latest releases.
🧹 Nitpick comments (2)
README.md (2)
1-3: Alt-text references the wrong SDKThe alt-text still says PHP although this is the Flutter README.
- +
41-46: Admonition syntax won’t render on GitHub
[!NOTE]/[!IMPORTANT]blocks are a Docs-MS extension and appear as plain text on GitHub.
Replace with regular Markdown admonitions, e.g.:> **Note** > If your project …
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
images/FlutterSDK-github.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~66-~66: Using many exclamation marks might seem excessive (in this case: 5 exclamation marks for a text that’s 2845 characters long)
Context: ...ter/ably_flutter.dart' as ably; ``` > [!NOTE] > When increasing the version of `...
(EN_EXCESSIVE_EXCLAMATION)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: android (24)
- GitHub Check: android (29)
- GitHub Check: ios (iPhone 15)
- GitHub Check: android
ab7fbf8 to
e1679ff
Compare
EDU-1954: Adds image EDU-1954: Rewrites introduction and overview EDU-1954: Adds getting started EDU-1954: Rewrites supported platforms section EDU-1954: Deletes install and usage sections EDU-1954: Deletes resources section EDU-1954: Adds release section EDU-1954: Tweaks contribute and support section EDU-1954: Makes sheilds clickable EDU-1954: Adds trimmed install and usage sections
e1679ff to
635863c
Compare
2 participants
This PR streamlines and refocuses the content of README.md to improve readability, simplify navigation, and make ongoing maintenance easier.
Commits
EDU-1954: Adds header and sheild
EDU-1954: Adds image
EDU-1954: Rewrites introduction and overview
EDU-1954: Adds getting started
EDU-1954: Rewrites supported platforms section
EDU-1954: Deletes install and usage sections
EDU-1954: Deletes resources section
EDU-1954: Adds release section
EDU-1954: Tweaks contribute and support section
Jira
https://ably.atlassian.net/browse/EDU-1954
Summary by CodeRabbit