add docs format

dapplink-labs · Oct 5, 2024 · f63a936 · f63a936
1 parent 26c1d10
commit f63a936
Show file tree

Hide file tree

Showing 53 changed files with 120 additions and 51 deletions.
diff --git a/docs/.vitepress/config/en.ts b/docs/.vitepress/config/en.ts
@@ -13,7 +13,7 @@ export const en = defineConfig({
 
     sidebar: {
       '/dapplink/': { base: '/dapplink/', items: sidebarDappLink() },
-      '/wallet/': { base: '/wallet/', items: sidebarwallet() }
+      '/wallet/': { base: '/wallet/', items: sidebarWallet() }
     },
 
     editLink: {
@@ -32,7 +32,7 @@ function nav(): DefaultTheme.NavItem[] {
   return [
     {
       text: 'DappLink',
-      link: '/dapplink/what-is-dapplink-docs',
+      link: '/dapplink/what-is-dapplink',
       activeMatch: '/dapplink/'
     },
     {
@@ -42,18 +42,18 @@ function nav(): DefaultTheme.NavItem[] {
     },
     {
       text: 'DA',
-      link: '/dapplink/site-config',
-      activeMatch: '/wallet/'
+      link: '/da/overview',
+      activeMatch: '/da/'
     },
     {
       text: 'L2 & L3',
-      link: '/dapplink/site-config',
-      activeMatch: '/wallet/'
+      link: '/chain/overview',
+      activeMatch: '/chain/'
     },
     {
       text: 'Dapps',
-      link: '/dapplink/site-config',
-      activeMatch: '/wallet/'
+      link: '/dapps/overview',
+      activeMatch: '/dapps/'
     },
     {
       text: pkg.version,
@@ -77,32 +77,71 @@ function sidebarDappLink(): DefaultTheme.SidebarItem[] {
       text: 'Introduction',
       collapsed: false,
       items: [
-        { text: 'What is DappLink?', link: 'what-is-dapplink-docs' },
-        { text: 'DappLink Layer3', link: 'dapplink-layer3' },
+        { text: 'What is DappLink ？', link: 'what-is-dapplink' },
+        { text: 'DappLink Core Business', link: 'core-business' },
+      ]
+    },
+    {
+      text: 'DappLink Layer3',
+      collapsed: false,
+      items: [
+        { text: 'What is DappLink Layer3 ？', link: 'what-is-dapplink-layer3' },
+      ]
+    },
+    {
+      text: 'One-Click Wallet Deployment',
+      collapsed: false,
+      items: [
+        { text: 'What is One-Click Wallet Deployment ？', link: 'what-is-dapplink-wallet' },
+      ]
+    },
+    {
+      text: 'One-Click Chain Deployment',
+      collapsed: false,
+      items: [
+        { text: 'What is One-Click L2&L3 Deployment ？', link: 'what-is-dapplink-chain' },
+      ]
+    },
+    {
+      text: 'One-Click DA Deployment',
+      collapsed: false,
+      items: [
+        { text: 'What is One-Click DA Deployment ？', link: 'what-is-dapplink-da' },
       ]
     },
     {
-      text: 'xxxxx',
+      text: 'One-Click Deployment of Decentralized Composite Applications',
       collapsed: false,
       items: [
-        { text: 'xxxx', link: 'xxxx' },
+        { text: 'What are Decentralized Composite Applications ？', link: 'what-is-dapplink-dapps' },
       ]
     }
   ]
 }
 
-function sidebarwallet(): DefaultTheme.SidebarItem[] {
+function sidebarWallet(): DefaultTheme.SidebarItem[] {
   return [
     {
-      text: 'wallet',
+      text: 'One-Click Wallet Deployment',
       items: [
-        { text: 'Overview', link: 'overview' },
-        { text: 'DappLink Wallet', link: 'dapplink-wallet' },
+        { text: 'System Architecture', link: 'overview' },
+        { text: 'Core Function', link: 'dapplink-wallet' },
         {
-          text: 'Projects',
-          base: '/dapplink/default-theme-',
+          text: 'Project Components',
+          base: '/wallet/',
           items: [
-            { text: 'wallet-chain-node', link: 'config' }
+            { text: 'Unified Browser API Code Library', link: 'chain-explorer-api' },
+            { text: 'Unified RPC Interface Service', link: 'wallet-chain-node' },
+            { text: 'Key Management Tool', link: 'key-locker' },
+            { text: 'Underlying Library for Threshold Secret Sharing Algorithms', link: 'dapplink-secret' },
+            { text: 'Market Aggregator', link: 'skyeye' },
+            { text: 'Trade System', link: 'trade' },
+            { text: 'Offline Sign SDK', link: 'wallet-sdk' },
+            { text: 'MPC Network', link: 'tss' },
+            { text: 'Cross-Chain Staking Project', link: 'linklayer' },
+            { text: 'HD Wallet Backend Service', link: 'hailstone' },
+            { text: 'Unified Wallet Services for Deposit, Withdrawal, Aggregation, Cold Transfer, and Risk Control', link: 'wallet-scanner' },
+            { text: 'Centralized Wallet Business Components', link: 'centralized-wallet-servicer' }
           ]
         }
       ]

diff --git a/docs/.vitepress/config/zh.ts b/docs/.vitepress/config/zh.ts
@@ -13,7 +13,7 @@ export const zh = defineConfig({
 
     sidebar: {
       '/zh/dapplink/': { base: '/zh/dapplink/', items: sidebarDappLink() },
-      '/zh/wallet/': { base: '/zh/wallet/', items: sidebarwallet() }
+      '/zh/wallet/': { base: '/zh/wallet/', items: sidebarWallet() }
     },
 
     editLink: {
@@ -56,7 +56,7 @@ function nav(): DefaultTheme.NavItem[] {
   return [
     {
       text: 'DappLink',
-      link: '/zh/dapplink/what-is-dapplink-docs',
+      link: '/zh/dapplink/what-is-dapplink',
       activeMatch: '/zh/dapplink/'
     },
     {
@@ -66,18 +66,18 @@ function nav(): DefaultTheme.NavItem[] {
     },
     {
       text: '公链',
-      link: '/zh/dapplink/site-config',
-      activeMatch: '/zh/wallet/'
+      link: '/zh/chain/overview',
+      activeMatch: '/zh/chain/'
     },
     {
       text: 'DA',
-      link: '/zh/dapplink/site-config',
-      activeMatch: '/zh/wallet/'
+      link: '/zh/da/overview',
+      activeMatch: '/zh/da/'
     },
     {
       text: '去中心化应用',
-      link: '/zh/dapplink/site-config',
-      activeMatch: '/zh/wallet/'
+      link: '/zh/dapps/overview',
+      activeMatch: '/zh/dapps/'
     },
     {
       text: pkg.version,
@@ -101,61 +101,71 @@ function sidebarDappLink(): DefaultTheme.SidebarItem[] {
       text: '简介',
       collapsed: false,
       items: [
-        { text: '什么是 DappLink ？', link: 'what-is-dapplink-docs' },
-        { text: 'DappLink Layer3', link: 'dapplink-layer3' },
+        { text: '什么是 DappLink ？', link: 'what-is-dapplink' },
+        { text: 'DappLink 核心业务', link: 'core-business' },
       ]
     },
     {
-      text: '一键发钱包',
+      text: 'DappLink Layer3',
       collapsed: false,
       items: [
-        { text: '什么是一键发钱包', link: 'what-is-dapplink-docs' },
+        { text: '什么是 DappLink Layer3 ？', link: 'what-is-dapplink-layer3' },
       ]
     },
     {
-      text: 'DappLink Layer3',
+      text: '一键发钱包',
       collapsed: false,
       items: [
-        { text: '什么是 DappLink Layer3', link: 'what-is-dapplink-docs' },
+        { text: '什么是一键发钱包 ？', link: 'what-is-dapplink-wallet' },
       ]
     },
     {
       text: '一键发公链',
       collapsed: false,
       items: [
-        { text: '什么是一键发链', link: 'what-is-dapplink-docs' },
+        { text: '什么是一键发链 ？', link: 'what-is-dapplink-chain' },
       ]
     },
     {
       text: '一键发 DA',
       collapsed: false,
       items: [
-        { text: '什么是一键发 DA', link: 'what-is-dapplink-docs' },
+        { text: '什么是一键发 DA ？', link: 'what-is-dapplink-da' },
       ]
     },
     {
-      text: '一键发组合去中心化应用',
+      text: '一键发去中心化组合应用',
       collapsed: false,
       items: [
-        { text: '什么是组合去中心化应用', link: 'what-is-dapplink-docs' },
+        { text: '什么是去中心化组合应用 ？', link: 'what-is-dapplink-dapps' },
       ]
     }
   ]
 }
 
-function sidebarwallet(): DefaultTheme.SidebarItem[] {
+function sidebarWallet(): DefaultTheme.SidebarItem[] {
   return [
     {
       text: '一键发钱包',
       items: [
-        { text: '钱包架构', link: 'overview' },
-        { text: '钱包功能模块', link: 'dapplink-wallet' },
+        { text: '系统架构', link: 'overview' },
+        { text: '核心功能模块', link: 'dapplink-wallet' },
         {
-          text: '项目组成',
-          base: '/zh/dapplink/default-theme-',
+          text: '项目组件',
+          base: '/zh/wallet/',
           items: [
-            { text: 'wallet-chain-node', link: 'config' },
-            { text: 'sky-eye', link: 'nav' },
+            { text: '统一浏览器代码库', link: 'chain-explorer-api' },
+            { text: '统一 RPC 接口服务', link: 'wallet-chain-node' },
+            { text: '密钥托管工具', link: 'key-locker' },
+            { text: '门限共享秘密算法的底层库', link: 'dapplink-secret' },
+            { text: '行情聚合器物', link: 'skyeye' },
+            { text: '交易系统', link: 'trade' },
+            { text: '离线签名 SDK', link: 'wallet-sdk' },
+            { text: 'MPC 网络', link: 'tss' },
+            { text: '跨链质押项目', link: 'linklayer' },
+            { text: 'HD 钱包后端服务服务', link: 'hailstone' },
+            { text: '统一充值，提现，归集，转冷，风控的钱包服务', link: 'wallet-scanner' },
+            { text: '中心化钱包业务组件', link: 'centralized-wallet-servicer' }
           ]
         }
       ]

diff --git a/docs/en/chain/overview.md b/docs/en/chain/overview.md
@@ -0,0 +1,3 @@
+# Overview {#overview}
+
+
diff --git a/docs/en/da/overview.md b/docs/en/da/overview.md
@@ -0,0 +1,3 @@
+# Overview {#overview}
+
+
diff --git a/docs/en/dapplink/core-business.md b/docs/en/dapplink/core-business.md
diff --git a/docs/en/dapplink/what-is-dapplink-chain.md b/docs/en/dapplink/what-is-dapplink-chain.md
diff --git a/docs/en/dapplink/what-is-dapplink-da.md b/docs/en/dapplink/what-is-dapplink-da.md
diff --git a/docs/en/dapplink/what-is-dapplink-dapps.md b/docs/en/dapplink/what-is-dapplink-dapps.md
diff --git a/docs/en/dapplink/dapplink-layer3.md → docs/en/dapplink/what-is-dapplink-layer3.md b/docs/en/dapplink/dapplink-layer3.md → docs/en/dapplink/what-is-dapplink-layer3.md
diff --git a/docs/en/dapplink/what-is-dapplink-wallet.md b/docs/en/dapplink/what-is-dapplink-wallet.md
diff --git a/docs/en/dapplink/what-is-dapplink-docs.md → docs/en/dapplink/what-is-dapplink.md b/docs/en/dapplink/what-is-dapplink-docs.md → docs/en/dapplink/what-is-dapplink.md
diff --git a/docs/en/dapps/overview.md b/docs/en/dapps/overview.md
@@ -0,0 +1,3 @@
+# Overview {#overview}
+
+
diff --git a/docs/en/wallet/centralized-wallet-servicer.md b/docs/en/wallet/centralized-wallet-servicer.md
diff --git a/docs/en/wallet/chain-explorer-api.md b/docs/en/wallet/chain-explorer-api.md
diff --git a/docs/en/wallet/core-function.md b/docs/en/wallet/core-function.md
@@ -0,0 +1,2 @@
+# DappLink Wallet {#dapplink-wallet}
+
diff --git a/docs/en/wallet/dapplink-secret.md b/docs/en/wallet/dapplink-secret.md
diff --git a/docs/en/wallet/dapplink-wallet.md b/docs/en/wallet/dapplink-wallet.md
@@ -1 +0,0 @@
-# DappLink Wallet {#dapplink-wallet}

diff --git a/docs/en/wallet/hailstone.md b/docs/en/wallet/hailstone.md
diff --git a/docs/en/wallet/key-locker.md b/docs/en/wallet/key-locker.md
diff --git a/docs/en/wallet/linklayer.md b/docs/en/wallet/linklayer.md
diff --git a/docs/en/wallet/overview.md b/docs/en/wallet/overview.md
@@ -1,2 +1,3 @@
 # Overview {#overview}
 
+
diff --git a/docs/en/wallet/skyeye.md b/docs/en/wallet/skyeye.md
diff --git a/docs/en/wallet/trade.md b/docs/en/wallet/trade.md
diff --git a/docs/en/wallet/tss.md b/docs/en/wallet/tss.md
diff --git a/docs/en/wallet/wallet-chain-node.md b/docs/en/wallet/wallet-chain-node.md
diff --git a/docs/en/wallet/wallet-scanner.md b/docs/en/wallet/wallet-scanner.md
diff --git a/docs/en/wallet/wallet-sdk.md b/docs/en/wallet/wallet-sdk.md
diff --git a/docs/zh/chain/overview.md b/docs/zh/chain/overview.md
@@ -0,0 +1,3 @@
+# Overview {#overview}
+
+
diff --git a/docs/zh/da/overview.md b/docs/zh/da/overview.md
@@ -0,0 +1,3 @@
+# Overview {#overview}
+
+
diff --git a/docs/zh/dapplink/core-business.md b/docs/zh/dapplink/core-business.md
diff --git a/docs/zh/dapplink/dapplink-layer3.md b/docs/zh/dapplink/dapplink-layer3.md
diff --git a/docs/zh/dapplink/what-is-dapplink-chain.md b/docs/zh/dapplink/what-is-dapplink-chain.md
diff --git a/docs/zh/dapplink/what-is-dapplink-da.md b/docs/zh/dapplink/what-is-dapplink-da.md
diff --git a/docs/zh/dapplink/what-is-dapplink-dapps.md b/docs/zh/dapplink/what-is-dapplink-dapps.md
diff --git a/docs/zh/dapplink/what-is-dapplink-docs.md b/docs/zh/dapplink/what-is-dapplink-docs.md
diff --git a/docs/zh/dapplink/what-is-dapplink-layer3.md b/docs/zh/dapplink/what-is-dapplink-layer3.md
@@ -0,0 +1,2 @@
+# DappLink Layer3
+
diff --git a/docs/zh/dapplink/what-is-dapplink-wallet.md b/docs/zh/dapplink/what-is-dapplink-wallet.md
diff --git a/docs/zh/dapplink/what-is-dapplink.md b/docs/zh/dapplink/what-is-dapplink.md
@@ -0,0 +1,2 @@
+# What is DappLink?
+
diff --git a/docs/zh/dapps/overview.md b/docs/zh/dapps/overview.md
@@ -0,0 +1,3 @@
+# Overview {#overview}
+
+
diff --git a/docs/zh/wallet/centralized-wallet-servicer.md b/docs/zh/wallet/centralized-wallet-servicer.md
diff --git a/docs/zh/wallet/chain-explorer-api.md b/docs/zh/wallet/chain-explorer-api.md
diff --git a/docs/zh/wallet/core-function.md b/docs/zh/wallet/core-function.md
@@ -0,0 +1,2 @@
+# DappLink Wallet {#dapplink-wallet}
+
diff --git a/docs/zh/wallet/dapplink-secret.md b/docs/zh/wallet/dapplink-secret.md
diff --git a/docs/zh/wallet/dapplink-wallet.md b/docs/zh/wallet/dapplink-wallet.md
@@ -1,2 +0,0 @@
-# DappLink Wallet {#dapplink-wallet}
-

diff --git a/docs/zh/wallet/hailstone.md b/docs/zh/wallet/hailstone.md
diff --git a/docs/zh/wallet/key-locker.md b/docs/zh/wallet/key-locker.md
diff --git a/docs/zh/wallet/linklayer.md b/docs/zh/wallet/linklayer.md
diff --git a/docs/zh/wallet/skyeye.md b/docs/zh/wallet/skyeye.md
diff --git a/docs/zh/wallet/trade.md b/docs/zh/wallet/trade.md
diff --git a/docs/zh/wallet/tss.md b/docs/zh/wallet/tss.md
diff --git a/docs/zh/wallet/wallet-chain-node.md b/docs/zh/wallet/wallet-chain-node.md
diff --git a/docs/zh/wallet/wallet-scanner.md b/docs/zh/wallet/wallet-scanner.md
diff --git a/docs/zh/wallet/wallet-sdk.md b/docs/zh/wallet/wallet-sdk.md