Edu 1956 Improves Pub/Sub dotnet readme - #1297
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThe README.md file was rewritten and condensed, transforming it from a detailed, example-rich document into a concise overview. Most in-depth usage examples and explanations were removed, with the new version focusing on a high-level introduction, supported platforms, and links to external documentation and resources. Changes
Assessment against linked issues
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
✨ 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 (
|
5ee331d to
9a99b65
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
README.md (2)
75-76: Capitalize “Framework” and clean up formatting
- Update the heading to “.NET Framework” (capitalize “Framework”).
- Remove the extra space before the comma in “scenarios, for example.”
-### Increasing transport send and receive buffers for .NET framework +### Increasing transport send and receive buffers for .NET Framework - In high-throughput scenarios , for example + In high-throughput scenarios, for example
85-93: Optional: Simplify namespace usage in snippet
To improve clarity, consider addingusing IO.Ably;at the top of the snippet and then instantiating the transport factory without full qualification:using IO.Ably; // ... options.TransportFactory = new MsWebSocketTransport.TransportFactory(websocketOptions);
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
images/NETSDK-github.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~47-~47: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ... issues caused by assembly trimming, as ably-dotnet relies on the reflection API. To avoid...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
[uncategorized] ~61-~61: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...``` --- ## Releases The CHANGELOG.md contains det...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
[style] ~61-~61: 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)
[misspelling] ~67-~67: Did you mean “too”?
Context: ...NTRIBUTING.md) guidelines to contribute to Ably. --- ## Support, feedback and tr...
(TO_TOO)
[grammar] ~75-~75: There seems to be a noun/verb agreement error. Did you mean “sends” or “sent”?
Context: ... discussions. ### Increasing transport send and receive buffers for .NET framework ...
(SINGULAR_NOUN_VERB_AGREEMENT)
🪛 markdownlint-cli2 (0.17.2)
README.md
22-22: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: check (net7.0)
🔇 Additional comments (10)
README.md (10)
1-3: Verify badge URLs and image paths
The NuGet badge referencesably.ioand the header image path should be confirmed against the repo’s file structure to ensure they resolve correctly.
5-5: Title header looks good
The main heading clearly identifies the SDK and aligns with the repository name.
9-9: Approve feature summary
The concise description of key features (pub-sub messaging, history, presence, push notifications) is clear and accurate.
13-14: Approve external links
The links to documentation and examples correctly point users to the right resources.
18-24: Approve Getting started section
The new “Getting started” section succinctly directs users to the Quickstart guide.
26-38: Approve Supported platforms table
The platform support matrix is clear, comprehensive, and formatted correctly.
40-43: Approve deprecation notice
The note on upcoming deprecation timelines is prominently displayed and properly highlighted.
45-55: Approve MAUI configuration snippet
The example for preventing assembly trimming is clear and includes the correct XML elements.
65-69: Approve Contributing section
Linking to the CONTRIBUTING guidelines is helpful for potential contributors.
71-74: Approve Support section header
This section clearly directs users to support channels for assistance and feedback.
|
|
||
| Request a `Vcdiff` formatted delta stream using channel options when you get the channel: | ||
|
|
||
| ```csharp | ||
| var channelParams = new ChannelParams(); | ||
| channelParams.Add("delta", "vcdiff"); | ||
| var channelOptions = new ChannelOptions(); | ||
| channelOptions.Params = channelParams; | ||
| IRealtimeChannel channel = ably.Channels.Get(ChannelName, channelOptions); | ||
| ``` | ||
| The [CHANGELOG.md](/ably/ably-dotnet/blob/main/CONTRIBUTING.md) contains details of the latest releases for this SDK. You can also view all Ably releases on [changelog.ably.com](https://changelog.ably.com). | ||
|
|
||
| Beyond specifying channel options, the rest is transparent and requires no further changes to your application. The `message.Data` instances that are delivered to your `Action<Message>` handler continue to contain the values that were originally published. | ||
| --- | ||
|
|
There was a problem hiding this comment.
Fix CHANGELOG link target
The link text references CHANGELOG.md but points to CONTRIBUTING.md. Please update the URL to /ably/ably-dotnet/blob/main/CHANGELOG.md.
Proposed diff:
-[CHANGELOG.md](/ably/ably-dotnet/blob/main/CONTRIBUTING.md)
+[CHANGELOG.md](/ably/ably-dotnet/blob/main/CHANGELOG.md)📝 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.
| ## Releases | |
| Request a `Vcdiff` formatted delta stream using channel options when you get the channel: | |
| ```csharp | |
| var channelParams = new ChannelParams(); | |
| channelParams.Add("delta", "vcdiff"); | |
| var channelOptions = new ChannelOptions(); | |
| channelOptions.Params = channelParams; | |
| IRealtimeChannel channel = ably.Channels.Get(ChannelName, channelOptions); | |
| ``` | |
| The [CHANGELOG.md](/ably/ably-dotnet/blob/main/CONTRIBUTING.md) contains details of the latest releases for this SDK. You can also view all Ably releases on [changelog.ably.com](https://changelog.ably.com). | |
| Beyond specifying channel options, the rest is transparent and requires no further changes to your application. The `message.Data` instances that are delivered to your `Action<Message>` handler continue to contain the values that were originally published. | |
| --- | |
| ## Releases | |
| The [CHANGELOG.md](/ably/ably-dotnet/blob/main/CHANGELOG.md) contains details of the latest releases for this SDK. You can also view all Ably releases on [changelog.ably.com](https://changelog.ably.com). | |
| --- |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~61-~61: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...``` --- ## Releases The CHANGELOG.md contains det...
(HYPHENATED_LY_ADVERB_ADJECTIVE)
[style] ~61-~61: 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)
🤖 Prompt for AI Agents
In README.md around lines 59 to 63, the link text says CHANGELOG.md but the URL
incorrectly points to CONTRIBUTING.md. Update the URL in the markdown link to
point to /ably/ably-dotnet/blob/main/CHANGELOG.md so the link target matches the
link text.
bd4864d to
60898a1
Compare
EDU-1956: Adds getting started EDU-1956: Rewrites introduction and overview EDU-1956: Rewrites supported platforms section EDU-1956: Moves and improves MAUI config EDU-1956: Removes random docs section EDU-1956: Removes install and usage sections EDU-1956: Removes known limitations EDU-1956: Removes dependencies section EDU-1956: Adds releases EDU-1956: Moves contributing EDU-1956: Adds to suport section EDU-1956: Adds trimmed examples
60898a1 to
b8ffdf1
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-1956: Adds header and new shield
EDU-1956: Adds getting started
EDU-1956: Rewrites introduction and overview
EDU-1956: Rewrites supported platforms section
EDU-1956: Moves and improves MAUI config
EDU-1956: Removes random docs section
EDU-1956: Removes install and usage sections
EDU-1956: Removes known limitations
EDU-1956: Removes dependencies section
Removes the dependencies section as it's unrelated to Ably.
EDU-1956: Adds releases
EDU-1956: Moves contributing
EDU-1956: Adds to support section
Jira
https://ably.atlassian.net/browse/EDU-1956
Summary by CodeRabbit