Skip to content

Docs/unreal android ios updates#433

Open
anshuman-cometchat wants to merge 4 commits into
cometchat:mainfrom
anshuman-cometchat:docs/unreal-android-ios-updates
Open

Docs/unreal android ios updates#433
anshuman-cometchat wants to merge 4 commits into
cometchat:mainfrom
anshuman-cometchat:docs/unreal-android-ios-updates

Conversation

@anshuman-cometchat

Copy link
Copy Markdown
Contributor

Description

Related Issue(s)

Type of Change

  • Documentation correction/update
  • New documentation
  • Improvement to existing documentation
  • Typo fix
  • Other (please specify)

Checklist

  • I have read the CONTRIBUTING document
  • My branch name follows the naming convention
  • My changes follow the documentation style guide
  • I have checked for spelling and grammar errors
  • All links in my changes are valid and working
  • My changes are accurately described in this pull request

Additional Information

Screenshots (if applicable)

…ment and reactions

- connection-status.mdx: fix ECometChatConnectionState values (Connected/Connecting/
  Disconnected/FeatureThrottled — was incorrectly listing a "Reconnecting" value that
  doesn't exist and omitting FeatureThrottled); add a poll-as-fallback resilience tip
- reference.mdx: add the missing Group Member Management and Reactions Blueprint node
  tables (fetch/add/kick/ban/unban/change-scope, add/remove/fetch reaction), and the
  FCometChatReaction struct — these nodes existed in the plugin but had no reference rows
- groups.mdx: add a full Group Member Management section with permission-model guidance
- send-message.mdx: add a Reactions section, including an emoji-font rendering tip
- ui-components.mdx: document UCometChatPanel behaviors that exist in the widget but were
  undocumented (reactions, role-gated member management, conversation actions, scroll-to-
  bottom)

Content verified directly against the plugin source (chat-sdk-unreal) while fixing and
testing these exact features.
Brings the Unreal SDK docs in line with the plugin as it actually behaves.

New pages:
- push-notifications — setup, preferences, troubleshooting
- reactions, ai, calling
- reference — full Blueprint node/delegate/struct catalogue

Push notifications: the page previously stated the plugin implemented only the
CometChat side and that you had to add your own Firebase/APNs layer, obtain the
device token, and display the notification yourself. The plugin now ships that
layer, so the page documents what it does:
- opt-in via [CometChat] bEnablePushNotifications; without it the plugin adds no
  Firebase dependency, manifest service, permission or startup code to a build
- config lives in the project's DefaultEngine.ini (PushProviderId + Fcm* keys
  from your own google-services.json); no credentials ship in the plugin
- registration is automatic after login, re-registers on token rotation, and
  unregisters on logout; Register Token Async is now documented as the escape
  hatch for custom token flows and APNs VoIP
- iOS requires Project Settings > iOS > Enable Remote Notifications Support; the
  plugin does not add the entitlement itself because doing so would break code
  signing for apps whose provisioning profile lacks Push
- new OnPushNotificationReceived / OnPushNotificationTapped events, including
  cold-start tap behaviour
- troubleshooting table mapping each real log line to its cause, including
  401 "Forbidden resource" -> enable the Notifications add-on (no client fix)

Existing pages: every feature now has a Blueprint use-case flow showing both
OnSuccess and OnFailure handling, plus best/bad practice notes. UI components are
referenced from setup and used as examples rather than given their own section,
since they are C++ reference samples rather than Blueprint API.

Verified with `mint broken-links`: no broken links.
@jitvarpatil

Copy link
Copy Markdown
Contributor

Docs review — 🟠 Request changes (2 orphaned pages)

A large Unreal SDK docs expansion (21 files, +4,827/-152, 7 new pages). Structurally almost clean, but two new pages were left out of the navigation — including a 420-line calling page — so they'd be unreachable from the sidebar.

🟠 P1 — orphaned new pages (not in nav)

The PR wires 18 of its 20 pages into docs.json, but misses two new ones:

  • sdk/unreal/calling — a 420-line new page, not in nav.
  • sdk/unreal/ui-components — 31-line new page, not in nav.

Both exist as files but are absent from the pages array, so readers can't reach them. Add them to the Unreal pages block (around docs.json:4851–4858, alongside send-message / receive-messages / reactions), e.g.:

"sdk/unreal/send-message",
"sdk/unreal/receive-messages",
"sdk/unreal/calling",
"sdk/unreal/conversations",
"sdk/unreal/reactions",
"sdk/unreal/typing-indicators",
"sdk/unreal/ui-components",
"sdk/unreal/real-time-events",

(exact placement is your call — just get both slugs into the array).

(The third orphan the analyzer flagged, /sdk/unreal/SAMPLE_APP, is a pre-existing repo .md readme — not this PR's concern.)

✅ What passed

  • Build/links: 0 unresolved nav refs, 0 broken internal links (22 files scanned), redirects +0, no removed/renamed URLs. All image references resolve.
  • Nav: the other 18 new/updated pages (ai, push-notifications, reactions, transient-messages, typing-indicators, moderation, conversations, groups, users, reference, etc.) are correctly in nav.
  • Content hygiene: no TODO/FIXME/lorem/placeholder text across the new content.

⚠️ Verification gap (transparency)

This is an API-heavy docs set, but the Unreal SDK source isn't available in my review environment, so I could not verify method/class/Blueprint-node names, signatures, or code examples against source. Structural and content-hygiene checks pass, but the API accuracy needs a subject-matter / SDK-team review — I can't vouch for it.

The blocker is just the 2 missing nav entries; once calling and ui-components are added, the structure is good.

🤖 Automated docs review (Mintlify link/redirect/nav/content checks). Unreal SDK API not independently verified.

anshuman-cometchat and others added 2 commits July 21, 2026 16:50
…tall with 1.0.0 README

Remove the two pages that were intentionally kept out of the sidebar:

- calling.mdx: calls were deliberately excluded from the docs.
- ui-components.mdx: its content already lives in setup.mdx under
  "Sample UI Components (reference)", and the "Reference: sample UI"
  convention it established is applied across 8 feature pages.

Repoint the stale "UI Components" card on real-time-events.mdx at the
setup.mdx anchor, and add a redirect for /sdk/unreal/ui-components since
that page exists on main and may be a live URL. No redirect for calling —
it was never published.

Drop the beta framing now that 1.0.0 has shipped: remove the "Beta
Release" warning from overview.mdx and bump both Cloudsmith download
URLs from 1.0.0-beta.2 to 1.0.0 (both artifacts verified reachable).

Sync the install flow with the release/1.0.0 README, which contradicted
the docs. Option 1 told readers to copy Plugins/CometChatSdk/ and then
extract the zip over it; the README states each platform folder is a
complete, self-contained plugin and must NOT be merged with the repo
source. Replaced with the documented flow — download, copy the platform
folder (5.5/mac, 5.5/windows, or 5.7) so CometChat.uplugin sits directly
inside — and corrected both platform tables, which flatly claimed
Mac/Windows/iOS/Android for both engine versions. Precompiled binaries
cover UE 5.5 (Mac, Windows) and UE 5.7 (Mac); iOS and Android build from
source.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The Moderation group contains a single page also titled "Moderation", so
the sidebar rendered "Moderation > Moderation" and the page itself showed
"Moderation" as both breadcrumb and H1.

Retitle the page to "Overview", matching the sibling Authentication group,
whose single page uses the same pattern. The description and body prose
still carry the moderation context.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants