Revamp docs left nav #33

jhaaaa · 2024-09-09T22:55:45Z

Preview: https://docs-xmtp-org-git-revamp-doc-nav-ephemerahq.vercel.app/

Revamp left nav to create main sections based on the primary builder use cases
Add a homepage that provides a tile per builder use case. The tile enables us to further highlight the use cases -- as well as provide a short description of each use case.
Combine the existing 1:1 chat "Create a client" section with the existing group chat "Create a client" section to provide a common "Create a client" section that works for both 1:1 and group chat.

Create redirect

https://docs.xmtp.org/dms/client to https://docs.xmtp.org/client/create-client

To do:

Reorg directories and files to match left nav structure. I will do this once we've agreed that the left nav structure is solid.
I will continue to work on making V3 the default state of the docs.
Known issue: When loaded, the left nav sections should be collapsed. This is a known issue with Vocs: When visiting root page all sidebars are opened wevm/vocs#151

vercel · 2024-09-09T22:55:48Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-xmtp-org	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 16, 2024 11:33pm

docs/pages/dms/client.mdx

jhaaaa · 2024-09-11T20:45:58Z

docs/pages/dms/client.mdx

@@ -750,7 +840,21 @@ let client = try await Client.create(account: account, options: clientOptions)
      <th>Parameter</th>
      <th>Default</th>
      <th>Description</th>
-      <th></th>
+    </tr>


Should the following options be added for RN?

dbDirectory = "mydbdir", // Optional: specify database directory dbEncryptionKey = ByteArray(32) // Optional: 32-byte array for database

dbEncryptionKey is not optional if you use V3

But should be added to RN for sure.

docs/pages/dms/client.mdx

nplasterer · 2024-09-13T21:02:31Z

docs/pages/dms/client.mdx

+
+For more information about wallet signature requests, see [Account signatures](/protocol/signatures).
+
+Clients created by XMTP v3 SDKs also support XMTP v2 messages. At a high-level, XMTP v3 is used to support group chat and XMTP v2 is used to support 1:1 chat.


Can also support xmtp v2 messages if the wallet is an EOA.

docs/pages/dms/client.mdx

nplasterer · 2024-09-13T21:03:48Z

docs/pages/dms/client.mdx


