Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tracking issue for new and updated documentation #74

Open
18 of 37 tasks
jhaaaa opened this issue Nov 13, 2024 · 0 comments
Open
18 of 37 tasks

Tracking issue for new and updated documentation #74

jhaaaa opened this issue Nov 13, 2024 · 0 comments
Assignees

Comments

@jhaaaa
Copy link
Collaborator

jhaaaa commented Nov 13, 2024

This tracking issue lists all the documentation pages that need to be updated or reviewed for XMTP V3.

Items with πŸ—οΈ may require code updates before docs can be updated.

Get started

  • /get-started/developer-quickstart. Content needs to be updated for V3. Link to legacy doc
  • /get-started/examples. πŸ—οΈ Example apps and tools need to be updated to use V3. Link to legacy doc
  • /get-started/references. Review Browser, Swift, and Node with Eng to verify SDK references are building as intended.
  • /get-started/references. Add RN and Kotlin SDK references.

Inboxes

  • /dms/troubleshoot. Review with Dev Rel and GTM - start fresh for V3.

History

  • /protocol/v3/message-history. πŸ—οΈ Write content once the feature is ready.

Smart contract wallets

  • /protocol/v3/smart-wallet. πŸ—οΈ Write content once the feature is ready.

Groups

Open Frames

  • /open-frames/open-frames. πŸ—οΈ Open Frames need to be updated to use V3. Link to legacy doc
  • /open-frames/subscription-open-frames. πŸ—οΈ Example subscription Open Frame needs to be updated to use V3. Link to legacy doc
  • /open-frames/transactional-open-frames. πŸ—οΈ Example transactional Open Frame needs to be updated to use V3. Link to legacy doc

To follow the progress of Open Frames engineering work, see xmtp/libxmtp#1225.

Content types

  • /content-types/transaction-refs - Provide code samples for RN, Kotlin, and Swift SDKs
  • /content-types - Provide code samples for Node SDKs
  • /content-types - Provide code samples for Browser SDKs
  • /content-types/content-types. Review with Eng to ensure code samples are up to date. Link to legacy doc
  • /content-types/remote-attachment. Review with Eng to ensure code samples are up to date. Link to legacy doc
  • /content-types/reaction. Review with Eng to ensure code samples are up to date. Link to legacy doc
  • /content-types/reply. Review with Eng to ensure code samples are up to date. Link to legacy doc
  • /content-types/read-receipt. Review with Eng to ensure code samples are up to date. Link to legacy doc
  • /content-types/transaction-ref. Review with Eng to ensure code samples are up to date. Link to legacy doc
  • /content-types/custom. Review with Eng to ensure code samples are up to date. Link to legacy doc

Subscribe/Broadcast/Consent proofs

  • /consent/subscribe. πŸ—οΈ Update Broadcast, Subscribe, and Consent Proof functionality to use V3. Link to legacy doc
  • /consent/broadcast. πŸ—οΈ Update Broadcast, Subscribe, and Consent Proof functionality to use V3. Link to legacy doc
  • /consent/consent-quickstarts. πŸ—οΈ Update Broadcast, Subscribe, and Consent Proof functionality to use V3. Link to legacy doc
  • /consent/build-engagement. πŸ—οΈ Update Broadcast, Subscribe, and Consent Proof functionality to use V3. Link to legacy doc

Chat widgets

  • /chat-widget/chat-widget. πŸ—οΈ Update chat widgets to use V3. Link to legacy doc

Protocol concepts

  • /protocol/signatures. Content needs updating to remove V2 signature types for V3. Link to legacy doc
  • /protocol/xmtp-versions. Content needs to be updated to act as a deprecation schedule doc for V2 and V1.
  • /protocol/portable-inbox. Content needs to be updated to reflect installations and history. Link to legacy doc
  • /protocol/protocols. Review with Eng to find the best way to convey protocol specs.

Performance

  • /perf-ux/xmtp-metamask-snap. Review with Eng to ensure useSnaps and SnapKeystore use V3. Link to legacy doc
  • /perf-ux/optimistic-sending. Review with Eng to see if this doc is necessary with V3. Link to legacy doc
  • /perf-ux/get-featured. Review with Eng and GTM to refresh for V3. Link to legacy doc
  • /perf-ux/debug-and-test. Review with Eng to refresh for V3; consider if πŸ—οΈ xmtp-debug repo needs updates. Link to legacy doc
@jhaaaa jhaaaa self-assigned this Nov 13, 2024
@jhaaaa jhaaaa changed the title Tracking issue for documentation updates Tracking issue for new and updated documentation Nov 13, 2024
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

No branches or pull requests

1 participant