Documentation Improvement: React Native SDK v4#244
Open
Farhan-CometChat wants to merge 10 commits intomainfrom
Open
Documentation Improvement: React Native SDK v4#244Farhan-CometChat wants to merge 10 commits intomainfrom
Farhan-CometChat wants to merge 10 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
- Add sample console output accordions to delete-conversation, delete-message, delivery-read-receipts, flag-message, interactive-messages, mentions, reactions, retrieve-conversations, threaded-messages, transient-messages, and typing-indicators docs - Fix UI Kit documentation links from `/ui-kits/react-native/overview` to `/ui-kit/react-native/overview` across all modified files - Include JSON response examples showing successful method execution and event callbacks - Provide developers with clear reference output for debugging and integration
- Add response accordions to block-users.mdx with blockUsers(), unblockUsers(), and fetchNext() response tables - Add response accordions to call-logs.mdx documenting fetchNext() response structure - Add response accordions to presenter-mode.mdx with startPresentation() and stopPresentation() responses - Add response accordions to recording.mdx with startRecording() and stopRecording() responses - Add response accordions to retrieve-users.mdx with fetchNext() response tables - Add response accordions to standalone-calling.mdx with call initiation and response structures - Add response accordions to user-management.mdx with user creation and update responses - Add response accordions to user-presence.mdx with presence subscription responses - Include parameter descriptions, types, and sample values for all API responses - Improve developer experience by providing clear response documentation alongside code examples
… and call docs - Add response accordion to createGroup() with Group object structure and sample values - Add response accordion to createGroupWithMembers() with group and members object details - Add sample response accordion to initiateCall() with Call object and User object structures - Add sample response accordions to call listener events with detailed parameter documentation - Include comprehensive parameter tables with types, descriptions, and sample values for all responses - Improve API documentation clarity by showing developers expected response structures upfront
…s SDK docs - Convert sample JSON output accordions to structured response tables with parameter descriptions - Add table-based documentation for Message, sender, receiver, data, and metadata objects - Include sample values and type information for all response parameters - Add anchor links for cross-referencing object structures within documentation - Improve readability and consistency across 28 SDK documentation files - Standardize response documentation format for better developer reference
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.
Documentation Improvement: React Native SDK v4
Scope
What was improved
Structure & Navigation
<Info>blocks at the top of each page)descriptionfield in YAML front matter)Response Accordion Documentation
style={{scrollMarginTop: '100px'}}to ALL span anchors for sticky navbar compatibility[See below ↓](#anchor-id)patternSample Output Quality
tagsarrays cleaned to empty[]in all sample outputs to avoid confusionrawMessagefield stripped from all sample outputs for readabilityERR_NOT_LOGGED_IN)Files with Response Accordions
Messaging pages:
receive-messages.mdx— All instances convertedadditional-message-filtering.mdx— All instances convertedretrieve-conversations.mdx— All instances convertedthreaded-messages.mdx— All instances convertededit-message.mdx— All instances converted (including missed edit events section)flag-message.mdx— 2 accordions converteddelete-message.mdx— 3 accordions converteddelete-conversation.mdx— 1 accordion convertedtyping-indicators.mdx— 3 accordions convertedtransient-messages.mdx— 2 accordions convertedinteractive-messages.mdx— 3 accordions converteddelivery-read-receipts.mdx— 4 accordions convertedmentions.mdx— 4 accordions convertedreactions.mdx— 6 accordions convertedmessaging-overview.mdx— Proper tabular format with duplicate raw JSON removedsend-message.mdx— Proper tabular formatCalling pages:
direct-call.mdx— 22 span anchors with scrollMarginTopstandalone-calling.mdx— 9 span anchors with scrollMarginTopcall-logs.mdx— 12 span anchors with scrollMarginToppresenter-mode.mdx— 9 span anchors with scrollMarginToprecording.mdx— 2 span anchors with scrollMarginTopdefault-call.mdx— Renamed 8 "Sample Response" → "Response"Group pages:
create-group.mdx— 1 span anchor with scrollMarginTopgroup-add-members.mdx— 5 span anchors with scrollMarginTopgroup-kick-ban-members.mdx— 6 span anchors with scrollMarginTopretrieve-group-members.mdx— 1 span anchor with scrollMarginTopAuth/Setup pages:
setup-sdk.mdx— Converted to proper Response accordion with tabular error formatauthentication-overview.mdx— Proper tabular formatSample output status
init,login(UID + Auth Token),logout,sendMessage,sendMediaMessage(file / URL / multiple),sendCustomMessage,addMessageListener(text / media / custom received), all calling methods, all group methodsfetchNext(missed messages),fetchPrevious(unread messages / message history), unread count methodsWhat was NOT changed
Verification
Notes for reviewers
scrollMarginTop: '100px'style is critical — without it, clicking anchor links scrolls to the section but the header is hidden behind the sticky navbar.kiro/steering/json-to-table-documentation.mdfetchNext,fetchPrevious, and unread count methods are pending — real logs need to be captured and added in a follow-up passmessaging-overview.mdxpage was enhanced with inline accordion samples for the two Quick Reference methods (sendMessageandaddMessageListener) to give developers immediate visibility into response shapes