docs(calls): add transcription and closed captions across all platforms

[honey-cometchat]

Documents call transcription and closed captions for CometChat Calls SDK v5 across all five platforms — JavaScript, React Native, iOS, Android and Flutter.

New pages — calls/{javascript,react-native,ios,android,flutter}/transcription.mdx, each covering how transcription and closed captions relate, starting/stopping transcription (auto-start and manual), the caption listeners and events, supported caption languages, retrieving stored transcripts with TranscriptRequestBuilder, and the relevant UI/settings toggles. Each page is added to the platform's Calls sidebar in docs.json.

Updated pages

• actions.mdx (all 5) — added the Start/Stop Transcription actions.
• session-settings.mdx (all 5) — added autoStartTranscription, captionLanguage, hideTranscriptionButton and hideClosedCaptionButton, including the complete-settings examples.
• call-logs.mdx (JS, React Native, iOS, Flutter) — documented filtering call logs by transcript availability and reading transcripts off a call log.
• overview.mdx (Android, React Native) — added a Transcription feature card.
• setup.mdx (all 5) + flutter/migration-guide-v5.mdx — bumped the install snippets to the SDK versions that ship transcription.

SDK version availability — the feature landed in a different patch per platform, so every transcription page, action and setting is annotated with the version it requires: iOS/Android 5.0.4, JavaScript/React Native 5.0.5, Flutter 5.0.6.

Also corrected — calls/ios/call-logs.mdx documented a CallLogsRequestBuilder API that does not exist in the SDK. Rewritten against the real CallLogsBuilder API (Swift set(limit:)-style setters, typed SessionType/CallStatus/CallCategory/CallDirection enums, and the correct Objective-C setWithLimit: spellings and initializer).

Related Issue(s)

None.

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

Transcription is a gated feature, so every page carries a callout that it must be enabled for the app before the APIs do anything.

Captions are derived from a running transcription: toggling captions on without an active transcription renders nothing. That dependency is called out on each transcription page and in the hideClosedCaptionButton setting, since it is the most likely source of "captions do nothing" reports.

The 27 internal doc links added by this PR were verified to resolve to existing pages.

Screenshots (if applicable)

Rendered on the Mintlify preview deployment:

• JavaScript
• React Native
• iOS
• Android
• Flutter

[mintlify]

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

Project	Status	Preview	Updated (UTC)
cometchat	🟢 Ready	View Preview	Aug 31, 2026, 7:20 AM

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

[jitvarpatil]

Review: transcription & closed captions (Calls SDK v5, all 5 platforms) — LGTM ✅

Clean, purely additive, build-safe, and genuinely high-quality docs. Approving with two small "confirm against SDK source" notes.

Mechanical checks — all green

• Redirects: 0 removed, 0 renamed → 0 missing redirects (correct +0 delta). No 404 risk.
• Chained 404s: 0.
• Nav integrity: the 5 new docs.json entries (calls/{javascript,react-native,ios,android,flutter}/transcription) map 1:1 to the 5 new files → build-safe.
• In-content links: every relative link in the new pages (setup, session-settings, actions, call-logs, flutter/recording) resolves.
• Placeholders / version drift / images: none — no TODO/"coming soon", no v4/v6 leakage (all sdk_version: 5.x, "Available since v5.0.5"), no image refs.

Content quality — strong

Precise and internally consistent: real defaults called out (autoStartTranscription: false, hideTranscriptionButton: true, captionLanguage: en-US), a full error-code table, pagination semantics (REQUEST_IN_PROGRESS, [] at end), epoch-seconds flagged, and the transcription-vs-captions distinction explained up front.

Notes (confirm against SDK source — non-blocking)

1. Property-vs-getter split within a page. TranscriptRequestBuilder.fetchNext() results are documented as plain properties (tid, transcriptUrl, metaData…), while callLog.getTranscriptions() results use getters (getTid(), getTranscriptURL()…) — including a casing flip (transcriptUrl vs getTranscriptURL()). Consistent across JS/Android/RN and plausibly real (raw JSON vs model instances), but worth a one-line confirm it matches the shipped SDK.
2. iOS call-logs builder signatures changed. The rewrite renamed the documented builder methods from v4-style setLimit(30) → v5 Swift-idiomatic .set(limit:) / .set(hasTranscriptions:), with an Obj-C bridging note (setWithLimit:). Looks deliberate and correct, but since it changes previously-published API names, please verify against the actual iOS Calls SDK v5 builder.

