Skip to content

fix(ios-uikit): Correct method signatures in iOS UIKit documentation#243

Open
aryakulkarni-cometchat wants to merge 2 commits intomainfrom
docs/ios-ui-kit-sdk-fixes
Open

fix(ios-uikit): Correct method signatures in iOS UIKit documentation#243
aryakulkarni-cometchat wants to merge 2 commits intomainfrom
docs/ios-ui-kit-sdk-fixes

Conversation

@aryakulkarni-cometchat
Copy link

@aryakulkarni-cometchat aryakulkarni-cometchat commented Feb 17, 2026

  • Fixed logout method signature in Quick Reference: Changed from CometChatUIKit.logout(onSuccess:onError:) to CometChatUIKit.logout(user:result:)

  • Fixed Users component method names in property-changes.mdx: Changed set(trailView:) to set(trailingView:) Changed set(subtitleView:) to set(subtitle:)

  • Fixed Groups component method names in property-changes.mdx: Changed set(trailView:) to set(trailingView:) Changed SetSubTitleView to set(subtitle:)

  • Added DOCUMENTATION_REVIEW_REPORT.md with complete verification details

All changes verified against actual SDK source code and tested with a complete sample application that builds and runs successfully.

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)

- Fixed logout method signature in Quick Reference:
  Changed from CometChatUIKit.logout(onSuccess:onError:)
  to CometChatUIKit.logout(user:result:)

- Fixed Users component method names in property-changes.mdx:
  Changed set(trailView:) to set(trailingView:)
  Changed set(subtitleView:) to set(subtitle:)

- Fixed Groups component method names in property-changes.mdx:
  Changed set(trailView:) to set(trailingView:)
  Changed SetSubTitleView to set(subtitle:)

- Added DOCUMENTATION_REVIEW_REPORT.md with complete verification details

All changes verified against actual SDK source code and tested with
a complete sample application that builds and runs successfully.
…it docs

Added TL;DR Quick Reference sections at the top of all iOS UIKit documentation
pages to improve AI agent and developer experience. Each section includes:

- Key class names and imports
- Essential method signatures with correct parameters
- Common usage patterns and code snippets
- Links to related documentation
- Important warnings about initialization order and auth keys

Files updated:
- overview.mdx, getting-started.mdx, components-overview.mdx
- conversations.mdx, users.mdx, groups.mdx, call-logs.mdx
- message-header.mdx, message-list.mdx, message-composer.mdx
- All guide files, call features, extensions, and v2/v3/v4 docs

This makes the documentation more accessible for AI-assisted development
and provides quick reference for experienced developers.
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.

1 participant

Comments