feat(user-management): add docs for the User Management dashboard

reown-com · Dec 23, 2024 · 3568d00 · 3568d00
1 parent 7a12a36
commit 3568d00
Show file tree

Hide file tree

Showing 12 changed files with 52 additions and 14,665 deletions.
diff --git a/docs/appkit/features/siwx/siwx-cloud-auth.mdx b/docs/appkit/features/siwx/siwx-cloud-auth.mdx
@@ -5,6 +5,6 @@ displayed_sidebar: mainSidebar
 
 import SiwxCloudAuth from '../../shared/siwx/siwx-cloud-auth.mdx'
 
-# SIWX Cloud Auth Usage
+# Cloud Auth SIWX Usage
 
 <SiwxCloudAuth />
diff --git a/docs/appkit/javascript/core/siwx-cloud-auth.mdx b/docs/appkit/javascript/core/siwx-cloud-auth.mdx
@@ -5,6 +5,6 @@ displayed_sidebar: mainSidebar
 
 import SiwxCloudAuth from '../../shared/siwx/siwx-cloud-auth.mdx'
 
-# SIWX Cloud Auth Usage
+# Cloud Auth SIWX Usage
 
 <SiwxCloudAuth />
diff --git a/docs/appkit/next/core/siwx-cloud-auth.mdx b/docs/appkit/next/core/siwx-cloud-auth.mdx
@@ -5,6 +5,6 @@ displayed_sidebar: mainSidebar
 
 import SiwxCloudAuth from '../../shared/siwx/siwx-cloud-auth.mdx'
 
-# SIWX Cloud Auth Usage
+# Cloud Auth SIWX Usage
 
 <SiwxCloudAuth />
diff --git a/docs/appkit/react/core/siwx-cloud-auth.mdx b/docs/appkit/react/core/siwx-cloud-auth.mdx
@@ -5,6 +5,6 @@ displayed_sidebar: mainSidebar
 
 import SiwxCloudAuth from '../../shared/siwx/siwx-cloud-auth.mdx'
 
-# SIWX Cloud Auth Usage
+# Cloud Auth SIWX Usage
 
 <SiwxCloudAuth />
diff --git a/docs/appkit/shared/siwx/index.mdx b/docs/appkit/shared/siwx/index.mdx
@@ -23,7 +23,7 @@ Read more about the [Default Implementation](./siwx-default).
 
 ### Cloud Auth Implementation
 
-The Cloud Auth SIWX is a predefined implementation of the SIWX configuration plugin that uses the Cloud service to create and manage SIWX messages and sessions. With Cloud Auth SIWX, you will be able to see and control the sessions of your users using the Cloud Dashboard.
+The Cloud Auth SIWX is a predefined implementation of the SIWX configuration plugin that uses the Cloud service to create and manage SIWX messages and sessions. With Cloud Auth SIWX, you will be able to see and control the sessions of your users using the [User Management Dashboard](/cloud/user-management.mdx).
 
 Read more about the [Cloud Auth Implementation](./siwx-cloud-auth).
 

diff --git a/docs/appkit/shared/siwx/siwx-cloud-auth.mdx b/docs/appkit/shared/siwx/siwx-cloud-auth.mdx
@@ -1,6 +1,6 @@
 Cloud Auth SIWX is a predefined implementation of the SIWX configuration plugin that uses the Cloud service to create and manage SIWX messages and sessions.
 
-With Cloud Auth SIWX you will be able to see and control the sessions of your users using Cloud Dashboard.
+With Cloud Auth SIWX you will be able to see and control the sessions of your users using the [User Management Dashboard](/cloud/user-management.mdx).
 
 :::caution
 

diff --git a/docs/appkit/vue/core/siwx-cloud-auth.mdx b/docs/appkit/vue/core/siwx-cloud-auth.mdx
@@ -5,6 +5,6 @@ displayed_sidebar: mainSidebar
 
 import SiwxCloudAuth from '../../shared/siwx/siwx-cloud-auth.mdx'
 
-# SIWX Cloud Auth Usage
+# Cloud Auth SIWX Usage
 
 <SiwxCloudAuth />
diff --git a/docs/cloud/user-management.mdx b/docs/cloud/user-management.mdx
@@ -0,0 +1,44 @@
+---
+title: User Management
+---
+
+# User Management
+
+Easily view and manage all authenticated users through AppKit [Cloud Auth SIWX](/appkit/features/siwx/siwx-cloud-auth), a drop-in hosted SIWX server that provides key insights into your user base.
+
+## Usage
+
+Refer to [Cloud Auth SIWX](/appkit/features/siwx/siwx-cloud-auth) for instructions on enabling this feature with AppKit.
+
+## Dashboard
+
+The dashboard provides a list of all accounts (chain + address) connected to your dapp, including the country they connected from, the last connection time, and the authentication method (wallet or social login).
+
+![User Management](/assets/user-management.png)
+
+## Insights
+
+We plan to add more insights over time. Currently, it includes:
+
+- **Connections**: Authenticated users over time  
+- **Geographic Distribution**: User distribution by country  
+- **Wallet Analytics**: Which wallets are most commonly used  
+- **30-Day History**: Historical data for the past 30 days  
+
+![User Management](/assets/Insights.png)
+
+# SIWX API
+
+The Cloud Auth SIWX API is a hosted server implementing [Sign In With X/Anything (SIWX)](https://chainagnostic.org/CAIPs/caip-122). SIWX is a chain-agnostic variant of [Sign In With Ethereum (SIWE)](https://eips.ethereum.org/EIPS/eip-4361). To connect to your dapp, users must sign a message. The message signature is forwarded to our server, which verifies it and issues a JWT upon successful authentication.
+
+## Why Use Our API Instead of Building Your Own?
+
+Our solution abstracts the complexity and maintenance costs of running a SIWX server. Another benefit is immediate access to key user insights in your dashboard, as shown above. The API leverages Cloudflare Workers for global distribution and has built-in rate limiting.
+
+## Limitations
+
+:::warning
+The feature is currently in beta.
+:::
+
+Currently, this feature and its API are only available for AppKit projects and only supports EVM networks. We plan to make it available for all Reown projects and will add more networks in upcoming versions.