Both are "verify," not "wrong."

Approving — model additive-docs PR.

[jitvarpatil]

Docs review — ✅ Approve

A large new-feature docs set: 5 new transcription.mdx pages (~300–500 lines each) plus supporting additions to actions / session-settings / call-logs across all 5 platforms (28 files, +2,765/−61). Structurally clean, consistent across platforms, and every documented symbol verifies against the published SDK.

✅ API verified against published @cometchat/calls-sdk-javascript@5.0.5

Checked the actual published tarball's dist/index.d.ts — all documented symbols ship today:

Documented	In 5.0.5
CometChatCalls.startTranscription()	✅ static startTranscription(): void
CometChatCalls.stopTranscription()	✅ static stopTranscription(): void
CometChatCalls.TranscriptRequestBuilder	✅ static member + Transcript interface
autoStartTranscription	✅ session setting
hideTranscriptionButton / hideClosedCaptionButton	✅
CallLogRequestBuilder.setHasTranscriptions(bool)	✅
CallLog.getTranscriptions(): Transcription[]	✅
getTranscriptURL / transcriptUrl	✅ (Transcription class)

Current published Calls SDK versions: JS 5.0.5, RN 5.0.5, Android 5.0.4, iOS 5.0.4, Flutter 5.0.7.

✅ Structure & content

• All 5 calls/{platform}/transcription pages are wired into docs.json nav; 0 nav breaks, redirects +0. (The calls/ionic/overview orphan is pre-existing.)
• 0 new broken links — cross-checked every flagged target against this PR's added lines; none introduced (the 8 the analyzer reports are pre-existing in unchanged files).
• Consistent title ("Transcription & Closed Captions") and structure across all 5 platforms; all internal links in the new pages resolve; no placeholders/TODOs across 2,000+ new lines.

Thorough, accurate, cross-platform-consistent feature documentation. Ready to merge. 🚀

_{🤖 Automated docs review (Mintlify link/redirect/nav/content checks + API verification against the published calls-sdk 5.0.5 type definitions).}

[jitvarpatil]

Docs review — ✅ Approve

A large new-feature docs set: 5 new transcription.mdx pages (~300–500 lines each) plus supporting additions to actions / session-settings / call-logs across all 5 platforms (28 files, +2,765/−61). Structurally clean, consistent across platforms, and every documented symbol verifies against the published SDK.

✅ API verified against published @cometchat/calls-sdk-javascript@5.0.5

Checked the actual published tarball's dist/index.d.ts — all documented symbols ship today:

Documented	In 5.0.5
CometChatCalls.startTranscription()	✅ static startTranscription(): void
CometChatCalls.stopTranscription()	✅ static stopTranscription(): void
CometChatCalls.TranscriptRequestBuilder	✅ static member + Transcript interface
autoStartTranscription	✅ session setting
hideTranscriptionButton / hideClosedCaptionButton	✅
CallLogRequestBuilder.setHasTranscriptions(bool)	✅
CallLog.getTranscriptions(): Transcription[]	✅
getTranscriptURL / transcriptUrl	✅ (Transcription class)

Current published Calls SDK versions: JS 5.0.5, RN 5.0.5, Android 5.0.4, iOS 5.0.4, Flutter 5.0.7.

✅ Structure & content

• All 5 calls/{platform}/transcription pages are wired into docs.json nav; 0 nav breaks, redirects +0. (The calls/ionic/overview orphan is pre-existing.)
• 0 new broken links — cross-checked every flagged target against this PR's added lines; none introduced (the 8 the analyzer reports are pre-existing in unchanged files).
• Consistent title ("Transcription & Closed Captions") and structure across all 5 platforms; all internal links in the new pages resolve; no placeholders/TODOs across 2,000+ new lines.

Thorough, accurate, cross-platform-consistent feature documentation. Ready to merge. 🚀

_{🤖 Automated docs review (Mintlify link/redirect/nav/content checks + API verification against the published calls-sdk 5.0.5 type definitions).}

[ashfaqcometchat]

