fix(docs): resolve chat rooms documentation discrepancies with SDK

[splindsay-92]

Summary

This PR fixes documentation discrepancies found between the chat rooms documentation and the actual Chat SDK implementation.

Fixed Discrepancies

1. Messages Documentation (messages.mdx)

• Issue: React examples used incorrect method name versionBefore()
• Fix: Updated to use correct isOlderVersionOf() method name
• Lines affected: 294, 490
• Impact: Ensures consistency between JavaScript and React examples

2. Typing Documentation (typing.mdx)

• Issue 1: Documentation link for keystroke() pointed to #start instead of #keystroke

• Fix: Updated link to point to correct anchor

• Line affected: 132

• Issue 2: stop() method description mentioned non-existent isTyping parameter

• Fix: Updated to correctly describe type: typing.stopped event

• Line affected: 173

Documentation Audit Results

• Total files audited: 8 .mdx files in /rooms/ folder
• Files with discrepancies: 2 (messages.mdx, typing.mdx)
• Files verified as correct: 6 (presence.mdx, reactions.mdx, message-reactions.mdx, occupancy.mdx, history.mdx, index.mdx)
• Total discrepancies fixed: 4

Changes Made

1. messages.mdx: Fixed method name inconsistencies in React examples
2. typing.mdx: Corrected method documentation links and descriptions
3. required-updates.md: Added comprehensive audit report documenting all findings

Verification

All fixes have been verified against the actual SDK implementation in the chat SDK core:

• ✅ Message.isOlderVersionOf() method exists and matches documentation
• ✅ Typing.keystroke() method exists with correct link anchor
• ✅ Typing.stop() method behavior correctly documented

Impact

• Improves developer experience by ensuring documentation matches SDK implementation
• Eliminates confusion between method names in different language examples
• Provides accurate API documentation links and descriptions

Commits

• af8778905: fix(docs): correct message version comparison method names in messages.mdx
• 99e969f0d: fix(docs): correct typing method documentation in typing.mdx
• 8ea09a150: docs: add comprehensive SDK documentation audit report

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/chat-rooms-documentation-discrepancies

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.