Merge pull request #16 from haoxiuwen/doc-shengwang

Add Applet Client and Modify Message/Group/Chat Room Overview Link for Each Platform/Framework
easemob · Jan 1, 2025 · 32b39f5 · 32b39f5
2 parents c1203cd + f715080
commit 32b39f5
Show file tree

Hide file tree

Showing 116 changed files with 3,326 additions and 177 deletions.
diff --git a/docs/.vuepress/components/PlatformSwitch.vue b/docs/.vuepress/components/PlatformSwitch.vue
@@ -120,6 +120,10 @@ const options = [
       {
         value: 'unity',
         label: 'Unity',
+      },
+      {
+        value: 'applet',
+        label: '小程序',
       }
     ],
   },

diff --git a/docs/.vuepress/navbar/index.ts b/docs/.vuepress/navbar/index.ts
@@ -73,7 +73,7 @@ export const zhNavbar = navbar([
     ]
   },
   {
-    text: 'SDK/REST 集成',
+    text: 'SDK/服务端集成',
     children: [
       {
         text: '平台',
@@ -123,16 +123,16 @@ export const zhNavbar = navbar([
             icon: '/icon-unity.svg',
             link: '/document/unity/quickstart.html'
           },
-          // {
-          //   text: '小程序',
-          //  icon: '/icon-mini-program.svg',
-          //  link: '/document/applet/overview.html'
-          // },
-          // {
-          //  text: 'uni-app',
-          //  icon: '/icon-uni-app.svg',
-          //  link: '/document/applet/uniapp.html'
-          // },
+          {
+            text: '小程序',
+            icon: '/icon-mini-program.svg',
+            link: '/document/applet/overview.html'
+          },
+          {
+            text: 'uni-app',
+            icon: '/icon-uni-app.svg',
+           link: '/document/applet/uniapp.html'
+          }
         ]
       },
       {

diff --git a/docs/.vuepress/sidebar/document.ts b/docs/.vuepress/sidebar/document.ts
@@ -11,6 +11,7 @@ const documentSidebar = [
     text: "产品介绍",
     collapsible: true,
     children: [
+      { text: '小程序全平台解决方案', link: 'overview.html', only: ['applet']},
       { text: '发版说明', link: 'releasenote.html'},
       { text: "特性介绍",
         collapsible: true,
@@ -203,7 +204,7 @@ const documentSidebar = [
     ],
     except: ['applet','server-side','electron','linux']
   },
-  { text: 'API 参考', link: 'api_reference_overview.html' },
+  { text: 'API 参考', link: 'api_reference_overview.html', except: ['applet', 'server-side', 'electron', 'linux'] },
   {
     text: '错误排查',
     collapsible: true,
@@ -237,142 +238,143 @@ const documentSidebar = [
   //  ],
   //  only: ['android', 'ios']
   //},
-  // {
-  // text: '产品介绍',
-  //  children: [
-  //    { text: '环信小程序全平台解决方案', link: 'overview.html' },
-  //    { text: '小程序 SDK 更新日志', link: 'releasenote.html' },
-  //  ],
-  //  only: ['applet']
-  //},
-  //{
-  //  text: '用户指南',
-  // children: [
-  //    {
-  //      text: '集成介绍',
-  //      collapsible: true,
-  //      children: [
-  //        { text: '微信小程序', link: 'wechat.html' },
-  //        { text: 'QQ 小程序', link: 'qq.html' },
-  //        { text: '百度小程序', link: 'baidu.html' },
-  //        { text: '抖音小程序', link: 'bytedance.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,
-  //      children: [
-  //        { text: '消息概述', link: 'message_overview.html' },
-  //        { text: '发送和接收消息', link: 'message_send_receive.html' },
-  //        { 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: 'moderation.html'},      
-  //      ]
-  //    },
-  //    {
-  //      text: '会话管理',
-  //      collapsible: true,
-  //      children: [
-  //        { text: '会话介绍', link: 'conversation_overview.html' },
-  //        { text: '会话列表', link: 'conversation_list.html' },
-  //        { text: '会话未读数', link: 'conversation_unread.html' },
-  //        { text: '置顶会话', link: 'conversation_pin.html' },
-  //        { text: '会话标记', link: 'conversation_mark.html'},
-  //        { text: '删除会话', link: 'conversation_delete.html'},
-  //      ]
-  //    },
-  //    {
-  //      text: '群组管理',
-  //      collapsible: true,
-  //      children: [
-  //        { text: '群组概述', link: 'group_overview.html' },
-  //        { 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' }
-  //          ]
-  //        },
-  //      ]
-  //    },
-  //    {
-  //      text: '聊天室管理',
-  //      collapsible: true,
-  //      children: [
-  //        { text: '聊天室概述', link: 'room_overview.html' },
-  //        { text: '创建和管理聊天室', link: 'room_manage.html' },
-  //        { text: '管理聊天室成员', link: 'room_members.html' },
-  //        { text: '管理聊天室属性', link: 'room_attributes.html' },
-  //      ]
-  //    },
-  //    {
-  //      text: '用户相关',
-  //      collapsible: true,
-  //      children: [
-  //        { text: '用户关系', link: 'user_relationship.html' },
-  //        { text: '用户属性', link: 'userprofile.html' },
-  //        { text: '在线状态订阅', link: 'presence.html' },
-  //      ]
-  //    },    
-  //    { text: '离线推送', 
-  //      collapsible: true,
-  //      children: [
-  //      { text: '离线推送概述', link: 'push/push_overview.html' }, 
-  //      { text: '设置通知方式和免打扰', link: 'push/push_notification_mode_dnd.html' },
-  //      { text: '设置推送模板', link: 'push/push_template.html' },
-  //      { text: '设置推送翻译', link: 'push/push_translation.html' },
-  //      { text: '设置推送扩展功能', link: 'push/push_extension.html' },
-  //      { text: 'uni-app 离线推送', link: 'push/uniapp_push.html' }
-  //      ]
-  //    }, 
-  //  ],
-  //  only: ['applet']
-  //},
-  //{
-  //  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' },
-  //  ],
-  //  only: ['applet']
-  //},
+  {
+   text: '用户指南',
+   collapsible: true,
+  children: [
+     {
+       text: '集成介绍',
+       collapsible: true,
+       children: [
+         { text: '微信小程序', link: 'wechat.html' },
+         { text: 'QQ 小程序', link: 'qq.html' },
+         { text: '百度小程序', link: 'baidu.html' },
+         { text: '抖音小程序', link: 'bytedance.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,
+       children: [
+         { text: '消息概述', link: 'message_overview.html' },
+         { text: '发送和接收消息', link: 'message_send_receive.html' },
+         { 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: 'moderation.html'},      
+       ]
+     },
+     {
+       text: '会话管理',
+       collapsible: true,
+       children: [
+         { text: '会话介绍', link: 'conversation_overview.html' },
+         { text: '会话列表', link: 'conversation_list.html' },
+         { text: '会话未读数', link: 'conversation_unread.html' },
+         { text: '置顶会话', link: 'conversation_pin.html' },
+         { text: '会话标记', link: 'conversation_mark.html'},
+         { text: '删除会话', link: 'conversation_delete.html'},
+       ]
+     },
+     {
+       text: '群组管理',
+       collapsible: true,
+       children: [
+         { text: '群组概述', link: 'group_overview.html' },
+         { 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' }
+           ]
+         },
+       ]
+     },
+     {
+       text: '聊天室管理',
+       collapsible: true,
+       children: [
+         { text: '聊天室概述', link: 'room_overview.html' },
+         { text: '创建和管理聊天室', link: 'room_manage.html' },
+         { text: '管理聊天室成员', link: 'room_members.html' },
+         { text: '管理聊天室属性', link: 'room_attributes.html' },
+       ]
+     },
+     {
+       text: '用户相关',
+       collapsible: true,
+       children: [
+         { text: '用户关系', link: 'user_relationship.html' },
+         { text: '用户属性', link: 'userprofile.html' },
+         { text: '在线状态订阅', link: 'presence.html' },
+       ]
+     },    
+     { text: '离线推送', 
+       collapsible: true,
+       children: [
+       { text: '离线推送概述', link: 'push/push_overview.html' }, 
+       { text: '设置通知方式和免打扰', link: 'push/push_notification_mode_dnd.html' },
+       { text: '设置推送模板', link: 'push/push_template.html' },
+       { text: '设置推送翻译', link: 'push/push_translation.html' },
+       { text: '设置推送扩展功能', link: 'push/push_extension.html' },
+       { text: 'uni-app 离线推送', link: 'push/uniapp_push.html' }
+       ]
+     }, 
+   ],
+   only: ['applet']
+  },
+  { text: 'API 参考', link: 'api_reference_overview.html', only: ['applet'] },
+  {
+   text: '错误排查',
+   collapsible: true,
+   children: [
+     { text: '错误码', link: 'error.html' },
+     { text: '日志', link: 'log.html' },
+   ],
+   only: ['applet']
+  },
+  {
+   text: '常见问题',
+   children: [
+     { text: 'Uniapp 生成原生 Android、iOS 应用', link: 'uniappnativeapp.html' },
+     { text: '小程序模板使用指南', link: 'uniappuikit.html' },
+     { text: '如何配置服务器域名', link: 'serverconfig.html' },
+   ],
+   only: ['applet']
+  },
+  { text: '合规指南', 
+    collapsible: true,
+    children: [
+      { text: '合规使用说明', link: 'security.html' },
+    ],
+    only: ['applet']
+  }, 
     {
-    text: 'REST API',
+    text: 'RESTful API',
     collapsible: true,
     children: [
-      { text: 'REST API 概览', link: 'overview.html' },
+      { text: 'RESTful API 概览', link: 'overview.html' },
       { 
         text: '消息', 
         children: [

diff --git a/docs/document/README.md b/docs/document/README.md
@@ -1,3 +1,3 @@
 ---
-title: SDK/REST 集成
+title: SDK/服务端集成
 ---
diff --git a/docs/document/android/data_center.md b/docs/document/android/data_center.md
diff --git a/docs/document/android/group_overview.md b/docs/document/android/group_overview.md
@@ -1,6 +1,6 @@
 ---
 {
-    pageUri: "/product/product_group_overview.html",
+    pageUri: "/document/android/product_group_overview.html",
     title: "群组概述"
 }
 ---
diff --git a/docs/document/android/message_overview.md b/docs/document/android/message_overview.md
@@ -1,6 +1,6 @@
 ---
 {
-    pageUri: "/product/product_message_overview.html",
+    pageUri: "/document/android/product_message_overview.html",
     title: "消息概述"
 }
 ---
diff --git a/docs/document/android/message_send_receive.md b/docs/document/android/message_send_receive.md
@@ -6,7 +6,7 @@
 
 - 对于群组和聊天室，用户每次只能向所属的单个群组和聊天室发送消息。
 
-单聊、群组聊天和聊天室的消息发送控制，详见[消息发送控制](/product/product_message_overview.html#消息发送控制)文档。
+单聊、群组聊天和聊天室的消息发送控制，详见[消息发送控制](/document/android/product_message_overview.html#消息发送控制)文档。
 
 ## 前提条件
 

diff --git a/docs/document/android/room_overview.md b/docs/document/android/room_overview.md
@@ -1,6 +1,6 @@
 ---
 {
-    pageUri: "/product/product_chatroom_overview.html",
+    pageUri: "/document/android/product_chatroom_overview.html",
     title: "聊天室概述"
 }
 ---