Reviewed the Android and Flutter pages against calls-core master-v5 (bc71ebea, the flutter-v5.0.7 tag). Inline comments below; two items have no diff line to anchor to:

Android — calls/android/call-logs.mdx was not updated. The Android SDK has CallLogRequestBuilder.setHasTranscriptions(boolean) and CallLog.getTranscriptions() (CallLogRequest.java:229, CallLog.java:199), and the PR updated call-logs for the other four platforms. Please add the same "filter by transcript availability / read transcripts off a log" section for Android. It is also the only Android transcription API that actually requires 5.0.4 (see the version note inline).

PR description says Flutter 5.0.6; the diff says 5.0.7. 5.0.7 is correct — TranscriptRequest and startTranscription() landed only in flutter-v5.0.7 (pub.dev latest is 5.0.7). Please fix the description since it doubles as the changelog.

Everything else on both platforms checks out against the code: builder methods, TranscriptRequest limits/pagination/concurrency guard, error codes, Transcript fields, the 19-code language list, and the "captions item only appears while transcription is running" gating.

[jitvarpatil]

Re-review — ✅ Approve

My previous approvals were auto-dismissed by the new commits, so re-reviewing on head 07824e8.

✅ The new commit is a correctness fix, and it's consistent

docs(android): update transcription control defaults flips the Android story from "shown by default" → "hidden by default", and it's applied coherently everywhere:

• Prose: "both transcription controls live in the control panel's More menu and are hidden by default"
• All examples updated hideTranscriptionButton(true) → (false) / hideClosedCaptionButton(true) → (false), now framed as "to show it" rather than "to hide it"
• The hide default columns updated to true
• The nuance is preserved: even with hideClosedCaptionButton(false), the captions item only appears once transcription is running.

Cross-platform consistency confirmed — all 5 platforms now agree that the controls are hidden by default (iOS / React Native / Flutter state it explicitly; JavaScript says it in prose: "By default, the transcription button … is hidden"). That's exactly the kind of default-value contradiction that's worth catching, and it's now aligned.

✅ Still holding from the earlier review

• API verified against the published @cometchat/calls-sdk-javascript@5.0.5 (actual tarball dist/index.d.ts): startTranscription(), stopTranscription(), TranscriptRequestBuilder, autoStartTranscription, hideTranscriptionButton, hideClosedCaptionButton, setHasTranscriptions(), getTranscriptions(), getTranscriptURL / transcriptUrl — all ship today.
• All 5 calls/{platform}/transcription pages wired into nav; 0 nav breaks, 0 new broken links, redirects +0; no placeholders across 2,700+ lines.

Ready to merge. 🚀

_{🤖 Automated docs review — re-check after new commits.}

[jitvarpatil]

Re-review — ✅ Approve

My previous approvals were auto-dismissed by the new commits, so re-reviewing on head 07824e8.

✅ The new commit is a correctness fix, and it's consistent

docs(android): update transcription control defaults flips the Android story from "shown by default" → "hidden by default", and it's applied coherently everywhere:

• Prose: "both transcription controls live in the control panel's More menu and are hidden by default"
• All examples updated hideTranscriptionButton(true) → (false) / hideClosedCaptionButton(true) → (false), now framed as "to show it" rather than "to hide it"
• The hide default columns updated to true
• The nuance is preserved: even with hideClosedCaptionButton(false), the captions item only appears once transcription is running.

Cross-platform consistency confirmed — all 5 platforms now agree that the controls are hidden by default (iOS / React Native / Flutter state it explicitly; JavaScript says it in prose: "By default, the transcription button … is hidden"). That's exactly the kind of default-value contradiction that's worth catching, and it's now aligned.

✅ Still holding from the earlier review

• API verified against the published @cometchat/calls-sdk-javascript@5.0.5 (actual tarball dist/index.d.ts): startTranscription(), stopTranscription(), TranscriptRequestBuilder, autoStartTranscription, hideTranscriptionButton, hideClosedCaptionButton, setHasTranscriptions(), getTranscriptions(), getTranscriptURL / transcriptUrl — all ship today.
• All 5 calls/{platform}/transcription pages wired into nav; 0 nav breaks, 0 new broken links, redirects +0; no placeholders across 2,700+ lines.

Ready to merge. 🚀

_{🤖 Automated docs review — re-check after new commits.}