Skip to content

📦 Update XMTP-JS SDK docs for @xmtp/node-sdk@5.4.0#699

Open
neekolas wants to merge 1 commit intomainfrom
auto-update-js-docs-@xmtp/node-sdk@5.4.0
Open

📦 Update XMTP-JS SDK docs for @xmtp/node-sdk@5.4.0#699
neekolas wants to merge 1 commit intomainfrom
auto-update-js-docs-@xmtp/node-sdk@5.4.0

Conversation

@neekolas
Copy link
Contributor

@neekolas neekolas commented Feb 28, 2026

🤖 Automated XMTP-JS SDK Documentation Update

This PR updates the documentation to align with XMTP-JS SDK release @xmtp/node-sdk@5.4.0.

Changes Made

  • Updated Node.js and Browser SDK code samples to match current APIs
  • Verified JavaScript/TypeScript integration examples
  • Updated version references and installation instructions
  • Addressed any breaking changes or deprecations
  • Updated content type usage examples
  • Verified Client, Conversation, and Message API patterns
  • Validated code samples using repository linting tools
  • Updated TypeScript definitions and examples

SDK Areas Covered

  • 🌐 Browser SDK: WorkerClient, Web Worker patterns, browser-specific APIs
  • 🖥️ Node SDK: Direct client usage, Node.js utilities and scripts
  • 📦 Content Types: Text, reactions, attachments, replies, custom types
  • 🔧 Core APIs: Client creation, conversations, messaging, streaming
  • 🛡️ Authentication: Signer setup, inbox management, user consent

Analysis Summary

Documentation analysis and updates completed using Claude Code Actions with comprehensive diff analysis between @xmtp/node-sdk@5.3.0 and @xmtp/node-sdk@5.4.0.

Verification Needed

  • Review all JavaScript/TypeScript code samples for accuracy
  • Test integration examples with current SDK version
  • Verify version compatibility information across packages
  • Check TypeScript definitions and type examples
  • Validate Browser vs Node SDK usage patterns
  • Check content type integration examples
  • Verify client initialization and configuration examples
  • Check for any missed documentation updates

This PR was automatically generated by Claude Code Actions

Note

Add group message topic access example to XMTP SDK documentation

Adds a code example to topics.mdx showing how to access group.topic after creating a group, with separate implementations for Browser and Node.js.

Macroscope summarized a09bc45.

  Automated update based on changes in xmtp-js @xmtp/node-sdk@5.4.0

  Changes analyzed:
  - Browser SDK and Node SDK API modifications
  - Content types updates and new features
  - Code sample accuracy and syntax validation
  - Version compatibility and installation instructions
  - Breaking changes documentation
  - TypeScript type definitions and examples

  Generated by Claude Code Actions
@neekolas neekolas requested a review from a team as a code owner February 28, 2026 16:29
@vercel
Copy link

vercel bot commented Feb 28, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-xmtp-org Ready Ready Preview, Comment Feb 28, 2026 4:30pm

Request Review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant