Updated Integration Guide - #440
raj-cometchat wants to merge 16 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Replace the copy-the-UI-Kit-sample approach with the released com.cometchat:push-notifications-android:1.0.0 drop-in SDK, mirroring the new Flutter guide's structure. Covers dependency setup, Application init via PNConfiguration.Builder, forwarding FCM payloads to handlePushNotification, token registration/refresh, notification-tap and call-event listeners, badge count, testing, and troubleshooting. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…s-sdk Rewrite Android push guide for drop-in push-notifications-android SDK
Consolidates the two legacy iOS pages (APNs + FCM copy-files patterns) into a single notifications/ios-push-notifications.mdx that documents the CometChatPushNotifications drop-in SDK: SPM/CocoaPods install, AppDelegate + SceneDelegate wiring, CometChatPushNotificationsDelegate for taps and calls, foreground suppression, badge, and troubleshooting. Updates docs.json nav + redirects, the notifications and getting-started landing pages (single "iOS" card, no FCM-iOS Firebase tab), and stray cross-references from Flutter VoIP and legacy iOS extensions pages.
The legacy 2.0 extensions page is out of scope for the push SDK rewrite; the redirect on the old slug handles the old link.
6b44f2f
Docs review — 🟠 Request changesA large push-notifications restructure (18 files, +1,104/−2,831) consolidating the split Flutter (android+ios) and iOS (APNs+FCM) push pages into single 🟠 P1 — 3 old pages emptied instead of deleted (breaks their own redirects)
Only Why it matters: the PR does add redirects for all four old URLs (e.g. Fix: actually delete them — git rm notifications/flutter-push-notifications-android.mdx \
notifications/flutter-push-notifications-ios.mdx \
notifications/ios-apns-push-notifications.mdx— then the already-present redirects take effect. 🟠 P1 — in-content link to a deleted page
✅ What passed
Well-intentioned consolidation with correct redirects and clean merged content — it just needs the 3 pages deleted rather than emptied, plus the one in-content link updated. Happy to re-check once that's done. 🤖 Automated docs review (Mintlify link/redirect/nav/content checks). |
Both 'iOS - FCM' and 'iOS - APNs' sample cards pointed at .../SampleAppPushNotificationAPNs/Push Notification + VoIP, which 404s (that subfolder no longer exists in the v5 branch). Collapse to a single 'iOS' card pointing at the SampleAppPushNotificationAPNs folder itself, which is where the sample now lives.
The 'resolved conflicts' merge on this branch resurrected notifications/ios-apns-push-notifications.mdx as an empty file and reintroduced the split 'iOS (APNs)' / 'iOS (FCM)' cards on notifications/push-overview.mdx pointing at deleted slugs. A blank file at the old path silently defeats the redirect, so: - git rm the empty ios-apns page so the redirect fires again. - Collapse the two iOS cards on push-overview into a single 'iOS' card pointing at /notifications/ios-push-notifications.
Same merge-conflict-resolution regression as the iOS side: the 'resolved conflicts' merge on this branch resurrected notifications/flutter-push-notifications-android.mdx and notifications/flutter-push-notifications-ios.mdx as empty (0-byte) files, which silently defeats their /notifications/flutter-push- notifications redirects, and reintroduced the split 'Flutter (Android)' / 'Flutter (iOS)' cards on push-overview pointing at the deleted slugs. Also the two Flutter sample-app cards on the notifications landing page pointed at the same sample_app_push_notifications URL. - git rm both empty Flutter pages so the redirects fire again. - Collapse the two Flutter cards on push-overview into a single 'Flutter' card pointing at /notifications/flutter-push-notifications. - Collapse the two Flutter sample-app cards on notifications.mdx into one 'Flutter' card at the same working URL.
Re-review — ✅ ApproveBoth P1 findings from my earlier review are fully resolved (the new commits — "Re-delete empty Flutter push pages…", "Re-delete ios-apns page and fix stale iOS links…" — address them directly). Re-verified on head ✅ Fixed
Combined with the already-verified merged content (proper frontmatter, single consistent version pin Nicely done on the redirect coverage. Ready to merge. 🚀 🤖 Automated docs review — re-check after fixes. |
jitvarpatil
left a comment
There was a problem hiding this comment.
Re-review — ✅ Approve
Both P1 findings from my earlier review are fully resolved (the new commits — "Re-delete empty Flutter push pages…", "Re-delete ios-apns page and fix stale iOS links…" — address them directly). Re-verified on head 0df4bdd.
✅ Fixed
- All 4 old pages now properly deleted — analyzer reports
removed: 4(wasremoved: 1with 3 emptied to 0 bytes). No 0-byte.mdxfiles remain innotifications/. - All 4 deleted URLs have working redirects (
[2a] 0 of 4unredirected) — and now that the files are genuinely gone, the redirects will actually fire:flutter-push-notifications-android/-ios→flutter-push-notificationsios-apns-push-notifications/ios-fcm-push-notifications→ios-push-notifications
- Broken in-content link fixed —
[4] 0 broken links(was 1);push-overview.mdxnow links directly to/notifications/ios-push-notifications. - 0 nav breaks. (The
/notifications/overvieworphan is pre-existing — not this PR.)
Combined with the already-verified merged content (proper frontmatter, single consistent version pin cometchat_push_notifications: ^1.0.1, no placeholders/contradictions), the consolidation is now correct end-to-end.
Nicely done on the redirect coverage. Ready to merge. 🚀
🤖 Automated docs review — re-check after fixes.
The push-getting-started page is introduced by the still-open Flutter PR #440; until it merges, link the shared setup prerequisite to the existing notifications/push-overview page so the RN guide has no dead links on main. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…uide Checked every claim against the package source; two were wrong. iOS — the guide told apps to hand-write a PKPushRegistry and the four delegate methods in AppDelegate, AFTER adding the setup CLI's generated file to the target. That file already owns the registry (on a background queue) and forwards all four events. Doing both is a compile error (didRegisterForRemoteNotifications… defined twice) or two registries, which double-delivers every VoIP push. And the one line an app actually needs, `CometChatVoIP.shared.register()`, was never mentioned. Replaced with that line, a warning against a second registry and on clashing with existing delegate methods, and a note for Objective-C AppDelegates. Android — the guide told apps to add firebase-bom + firebase-messaging. The package already depends on both; only the google-services plugin is needed. Updated the quick reference, the section 6 cold-start warning and four troubleshooting rows that repeated those instructions or the old logout helper. Structure, against Flutter's unified guide (#440): - Badge: add the dashboard step that enables unreadMessageCount, and order tabs Android → iOS like every other tab group. - Testing: add a fresh-install check (Flutter has a reinstall item) and a logout check. Sections 3 and 4 keep a single code path rather than Flutter's per-platform tabs: Flutter's init and token registration genuinely differ per platform, while this package's are one identical JS call on both. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Description
Related Issue(s)
Type of Change
Checklist
Additional Information
Screenshots (if applicable)