Use Claude Code to sync the docs with mobile SDKs#643
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![macroscopeapp[bot]](https://avatars.githubusercontent.com/in/900172?s=60&v=4){kind=small}
There was a problem hiding this comment.
I recommend approving @jhaaaa’s PR (analysis below). Auto-approval is disabled due to the CODEOWNERS requirement.
Reasoning
Eligibility
This PR contains only documentation updates (.mdx files) that sync code examples with the current mobile SDK implementations. No runtime code is changed, making this a low-risk documentation-only change.
Ownership
@jhaaaa isn't a code owner for 15 files:
• docs/pages/chat-apps/core-messaging/send-messages.mdx
• docs/pages/chat-apps/list-stream-sync/sync-and-syncall.mdx
• docs/pages/chat-apps/core-messaging/manage-inboxes.mdx
• docs/pages/chat-apps/list-stream-sync/sync-preferences.mdx
• docs/pages/chat-apps/content-types/read-receipts.mdx
• docs/pages/chat-apps/push-notifs/understand-push-notifs.mdx
• docs/pages/chat-apps/core-messaging/group-permissions.mdx
• docs/pages/chat-apps/core-messaging/group-metadata.mdx
• docs/pages/chat-apps/user-consent/support-user-consent.mdx
• docs/pages/chat-apps/debug-your-app.mdx
• docs/pages/chat-apps/list-stream-sync/stream.mdx
• docs/pages/chat-apps/core-messaging/disappearing-messages.mdx
• docs/pages/chat-apps/core-messaging/create-conversations.mdx
• docs/pages/chat-apps/list-stream-sync/archive-backups.md
• docs/pages/chat-apps/push-notifs/push-notifs.mdx
jhaaaa
force-pushed
the
xmtp-android-sync
branch
from
6f955bc to
e410be8
Compare
jhaaaa
force-pushed
the
xmtp-android-sync
branch
from
e410be8 to
d704cf9
Compare
jhaaaa
force-pushed
the
xmtp-android-sync
branch
from
d704cf9 to
15bb3d5
Compare
jhaaaa
force-pushed
the
xmtp-android-sync
branch
from
15bb3d5 to
38e9e9a
Compare
jhaaaa
force-pushed
the
xmtp-android-sync
branch
from
38e9e9a to
71a1c58
Compare
jhaaaa
force-pushed
the
xmtp-android-sync
branch
from
71a1c58 to
6021974
Compare
jhaaaa
force-pushed
the
xmtp-android-sync
branch
from
6021974 to
a737b07
Compare
|
|
||
| ::: | ||
|
|
||
| ## Manage database connections |
There was a problem hiding this comment.
I think we should move this into a dedicated local-database.mdx file, along with the database info here: https://docs.xmtp.org/chat-apps/core-messaging/create-a-client#how-it-works
Let's get this PR merged first and then make that change.
jhaaaa
force-pushed
the
xmtp-android-sync
branch
from
a737b07 to
756f0e1
Compare
| ``` | ||
|
|
||
| ::: | ||
|
|
There was a problem hiding this comment.
I had it intentionally leave out the fork recovery info as I believe we consciously held off on surfacing it in the docs for now. Correct?
For example: Configure fork recovery policy, Check conversation fork status
There was a problem hiding this comment.
yea think that still makes sense for now, we need a sprint or two to fix some edge cases for fork recovery before we'd want to surface it. 👍
…o xmtp-android-sync
jhaaaa
force-pushed
the
xmtp-android-sync
branch
from
56f9bc4 to
f070982
Compare
| @@ -3,7 +3,9 @@ | |||
| You can sync the following preference-related information across multiple existing app installations: | |||
There was a problem hiding this comment.
I think we need to restructure how we talk about "preferences," which are a mixture of user content and HMAC key values. So in this doc we talk about syncing these preferences -- but user consent is covered in a separate doc and HMAC keys are only relevant to and covered in the push notifs doc. Right now we are using cross-linking to keep them connected -- but I think there maybe a more seamless way to handle it. Just calling it out here - but will handle in a separate doc PR after we merge this.
jhaaaa
changed the title
jhaaaa
force-pushed
the
xmtp-android-sync
branch
from
7f07a89 to
7b69713
Compare
| To learn more about how `shouldPush` is used in the push notification filtering flow, see [Understand message filtering](/chat-apps/push-notifs/understand-push-notifs#understand-message-filtering). | ||
|
|
||
| :::code-group | ||
|
|
There was a problem hiding this comment.
React Native SDK limitation for shouldPush: The "Control message
visibility and push notifications" section does not include a React
Native example because the SDK handles shouldPush differently than
Kotlin/Swift. While React Native's SendOptions type includes a
shouldPush property, it is only applied when sending custom content
types (where it's passed through _sendWithJSCodec). For standard text
messages sent via send() or prepareMessage(), the shouldPush option
is not passed through to the native layer. In contrast, Kotlin and
Swift provide MessageVisibilityOptions that can be used with any
message type. This is a feature gap in the React Native SDK that
would need to be addressed upstream before documentation can be
added.
There was a problem hiding this comment.
added an issue for this one as well xmtp/xmtp-react-native#769
| Get the version of the underlying libxmtp library used by the client: | ||
|
|
||
| :::code-group | ||
|
|
There was a problem hiding this comment.
The React Native SDK does not have libxmtpVersion or appVersion properties on the Client class.
There was a problem hiding this comment.
added a ticket to add this, thanks for flagging - xmtp/xmtp-react-native#768
jhaaaa
force-pushed
the
xmtp-android-sync
branch
from
a8699a7 to
2622bd6
Compare
cameronvoell
left a comment
cameronvoell
left a comment
There was a problem hiding this comment.
Updates are looking good, and thanks for flagging inconsistencies, ill tag you as those hopefully get fixed in RN soon. Thanks @jhaaaa !
2 participants
Update chat app docs to align React Native, Kotlin, and Swift APIs with mobile SDKs using Claude Code, including nanosecond time fields and new streaming/cancellation methods across messaging, sync, and push notification sections
Standardize examples and method signatures across React Native, Kotlin, and Swift, add identity-based DM/group creation, introduce message visibility options, expand streaming APIs with cancel handlers, switch archive parameters to
startNs/endNs, and add database connection management and push topic/HMAC resubscribe guidance.📍Where to Start
Start with push notification topic and resubscribe updates in push-notifs.mdx, then review streaming and cancellation changes in stream.mdx and archive parameter updates in archive-backups.md.
Macroscope summarized 5304a62.
messagesWithReactions() Method (Deferred)
Alternative to
enrichedMessages()that only includes reactions. Per earlier decision, documenting onlyenrichedMessages()is sufficient -messagesWithReactions()is a lower-level API that most developers won't need.