Update iOS SDK Document to v 0.4.24 #163
Conversation
WalkthroughThe changes encompass updates to the environment variable configuration for the Yorkie SDK and significant modifications to the iOS SDK documentation. The iOS version number was incremented to match the Android version. Documentation updates include simplified client initialization, enhanced document management features, and new subscription methods for connection and synchronization events. Logger options were also introduced to improve debugging capabilities. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add 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: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- .env (1 hunks)
- docs/getting-started/with-ios-sdk.mdx (2 hunks)
- docs/ios-sdk.mdx (12 hunks)
Additional context used
LanguageTool
docs/ios-sdk.mdx
[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...argument is options. -initialPresence: Sets the initial presence of the client...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~235-~235: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...is modified, change events are triggered and you can subscribe to these events using...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~340-~340: Loose punctuation mark.
Context: ...s four SyncModes: -SyncMode.realtime: Local changes are automatically pushed ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~342-~342: Loose punctuation mark.
Context: ...e server. -SyncMode.realtimePushOnly: Only local changes are pushed, and remo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~344-~344: Loose punctuation mark.
Context: ...ot pulled. -SyncMode.realtimeSyncOff: Changes are not synchronized, but the w...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~346-~346: Loose punctuation mark.
Context: ...eam remains active. -SyncMode.manual: Synchronization no longer occurs in rea...(UNLIKELY_OPENING_PUNCTUATION)
Additional comments not posted (15)
.env (1)
4-4: LGTM!The iOS version number has been correctly updated.
The code changes are approved.
docs/getting-started/with-ios-sdk.mdx (4)
30-30: LGTM!The client instantiation has been simplified and improves readability.
The code changes are approved.
52-55: LGTM!The document update method now includes a second parameter, enhancing its functionality.
The code changes are approved.
61-67: LGTM!The method for accessing document properties has been simplified, improving readability and usability.
The code changes are approved.
64-67: LGTM!The method for accessing document properties has been simplified, improving readability and usability.
The code changes are approved.
docs/ios-sdk.mdx (10)
18-27: LGTM!The client instantiation has been simplified and improves readability.
The code changes are approved.
36-42: LGTM!The document creation method has been slightly rephrased for clarity.
The code changes are approved.
55-60: LGTM!The options for attaching a document have been updated to reflect a more structured approach to synchronization modes.
The code changes are approved.
Tools
LanguageTool
[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...argument is options. -initialPresence: Sets the initial presence of the client...(UNLIKELY_OPENING_PUNCTUATION)
100-101: LGTM!The presence update method has been clarified, improving clarity and usability.
The code changes are approved.
132-139: LGTM!The presence subscription method has been clarified, improving clarity and usability.
The code changes are approved.
230-236: LGTM!The document subscription method has been clarified, improving clarity and usability.
The code changes are approved.
Tools
LanguageTool
[uncategorized] ~235-~235: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...is modified, change events are triggered and you can subscribe to these events using...(COMMA_COMPOUND_SENTENCE)
295-312: LGTM!The connection status subscription method has been introduced, enhancing the robustness of the SDK.
The code changes are approved.
316-329: LGTM!The synchronization status subscription method has been introduced, enhancing the robustness of the SDK.
The code changes are approved.
336-360: LGTM!The synchronization mode change method has been clarified, improving clarity and usability.
The code changes are approved.
Tools
LanguageTool
[uncategorized] ~340-~340: Loose punctuation mark.
Context: ...s four SyncModes: -SyncMode.realtime: Local changes are automatically pushed ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~342-~342: Loose punctuation mark.
Context: ...e server. -SyncMode.realtimePushOnly: Only local changes are pushed, and remo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~344-~344: Loose punctuation mark.
Context: ...ot pulled. -SyncMode.realtimeSyncOff: Changes are not synchronized, but the w...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~346-~346: Loose punctuation mark.
Context: ...eam remains active. -SyncMode.manual: Synchronization no longer occurs in rea...(UNLIKELY_OPENING_PUNCTUATION)
456-476: LGTM!The logger options have been introduced, improving debugging capabilities.
The code changes are approved.
What this PR does / why we need it?
Any background context you want to provide?
What are the relevant tickets?
Fixes #
Checklist
Summary by CodeRabbit
New Features
Documentation