Skip to content

Updated docs - #398

Merged
ketanyekale merged 4 commits into
mainfrom
feature/flutter-sdk-card-message
Jun 24, 2026
Merged

Updated docs#398
ketanyekale merged 4 commits into
mainfrom
feature/flutter-sdk-card-message

Conversation

@raj-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)

@raj-cometchat
raj-cometchat requested a review from raj-dubey1 June 23, 2026 14:10
@raj-cometchat raj-cometchat self-assigned this Jun 23, 2026
@mintlify

mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cometchat 🟢 Ready View Preview Jun 23, 2026, 2:16 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

raj-dubey1
raj-dubey1 previously approved these changes Jun 23, 2026
jitvarpatil
jitvarpatil previously approved these changes Jun 23, 2026
@jitvarpatil

Copy link
Copy Markdown
Contributor

Docs review

TL;DR: Clean, tightly-scoped content PR adding Card Message + AI-assistant card-streaming docs to the Flutter Chat SDK (4 files modified, 0 added / removed / renamed). Build-safe — no moved URLs so no redirects needed; all nav refs and in-content links resolve. Every newly-documented API symbol was verified against the published 5.0.5 dartdoc and checks out. One should-fix (install drift on a sibling page) and two nits.

Verdict: ✅ Approve (worth addressing the P1 drift here or in a fast follow-up).

✅ What passed (checked)

  • Build integrity: all 4 changed files already have a nav entry in docs.json — 0 dangling refs.
  • Redirects: N/A and correct — no removed/renamed files, so 0 redirects needed.
  • In-content links: every internal link in the changed pages resolves (/ai-agents, /sdk/flutter/upgrading-from-v4-guide, /sdk/flutter/user-presence, /sdk/flutter/connection-behaviour, intra-page anchors). The removed ### Cloudsmith heading is not linked by any other page.
  • Version pin: cometchat_sdk: ^5.0.5 is live on pub.dev — pin is current.
  • API correctness (core risk): confirmed against the published 5.0.5 dartdoc — CardMessage, AIAssistantCardStartedEvent/ReceivedEvent/EndedEvent, AIAssistantElement; members getElements()AIAssistantMessage, getFallbackText()/getCard()CardMessage, getCard()AIAssistantCardReceivedEvent, getData()/getType()AIAssistantElement, onCardMessageReceivedMessageListener, executionTextAIAssistantCardStartedEvent. Prose ↔ code agree within the card sections.

🟠 P1 — should-fix: install drift on a sibling page

This PR migrates sdk/flutter/setup.mdx from the Cloudsmith-hosted version: 5.0.0 to pub.dev cometchat_sdk: ^5.0.5 (good — the package is public on pub.dev now). But the sibling upgrade guide is left stale:

  • sdk/flutter/upgrading-from-v4-guide.mdx (lines 16–19) still documents the old Cloudsmith hosted install pinned to version: 5.0.0.

Two current-version Flutter pages now disagree on both the install source and the version (5 releases stale). Recommend updating that snippet to match setup.mdx.

🟡 P2 — nits

  1. Prose vs codesdk/flutter/ai-agents.mdx:158 says "fall back to getText()", but the fallback code at line 197 uses the message.text property rather than the documented message.getText() method. Align for consistency with the table above.
  2. Java-style override in a Dart sample (pre-existing, now adjacent) — in sdk/flutter/real-time-listeners.mdx, the new @override void onCardMessageReceived(...) Dart block sits directly above a pre-existing @Override public void onTransientMessageReceived(...) Java-style block in the same Dart class sample. Not introduced by this PR, but worth cleaning up while the file is open.

🤖 Automated docs review (Mintlify link/redirect/content checks + API verification against published 5.0.5).

@ketanyekale
ketanyekale merged commit 2932637 into main Jun 24, 2026
3 checks passed
@jitvarpatil jitvarpatil mentioned this pull request Jun 24, 2026
11 tasks
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.

4 participants