docs(ui-kit/ios): document UIKit↔Chat SDK exact-version pinning - #450
Open
ketanyekale wants to merge 3 commits into
Open
Conversation
The iOS UI Kit ships as a prebuilt binary compiled against one exact CometChatSDK version. Overriding the SDK version (e.g. via an SPM "Up to Exact Version" mismatch) is unsupported and causes build/runtime failures. Add a Warning to Getting Started spelling out the pinning contract for both CocoaPods and SPM, and link the canonical GitHub releases list. Note: the chat-sdk-ios changelog itself is current on GitHub (4.0.69-73 are published) — the staleness in the source ticket was in the AgentBuddy KB index, not this docs repo. This change adds the missing pinning guidance (recommendation #2 of the ticket). Refs ENG-37953 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
jitvarpatil
previously approved these changes
Aug 6, 2026
jitvarpatil
left a comment
jitvarpatil
left a comment
Contributor
There was a problem hiding this comment.
Review — LGTM ✅
Valuable addition — the <Warning> documents a real integration hazard (UIKit↔Chat SDK exact-version binary compatibility), and it's accurate and internally consistent.
Content integrity — verified against the page's version table:
- "UI Kit
5.1.9→CometChatSDK 4.1.0" matches the version table (Dependencies | CometChatSDK 4.1.0 (installed automatically)), the CocoaPods snippet (pod 'CometChatUIKitSwift', '5.1.9'), and the SPM step (Exact Version: 4.1.0). No contradiction. - The CocoaPods auto-install + SPM "Up to Exact Version" guidance both match the install steps already on the page.
- The "see the version table at the top of this page" reference resolves; both GitHub links are valid; no placeholders/TODO.
Mechanical checks — safe: 1 file modified, no moves/renames/deletes (no dead URLs / redirect risk), no docs.json/nav changes (no build-break risk), no new internal links.
Minor (non-blocking): the Warning hardcodes the 5.1.9 → 4.1.0 pairing in prose, so it's one more spot to update on the next version bump — consistent with how the page already repeats 5.1.9, so fine as-is.
Approving — accurate, consistent, and build-safe.
| </Tabs> | ||
|
|
||
| <Warning> | ||
| **Pin the Chat SDK to the exact version the UI Kit requires.** `CometChatUIKitSwift` ships as a prebuilt binary compiled against one specific `CometChatSDK` version — for UI Kit `5.1.9` that is `CometChatSDK 4.1.0` (see the version table at the top of this page). |
Contributor
There was a problem hiding this comment.
update the versions to the latest , CometChatSDK - 4.1.7 and CometChatUIKitSwift 5.1.18
anshuman-cometchat
self-requested a review
August 6, 2026 12:19
anshuman-cometchat
previously approved these changes
Aug 6, 2026
Per reviewer feedback on PR #450. Verified: CometChatUIKitSwift 5.1.18 is the latest release and is published on CocoaPods; it depends on CometChatSDK ~> 4.1, whose latest is 4.1.7. Updated consistently across the version table, CocoaPods snippet, SPM steps, and the pinning Warning. (CometChatCallsSDK left at 4.2.2 — not part of the review request.) Refs ENG-37953 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
ketanyekale
dismissed stale reviews from anshuman-cometchat and jitvarpatil
via
August 6, 2026 13:22
3e3dffe
Latest release compatible with the page's iOS 13.0 baseline (4.2.3 targets iOS 12.0). Not bumping to 5.0.2 here: that release requires iOS 15.1, which would contradict this page's documented iOS 13.0+ minimum without a broader baseline change. Refs ENG-37953 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
adityakotasthane07
approved these changes
Aug 6, 2026
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
4 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.
What & why
Addresses ENG-37953 (AgentBuddy DOCUMENTATION_GAP, ticket #45184, Jul 21–28).
The source ticket had two parts. Here's how each is handled:
1. "Stale chat-sdk-ios changelog (missing 4.0.69–72)" — not a docs-repo issue
Verified against the source you linked (https://github.com/cometchat/chat-sdk-ios/releases): 4.0.69, 4.0.70, 4.0.71, 4.0.72, 4.0.73 are all published (Oct–Dec 2025), plus the 4.1.x line up to 4.1.7. The GitHub releases are current, and this repo's
sdk/ios/changelog.mdxalready points to that canonical list. The staleness was in the AgentBuddy KB index, not GitHub or these docs — so the fix there is to re-index the KB (out of scope for this repo).2. Document the UIKit↔SDK exact-version pinning contract — done here
Added a
<Warning>toui-kit/ios/getting-started.mdx(right after the install tabs) explaining that:CometChatUIKitSwiftis a prebuilt binary compiled against one exactCometChatSDKversion (5.1.9 → 4.1.0).This is grounded in the page's existing setup (it already pins
CometChatSDK 4.1.0for SPM) and directly implements recommendation #2 of the ticket.Refs ENG-37953
🤖 Generated with Claude Code