-[Use client configuration options](#configure-the-client) to change parameters of a client's network connection.
+Regardless of whether your app provides group chat, set the `enableV3` client option to `true` to benefit from other aspects of the upgraded XMTP v3 protocol.


Note you will not loose v2 functionality by doing this.

nplasterer · 2024-09-13T21:04:37Z

docs/pages/dms/client.mdx

-const xmtp = await Client.create(signer, { env: "dev" });
+const xmtp = await Client.create(signer, {
+  env: "production",
+  enableV3: true, // Enable group chat support


Does not support v3 at the moment so probably shouldnt add here.

@nplasterer Ah, thank you for this - I took it too far! I thought the guidance to have everyone enableV3 meant that at least the flag was available in all SDKs and everyone should set this value. But what we mean is that all apps built with Kotlin, Swift, RN, and Node should set enableV3 to true. GOT IT - thank you!

And the code comment is incorrect 😭. So sorry... I promise I know that group chat is not available for web yet.

docs/pages/dms/client.mdx

nplasterer · 2024-09-13T21:06:36Z

docs/pages/dms/client.mdx

+  env: "production",
+  enableV3: true, // Enable group chat support
+  dbDirectory: "mydbdir", // Optional: specify database directory
+  dbEncryptionKey: new Uint8Array(32), // Optional: 32-byte array for database encryption


Suggested change

dbEncryptionKey: new Uint8Array(32), // Optional: 32-byte array for database encryption

dbEncryptionKey: new Uint8Array(32), // Required 32-byte array for database encryption if enableV3 is true

nplasterer · 2024-09-13T21:08:15Z

docs/pages/dms/client.mdx

+  <tr>
+    <td>dbEncryptionKey</td>
+    <td>null</td>
+    <td>Optional. If not provided, a key is created and stored for you.</td>


This is now Required. We don't create or store keys anymore.

We could link to the recommended key storage in kotlin https://developer.android.com/privacy-and-security/keystore

nplasterer · 2024-09-13T21:09:36Z

docs/pages/dms/client.mdx

+    <tr>
+    <td>dbEncryptionKey</td>
+    <td>null</td>
+    <td>Optional. If not provided, the database remains unencrypted.</td>


Required here as well. https://developer.apple.com/documentation/security/protecting-keys-with-the-secure-enclave

nplasterer · 2024-09-13T21:10:01Z

docs/pages/dms/client.mdx

@@ -750,7 +840,21 @@ let client = try await Client.create(account: account, options: clientOptions)
      <th>Parameter</th>
      <th>Default</th>
      <th>Description</th>
-      <th></th>
+    </tr>


But should be added to RN for sure.

Co-authored-by: Naomi Plasterer <[email protected]>

first pass

3ec4bd4

vercel bot deployed to Preview September 9, 2024 22:56 View deployment

vercel bot deployed to Preview September 10, 2024 21:55 View deployment

jhaaaa force-pushed the revamp-doc-nav branch from 6809ae2 to 8169d89 Compare September 10, 2024 22:19

vercel bot deployed to Preview September 10, 2024 22:20 View deployment

try new homepage

141b3fc

jhaaaa force-pushed the revamp-doc-nav branch from 8169d89 to 141b3fc Compare September 10, 2024 22:22

vercel bot deployed to Preview September 10, 2024 22:23 View deployment

vercel bot deployed to Preview September 11, 2024 18:30 View deployment

jhaaaa marked this pull request as ready for review September 11, 2024 18:38

jhaaaa requested a review from a team as a code owner September 11, 2024 18:38

jhaaaa mentioned this pull request Sep 11, 2024

When visiting root page all sidebars are opened wevm/vocs#151

Open

jhaaaa commented Sep 11, 2024

View reviewed changes

docs/pages/dms/client.mdx Show resolved Hide resolved

single create client doc for v2 and v3

17dd3e1

jhaaaa force-pushed the revamp-doc-nav branch from c49977c to 17dd3e1 Compare September 11, 2024 20:41

vercel bot deployed to Preview September 11, 2024 20:42 View deployment

jhaaaa commented Sep 11, 2024

View reviewed changes

docs/pages/dms/client.mdx Show resolved Hide resolved

add chatbot to left nav

3fbc4f7

vercel bot deployed to Preview September 13, 2024 18:04 View deployment

nplasterer reviewed Sep 13, 2024

View reviewed changes

Merge branch 'main' of github.com:xmtp/docs-xmtp-org into revamp-doc-nav

49ac562

vercel bot deployed to Preview September 13, 2024 23:08 View deployment

jhaaaa added 2 commits September 13, 2024 16:42

provide chat widget page

91e4811

Merge branch 'main' of github.com:xmtp/docs-xmtp-org into revamp-doc-nav

c30dd13

vercel bot deployed to Preview September 14, 2024 01:33 View deployment

add floating inbox

67a83a7

jhaaaa force-pushed the revamp-doc-nav branch from b21d634 to 67a83a7 Compare September 14, 2024 01:36

vercel bot deployed to Preview September 14, 2024 01:36 View deployment

Update docs/pages/dms/client.mdx

72d0280

Co-authored-by: Naomi Plasterer <[email protected]>

vercel bot deployed to Preview September 16, 2024 16:45 View deployment

jhaaaa and others added 2 commits September 16, 2024 10:01

Update docs/pages/dms/client.mdx

7de1716

Co-authored-by: Naomi Plasterer <[email protected]>

Update docs/pages/dms/client.mdx

2c7c0ae

Co-authored-by: Naomi Plasterer <[email protected]>

vercel bot deployed to Preview September 16, 2024 17:02 View deployment

jhaaaa added 2 commits September 16, 2024 11:53

edits from Naomi <3

d54b98d

fix merge conflicts

9850ae3

vercel bot had a problem deploying to Preview September 16, 2024 18:56 Failure

tweaks

de5be70

vercel bot deployed to Preview September 16, 2024 19:25 View deployment

vercel bot deployed to Preview September 16, 2024 20:34 View deployment

jhaaaa force-pushed the revamp-doc-nav branch from 762884c to 42a14ef Compare September 16, 2024 22:20

vercel bot deployed to Preview September 16, 2024 22:21 View deployment

improve table formatting

f38ff69

jhaaaa force-pushed the revamp-doc-nav branch from 42a14ef to f38ff69 Compare September 16, 2024 23:02

vercel bot deployed to Preview September 16, 2024 23:03 View deployment

move client file

e89b313

vercel bot deployed to Preview September 16, 2024 23:33 View deployment

jhaaaa merged commit 6f3d11d into main Sep 16, 2024
2 checks passed

jhaaaa deleted the revamp-doc-nav branch September 16, 2024 23:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revamp docs left nav #33

Revamp docs left nav #33

jhaaaa commented Sep 9, 2024 •

edited

Loading

vercel bot commented Sep 9, 2024 •

edited

Loading

jhaaaa Sep 11, 2024

nplasterer Sep 13, 2024

nplasterer Sep 13, 2024

nplasterer Sep 13, 2024

nplasterer Sep 13, 2024

nplasterer Sep 13, 2024

jhaaaa Sep 16, 2024

jhaaaa Sep 16, 2024

nplasterer Sep 13, 2024

nplasterer Sep 13, 2024

nplasterer Sep 13, 2024

nplasterer Sep 13, 2024

nplasterer Sep 13, 2024


		For more information about wallet signature requests, see [Account signatures](/protocol/signatures).

		Clients created by XMTP v3 SDKs also support XMTP v2 messages. At a high-level, XMTP v3 is used to support group chat and XMTP v2 is used to support 1:1 chat.


		[Use client configuration options](#configure-the-client) to change parameters of a client's network connection.
		Regardless of whether your app provides group chat, set the `enableV3` client option to `true` to benefit from other aspects of the upgraded XMTP v3 protocol.

	dbEncryptionKey: new Uint8Array(32), // Optional: 32-byte array for database encryption
	dbEncryptionKey: new Uint8Array(32), // Required 32-byte array for database encryption if enableV3 is true

Revamp docs left nav #33

Revamp docs left nav #33

Conversation

jhaaaa commented Sep 9, 2024 • edited Loading

Create redirect

vercel bot commented Sep 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jhaaaa commented Sep 9, 2024 •

edited

Loading

vercel bot commented Sep 9, 2024 •

edited

Loading