Merge pull request #1 from haoxiuwen/doc

merge doc-v2
easemob · Dec 24, 2024 · f2ab2f8 · f2ab2f8
2 parents a326408 + 70715d0
commit f2ab2f8
Show file tree

Hide file tree

Showing 318 changed files with 6,065 additions and 3,664 deletions.
diff --git a/docs/.vuepress/public/images/demo/web_react_login.png b/docs/.vuepress/public/images/demo/web_react_login.png
diff --git a/...press/public/images/uikit/chatuikit/feature/web/common/message_read_receipt.png b/...press/public/images/uikit/chatuikit/feature/web/common/message_read_receipt.png
diff --git a/docs/.vuepress/public/images/uikit/chatuikit/feature/web/common/下载.zip b/docs/.vuepress/public/images/uikit/chatuikit/feature/web/common/下载.zip
diff --git a/docs/.vuepress/public/images/web/message_receipt.png b/docs/.vuepress/public/images/web/message_receipt.png
diff --git a/docs/.vuepress/sidebar/document.ts b/docs/.vuepress/sidebar/document.ts
@@ -25,9 +25,6 @@ const documentSidebar = [
       { text: 'Demo（EaseIM App）体验', link: 'demo.html', except: ['web', 'windows', 'react-native', 'flutter', 'unity', 'server-side'] },
       { text: '快速开始', link: 'quickstart.html', except: ['windows', 'react-native', 'flutter', 'unity', 'server-side'] },
       { text: '快速开始', link: 'quickstart.html', only: ['windows', 'react-native', 'flutter', 'unity'] },
-      { text: '按需导入 SDK（推荐）', link: 'import_sdk_minicore.html', only: ['web'] },
-      { text: 'SDK 集成概述', link: 'overview.html', only: ['android', 'ios', 'web', 'harmonyos', 'flutter'] },
-      { text: 'SDK 集成概述', link: 'overview.html', only: ['windows', 'react-native', 'unity'] },
       // { text: '私有云 SDK 集成配置', link: 'privatecloud.html', except: ['windows', 'server-side', 'react-native', 'flutter', 'unity'] },
       { text: 'SDK 更新日志', link: 'releasenote.html', except: ['server-side']},
       /*{ text: 'API reference', link: 'apireference.html', only: ['android', 'ios', 'web', 'windows', 'react-native', 'flutter', 'unity']},*/
@@ -40,8 +37,19 @@ const documentSidebar = [
     except: ['applet', 'electron','linux']
   },
   {
-    text: '基础功能',
+    text: '用户指南',
     children: [
+      { text: '集成 SDK', link: 'integration.html' },
+      { text: '初始化', link: 'initialization.html' },
+      {
+        text: '登录',
+        collapsible: true,
+        children: [
+          { text: '登录介绍', link: 'login.html' },
+          { text: '连接', link: 'connection.html' },
+          { text: '多设备登录', link: 'multi_device.html' },
+        ]
+      },
       {
         text: '消息管理',
         collapsible: true,
@@ -53,13 +61,15 @@ const documentSidebar = [
           { text: '搜索消息', link: 'message_search.html', except: ['web', 'harmonyos']},
           { text: '消息回执', link: 'message_receipt.html'},
           { text: '修改消息', link: 'message_modify.html'},
+          { text: '消息表情回复', link: 'reaction.html' },
           { text: '转发消息', link: 'message_forward.html', except: ['web']},
           { text: '导入和插入消息', link: 'message_import_insert.html', except: ['web']},
           { text: '更新消息', link: 'message_update.html', except: ['web']},
           { text: '删除消息', link: 'message_delete.html' },    
           { text: '置顶消息', link: 'message_pin.html', except: ['harmonyos']},         
           { text: '翻译消息', link: 'message_translation.html', except: ['harmonyos']},
           { text: '只投在线用户', link: 'message_deliver_only_online.html'},
+          { text: '消息审核（举报）', link: 'moderation.html', except: ['harmonyos']},
           { text: '获取消息流量统计', link: 'message_traffic_statis.html', only: ['android', 'ios'] },
         ]
       },
@@ -70,15 +80,13 @@ const documentSidebar = [
           { text: '会话介绍', link: 'conversation_overview.html' },
           { text: '会话列表', link: 'conversation_list.html' },
           { text: '本地会话', link: 'conversation_local.html', only: ['web'] },
-          { text: '会话已读回执', link: 'conversation_receipt.html', only: ['android', 'ios', 'web'] },
+          { text: '会话已读回执', link: 'conversation_receipt.html' },
           { text: '会话未读数', link: 'conversation_unread.html', except: ['web'] },
           { text: '置顶会话', link: 'conversation_pin.html' },
           { text: '会话标记', link: 'conversation_mark.html' },
           { text: '删除会话', link: 'conversation_delete.html' },
         ]
       },
-      { text: '管理用户属性', link: 'userprofile.html' },
-      { text: '管理用户关系', link: 'user_relationship.html' },
       {
         text: '群组管理',
         collapsible: true,
@@ -87,6 +95,8 @@ const documentSidebar = [
           { text: '创建和管理群组', link: 'group_manage.html' },
           { text: '管理群组成员', link: 'group_members.html' },
           { text: '管理群组属性', link: 'group_attributes.html' },
+          { text: '管理子区', link: 'thread.html', except: ['harmonyos'] },
+          { text: '管理子区消息', link: 'thread_message.html', except: ['harmonyos'] }
         ]
       },
       {
@@ -99,13 +109,16 @@ const documentSidebar = [
           { text: '管理聊天室属性', link: 'room_attributes.html' },
         ]
       },
-    ],
-    except: ['applet', 'server-side', 'electron','linux']
-  },
-  {
-    text: '进阶功能',
-    children: [
-      { 
+      {
+        text: '用户相关',
+        collapsible: true,
+        children: [
+          { text: '用户关系', link: 'user_relationship.html' },
+          { text: '用户属性', link: 'userprofile.html' },
+          { text: '在线状态订阅', link: 'presence.html' },
+        ]
+      },
+      {
         text: '离线推送', 
         collapsible: true,
         children: [
@@ -139,33 +152,33 @@ const documentSidebar = [
           { text: 'FAQ', link: 'push/push_solution.html', only: ['android', 'ios','harmonyos']},
         ]
       },
-      { text: '登录多个设备', link: 'multi_device.html' },
-      { text: '管理在线状态订阅', link: 'presence.html' },
-      { text: '消息表情回复', link: 'reaction.html' },
-      {
-        text: '子区管理',
-        collapsible: true,
-        children: [
-          { text: '管理子区', link: 'thread.html', except: ['harmonyos'] },
-          { text: '管理子区消息', link: 'thread_message.html', except: ['harmonyos'] }
-        ]
-      },
-      { text: '消息审核（举报）', link: 'moderation.html', except: ['harmonyos']},
     ],
     except: ['applet','server-side','electron','linux']
   },
   {
-    text: '其他',
+    text: '错误排查',
     children: [
       { text: '错误码', link: 'error.html' },
-      //{ text: 'EaseIMKit 使用指南', link: 'easeimkit.html', except: ['web', 'windows', 'react-native', 'flutter', 'unity'] },
-      { text: 'EaseCallKit 使用指南', link: 'easecallkit.html', except: ['web', 'windows', 'react-native', 'flutter', 'unity', 'harmonyos'] },
+      { text: '日志', link: 'log.html', except: ['flutter'] },
+    ],
+    except: ['applet', 'server-side','electron','linux']
+  },
+  {
+    text: 'CallKit 使用指南',
+    children: [
+      { text: 'EaseCallKit 使用指南', link: 'easecallkit.html', only: ['android', 'ios'] },
       { text: 'CallKit 使用指南', link: 'easecallkit.html', only: ['web'] },
-      { text: '苹果隐私策略', link: 'privacy_policy.html', only: ['ios'] },
     ],
     except: ['applet', 'server-side','electron','linux']
 
   },
+  {
+    text: '苹果隐私策略',
+    children: [
+      { text: '苹果隐私策略', link: 'privacy_policy.html', only: ['ios'] },
+    ],
+    except: ['applet', 'server-side','electron','linux']
+  },
   {
     text: '精简版 SDK',
     children: [
@@ -182,22 +195,30 @@ const documentSidebar = [
     only: ['applet']
   },
   {
-    text: '集成介绍',
+    text: '用户指南',
     children: [
-      { text: '微信小程序', link: 'wechat.html' },
-      { text: 'QQ 小程序', link: 'qq.html' },
-      { text: '百度小程序', link: 'baidu.html' },
-      { text: '抖音小程序', link: 'bytedance.html' },
-      { text: '支付宝小程序', link: 'alipay.html' },
-      { text: 'Uniapp 全平台', link: 'uniapp.html' },
-      { text: '小程序 API 文档', link: 'apidoc.html' },
-    ],
-    only: ['applet']
-  },
-  {
-    text: '基本功能',
-    children: [
-      { text: '初始化及登录', link: 'initialization.html' },
+      {
+        text: '集成介绍',
+        collapsible: true,
+        children: [
+          { text: '微信小程序', link: 'wechat.html' },
+          { text: 'QQ 小程序', link: 'qq.html' },
+          { text: '百度小程序', link: 'baidu.html' },
+          { text: '抖音小程序', link: 'bytedance.html' },
+          { text: '支付宝小程序', link: 'alipay.html' },
+          { text: 'Uniapp 全平台', link: 'uniapp.html' },
+        ],
+      },
+      { text: '初始化', link: 'initialization.html' },
+      {
+        text: '登录',
+        collapsible: true,
+        children: [
+          { text: '登录介绍', link: 'login.html' },
+          { text: '连接', link: 'connection.html' },
+          { text: '多设备登录', link: 'multi_device.html' },
+        ],  
+      },
       {
         text: '消息管理',
         collapsible: true,
@@ -207,11 +228,13 @@ const documentSidebar = [
           { text: '获取历史消息', link: 'message_retrieve.html' },
           { text: '撤回消息', link: 'message_recall.html' },
           { text: '消息回执', link: 'message_receipt.html' }, 
+          { text: '消息表情回复', link: 'reaction.html' },
           { text: '修改消息', link: 'message_modify.html' },
           { text: '删除消息', link: 'message_delete.html' },
           { text: '置顶消息', link: 'message_pin.html' }, 
           { text: '翻译消息', link: 'message_translation.html' },
-          { text: '只投在线用户', link: 'message_deliver_only_online.html'},        
+          { text: '只投在线用户', link: 'message_deliver_only_online.html'},  
+          { text: '消息审核（举报）', link: 'moderation.html'},      
         ]
       },
       {
@@ -226,8 +249,6 @@ const documentSidebar = [
           { text: '删除会话', link: 'conversation_delete.html'},
         ]
       },
-      { text: '管理用户属性', link: 'userprofile.html' },
-      { text: '管理用户关系', link: 'user_relationship.html' },
       {
         text: '群组管理',
         collapsible: true,
@@ -236,6 +257,14 @@ const documentSidebar = [
           { text: '创建和管理群组', link: 'group_manage.html' },
           { text: '管理群组成员', link: 'group_members.html' },
           { text: '管理群组属性', link: 'group_attributes.html' },
+          {
+            text: '子区管理',
+            collapsible: true,
+            children: [
+              { text: '管理子区', link: 'thread.html' },
+              { text: '管理子区消息', link: 'thread_message.html' }
+            ]
+          },
         ]
       },
       {
@@ -248,12 +277,15 @@ const documentSidebar = [
           { text: '管理聊天室属性', link: 'room_attributes.html' },
         ]
       },
-    ],
-    only: ['applet']
-  },
-  {
-    text: '进阶功能',
-    children: [
+      {
+        text: '用户相关',
+        collapsible: true,
+        children: [
+          { text: '用户关系', link: 'user_relationship.html' },
+          { text: '用户属性', link: 'userprofile.html' },
+          { text: '在线状态订阅', link: 'presence.html' },
+        ]
+      },    
       { text: '离线推送', 
         collapsible: true,
         children: [
@@ -265,25 +297,21 @@ const documentSidebar = [
         { text: 'uni-app 离线推送', link: 'push/uniapp_push.html' }
         ]
       }, 
-      { text: '登录多个设备', link: 'multi_device.html' },
-      { text: '管理在线状态订阅', link: 'presence.html' },
-      { text: '消息表情回复', link: 'reaction.html' },
-      {
-        text: '子区管理',
-        collapsible: true,
-        children: [
-          { text: '管理子区', link: 'thread.html' },
-          { text: '管理子区消息', link: 'thread_message.html' }
-        ]
-      },
-      { text: '消息审核（举报）', link: 'moderation.html'},
     ],
     only: ['applet']
   },
   {
-    text: '其他帮助',
+    text: '错误排查',
     children: [
       { text: '错误码', link: 'error.html' },
+      { text: '日志', link: 'log.html' },
+    ],
+    only: ['applet']
+  },
+  {
+    text: '其他帮助',
+    children: [
+      { text: '小程序 API 文档', link: 'apidoc.html' },
       { text: 'Uniapp 生成原生 Android、iOS 应用', link: 'uniappnativeapp.html' },
       { text: '小程序模板使用指南', link: 'uniappuikit.html' },
       { text: '如何配置服务器域名', link: 'serverconfig.html' },

diff --git a/docs/.vuepress/sidebar/index.ts b/docs/.vuepress/sidebar/index.ts
@@ -20,6 +20,7 @@ export const zhSidebar = sidebar({
       children: [
         { text: "产品概述", link: "introduction.html" },
         { text: "特性介绍",
+          collapsible: true,
           children: [
             { text: "消息", 
               collapsible: true,
@@ -67,22 +68,6 @@ export const zhSidebar = sidebar({
         { text: "Demo 体验及源码地址", link: "demo_sourcecode_address.html" },
       ],
     },
-    {
-      text: "快速开始",
-      children: [
-        { text: "使用环信 App Token 鉴权", link: "easemob_app_token.html" },
-        { text: "使用环信 User Token 鉴权", link: "easemob_user_token.html" },
-        { text: "快速开始 Android", link: "/document/android/quickstart.html" },
-        { text: "快速开始 iOS", link: "/document/ios/quickstart.html" },
-        { text: "快速开始 Web", link: "/document/web/quickstart.html" },
-        { text: "快速开始 Applet", link: "/document/applet/wechat.html" },
-        { text: "快速开始 HarmonyOS", link: "/document/harmonyos/quickstart.html" },
-        { text: "快速开始 Flutter", link: "/document/flutter/quickstart.html" },
-        { text: "快速开始 React Native", link: "/document/react-native/quickstart.html" },
-        { text: "快速开始 Unity", link: "/document/unity/quickstart.html" },
-        { text: "快速开始 Windows", link: "/document/windows/quickstart.html" },
-      ],
-    },
     {
       text: "内容审核",
       children: [
@@ -338,6 +323,7 @@ export const zhSidebar = sidebar({
       children: [
         { text: "群 @ 消息", link: "solution_common/[email protected]" },
         { text: "消息引用", link: "solution_common/message_quote.html" },
+        { text: "实现输入指示器", link: "solution_common/typing_indication.html" },
         { text: "迁移到环信", link: "solution_common/migrate_to_easemob.html" },
       ],
     },

diff --git a/docs/README.md b/docs/README.md
@@ -106,6 +106,9 @@ starter:
       - icon: /sdk/iOS.svg
         link: /document/ios/easecallkit.html
         text: iOS  
+      - icon: /sdk/web.svg
+        link: /document/web/easecallkit.html
+        text: Web  
 projects:
   - title: SDK/服务端功能
     features:
@@ -351,10 +354,10 @@ projects:
                 link: /document/ios/message_forward.html
               - icon: /sdk/web.svg
                 text: Web
-                link: /document/web/message_send_receive.html#发送合并消息
+                link: /document/web/message_send_receive.html#发送和接收合并消息
               - icon: /sdk/applet.svg
                 text: 小程序
-                link: /document/applet/message_send_receive.html#发送合并消息
+                link: /document/applet/message_send_receive.html#发送和接收合并消息
               - icon: /sdk/harmonyos.svg
                 text: HarmonyOS 
                 link: /document/harmonyos/message_forward.html