docs: add comprehensive V5 Calls SDK documentation #194
Conversation
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
- Add design specifications and requirements for V5 calling docs - Add Android Calls SDK documentation with 30+ guides covering setup, authentication, session management, audio/video controls, recording, participant management, and event listeners - Add Calls API documentation with overview, get-call, and list-calls endpoints - Add platform overview pages for Flutter, Ionic, iOS, JavaScript, and React Native - Add session settings documentation for Android SDK configuration - Update main calls.mdx page with new documentation structure - Update docs.json navigation to include new Calls SDK section and platform-specific guides - Provide complete reference for developers implementing CometChat Calls across multiple platforms
jitvarpatil
requested review from
Copilot,
honey-cometchat and
swapnil-cometchat
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive V5 Calls SDK documentation covering Android implementation with 30+ guides, API documentation, and platform placeholders. The changes include setup, authentication, session management, audio/video controls, recording, participant management, event listeners, and navigation structure updates.
Changes:
- Added complete Android Calls SDK documentation with setup, authentication, session management, and feature guides
- Added Calls API documentation with overview, get-call, and list-calls endpoints
- Added placeholder overview pages for iOS, React Native, JavaScript, Flutter, and Ionic platforms
- Updated navigation structure in docs.json with new Calls SDK section
- Added design specifications and task tracking files
Reviewed changes
Copilot reviewed 39 out of 40 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs.json | Added Calls SDK navigation with Android, iOS, React Native, JavaScript, Flutter, and Ionic tabs |
| calls.mdx | Updated platform overview links to point to new Calls SDK documentation structure |
| calls/android/*.mdx | 30+ Android documentation files covering complete SDK functionality |
| calls/api/*.mdx | API documentation for calls endpoints including overview, get, and list operations |
| calls/{ios,react-native,javascript,flutter,ionic}/overview.mdx | Placeholder pages indicating documentation coming soon |
| .kiro/specs/v5-calling-docs/*.md | Requirements and task tracking specifications |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Remove duplicate prerequisites sections from all Android Calls SDK documentation files - Streamline documentation by eliminating repetitive prerequisite information - Improve readability and reduce cognitive load for developers - Prerequisites are now contextually referenced within relevant sections rather than listed at the top of each page
- Add SessionSettingsBuilder documentation with all configuration options - Add Custom Control Panel guide with MediaEventsListener integration - Add Custom Participant List guide with ParticipantEventListener - Add VoIP Calling documentation with ConnectionService implementation - Add Background Handling documentation for ongoing call service - Restructure Join Session page with clearer sections - Update navigation to include Advanced group with new pages
- Rewrite overview with base URL, authentication, use cases, and complete object schemas - Add example response, pagination details, and error handling section - Enhance list-calls with common use cases, filtering tips, and example request - Enhance get-call with usage scenarios, response details, and participant states
- Add in-call-chat.mdx: CometChat UI Kit integration for messaging during calls - Add share-invite.mdx: Share button functionality with deep link handling - Update docs.json navigation to include new pages in Advanced group
…documentation - Add complete iOS Calls SDK documentation covering setup, authentication, actions, audio modes, call layouts, call logs, custom UI components, events, idle timeout, in-call chat, join session, participant management, picture-in-picture, raise hand, recording, ringing, screen sharing, session settings, share invite, and VoIP calling - Add comprehensive JavaScript Calls SDK documentation including Angular, React, Next.js, Vue, and Ionic integration guides with setup, authentication, actions, call layouts, call logs, custom controls, device management, events, idle timeout, in-call chat, join session, participant management, permissions handling, picture-in-picture, raise hand, recording, ringing, screen sharing, session settings, share invite, and virtual background features - Add detailed React Native Calls SDK documentation with setup, authentication, actions, audio modes, background handling, call layouts, call logs, custom UI components, events, idle timeout, in-call chat, join session, participant management, picture-in-picture, raise hand, recording, ringing, screen sharing, session settings, share invite, and VoIP calling - Add MCP server configuration file for GitHub and Linear integration - Update main calls overview page and documentation index to reflect new SDK documentation structure - Remove Ionic card from main calls page as it is now covered under JavaScript integration guides - Expand Calls SDK documentation coverage to provide platform-specific implementation guides for all major platforms
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Related Issue(s)
Type of Change
Checklist
Additional Information
Screenshots (if applicable)