Documentation Improvement: React Native SDK v4#244
Open
Farhan-CometChat wants to merge 6 commits intomainfrom
Open
Documentation Improvement: React Native SDK v4#244Farhan-CometChat wants to merge 6 commits intomainfrom
Farhan-CometChat wants to merge 6 commits intomainfrom
Conversation
…references - Add meta descriptions to all React Native SDK documentation pages - Add "Quick Reference for AI Agents & Developers" sections with code examples - Add "Available via" notes linking to related resources (SDK, REST API, UI Kits) - Standardize tab titles across documentation (e.g., "User Conversation" → "JavaScript", "Typescript" → "TypeScript") - Improve consistency in code examples and formatting across all pages - Enhance discoverability and provide quick access to common patterns for developers
… SDK docs - Add meta descriptions to all React Native SDK documentation pages - Include quick reference code blocks with common usage patterns - Add "Available via" notes linking to REST API and UI Kit alternatives - Update tab titles from generic names to "JavaScript" for consistency - Add Best Practices sections with accordion-style guidance - Add Troubleshooting sections addressing common issues - Add Next Steps sections with related documentation cards - Improve documentation structure and discoverability across 17 pages - Enhance user experience with clearer navigation and practical examples
…n to SDK docs - Add meta descriptions to advanced-overview, ai-agents, ai-moderation, authentication-overview, calling-setup, connection-status, managing-web-sockets-connections-manually, real-time-listeners, resources-overview, and upgrading-from-v3 pages - Add quick reference code blocks with common usage patterns to multiple documentation pages - Convert event descriptions to table format for improved readability in ai-agents.mdx - Add warning sections about listener cleanup and memory leak prevention - Add best practices and troubleshooting accordions to ai-agents.mdx and ai-moderation.mdx - Add CardGroup navigation sections with Next Steps to guide users through related topics - Replace blockquote syntax with Info, Note, and Warning components for better visual hierarchy - Improve documentation structure and user navigation flow across React Native SDK pages
…K docs - Add "Send a Message" section with sample console output for CometChat.sendMessage() - Add "Receive Messages in Real Time" section with sample outputs for message listeners - Add detailed JSON examples showing success and failure responses - Add accordion components to organize console output examples - Improve messaging documentation with practical code examples and expected outputs
…organize notification docs - Add new push-notification-html-stripping.mdx documentation page - Reorganize React Native push notification docs under grouped "Push Notifications" section - Add four new Xcode screenshot images for push notification setup guidance - Update docs.json navigation structure to reference platform-specific notification guides - Fix JSON formatting and indentation inconsistencies in docs.json redirect rules - Expand additional-message-filtering.mdx with console output examples and implementation details - Update authentication-overview.mdx and receive-messages.mdx with improved documentation
…ering examples - Add accordion section with sample console output for fetchPrevious() method showing both custom and message categories - Include detailed JSON response examples demonstrating poll extension and text message structures - Expand media messages filtering documentation with additional code examples and use cases - Provide comprehensive examples for filtering messages by multiple types and categories - Improve documentation clarity for developers implementing message filtering functionality
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Scope
What was improved
<Info>blocks at the top of each page)descriptionfield in YAML front matter)<Accordion>blocks for:CometChat.init()(setup-sdk.mdx)CometChat.login()— UID and Auth Token flows (authentication-overview.mdx)CometChat.logout()(authentication-overview.mdx)CometChat.sendMessage()— text message (send-message.mdx, messaging-overview.mdx)CometChat.sendMediaMessage()— by file, by URL, and multiple attachments (send-message.mdx)CometChat.sendCustomMessage()(send-message.mdx)CometChat.addMessageListener()— onTextMessageReceived, onMediaMessageReceived, onCustomMessageReceived (receive-messages.mdx, messaging-overview.mdx)tagsarrays cleaned to empty[]in all sample outputs to avoid confusionrawMessagefield stripped from all sample outputs for readabilityERR_NOT_LOGGED_IN)Sample output status
init,login(UID + Auth Token),logout,sendMessage,sendMediaMessage(file / URL / multiple),sendCustomMessage,addMessageListener(text / media / custom received)fetchNext(missed messages),fetchPrevious(unread messages / message history), unread count methods, and all other SDK pages beyond messaging and authWhat was NOT changed
Verification
Notes for reviewers
fetchNext,fetchPrevious, unread count methods, and remaining SDK methods are pending — real logs need to be captured and added in a follow-up pass.messaging-overview.mdxpage was enhanced with inline accordion samples for the two Quick Reference methods (sendMessageandaddMessageListener) to give developers immediate visibility into response shapes.