Merge pull request #650 from haoxiuwen/doc-v2

Modify Circle Docs
easemob · Feb 27, 2024 · 717c98e · 717c98e
2 parents 181461e + 580ad46
commit 717c98e
Show file tree

Hide file tree

Showing 19 changed files with 49 additions and 18 deletions.
diff --git a/docs/product/circle/api_reference_android.md b/docs/product/circle/api_reference_android.md
@@ -1,6 +1,7 @@
----
-{
-    pageUri: "https://www.easemob.com/apidoc/Android/hyphenate-api-doc/html/annotated.html",
-    title: "环信超级社区 Android SDK API 参考"
-}
----
+# 环信超级社区 Android SDK API 参考
+
+<Toc />
+
+若要访问环信超级社区 Android SDK API 参考，请点击[这里](https://www.easemob.com/apidoc/Android/hyphenate-api-doc/html/annotated.html)。
+
+
diff --git a/docs/product/circle/api_reference_ios.md b/docs/product/circle/api_reference_ios.md
@@ -1,6 +1,5 @@
----
-{
-    pageUri: "https://www.easemob.com/apidoc/iOS/html_ch/annotated.html",
-    title: "环信超级社区 iOS SDK API 参考"
-}
----
+# 环信超级社区 iOS SDK API 参考
+
+<Toc />
+
+若要访问环信超级社区 iOS SDK API 参考，请点击[这里](https://www.easemob.com/apidoc/iOS/html_ch/annotated.html)。
diff --git a/docs/product/circle/api_reference_web.md b/docs/product/circle/api_reference_web.md
@@ -1,6 +1,5 @@
----
-{
-    pageUri: "https://www.easemob.com/apidoc/Web/",
-    title: "环信超级社区 Web SDK API 参考"
-}
----
+# 环信超级社区 Web SDK API 参考
+
+<Toc />
+
+若要访问环信超级社区 Web SDK API 参考，请点击[这里](https://www.easemob.com/apidoc/Web/)。
diff --git a/docs/product/circle/category_mgmt_android.md b/docs/product/circle/category_mgmt_android.md
@@ -1,5 +1,7 @@
 # 管理频道分组
 
+<Toc />
+
 环信超级社区（Circle）支持将多个频道归入一个频道分组，方便频道管理。例如，可将歌剧频道、民歌频道和流行歌曲频道划分为声乐频道分组。
 
 社区创建时会创建默认的频道分组，包含默认频道。

diff --git a/docs/product/circle/category_mgmt_ios.md b/docs/product/circle/category_mgmt_ios.md
@@ -1,5 +1,7 @@
 # 管理频道分组
 
+<Toc />
+
 环信超级社区（Circle）支持将多个频道归入一个频道分组，方便频道管理。例如，可将歌剧频道、民歌频道和流行歌曲频道划分为声乐频道分组。
 
 社区创建时会创建默认的频道分组，包含默认频道。

diff --git a/docs/product/circle/category_mgmt_rest.md b/docs/product/circle/category_mgmt_rest.md
@@ -1,5 +1,7 @@
 # 管理社区频道分组
 
+<Toc />
+
 环信超级社区（Circle）支持频道分组方便频道管理。例如，可将歌剧频道、民歌频道和流行歌曲频道划分为声乐频道分组。
 
 社区创建时会创建默认的频道分组，包含默认频道。

diff --git a/docs/product/circle/category_mgmt_web.md b/docs/product/circle/category_mgmt_web.md
@@ -1,5 +1,7 @@
 # 管理频道分组
 
+<Toc />
+
 环信超级社区（Circle）支持将多个频道归入一个频道分组，方便频道管理。例如，可将歌剧频道、民歌频道和流行歌曲频道划分为声乐频道分组。
 
 社区创建时会创建默认的频道分组，包含默认频道。

diff --git a/docs/product/circle/channel_mgmt_android.md b/docs/product/circle/channel_mgmt_android.md
@@ -1,5 +1,7 @@
 # 管理频道
 
+<Toc />
+
 频道（Channel）是一个社区下不同子话题的讨论分区，因此一个社区下可以有多个频道。社区创建时会自动创建默认频道，该频道中添加了所有社区成员，用于承载各种系统通知。从可见性角度看，频道社区分为公开和私密频道；从功能角度看，频道分为文字频道和语聊频道。社区创建者可以根据自己需求创建频道。
 
 **超级社区中的频道基于即时通讯 IM 的群组或聊天室（频道 ID 为群组 ID 或聊天室 ID）创建，删除群组或聊天室时需注意以下几点：**

diff --git a/docs/product/circle/channel_mgmt_ios.md b/docs/product/circle/channel_mgmt_ios.md
@@ -1,5 +1,7 @@
 # 管理频道
 
+<Toc />
+
 频道（Channel）是一个社区下不同子话题的讨论分区，因此一个社区下可以有多个频道。社区创建时会自动创建默认频道，该频道中添加了所有社区成员，用于承载各种系统通知。从可见性角度看，频道社区分为公开和私密频道；从功能角度看，频道分为文字频道和语聊频道。社区创建者可以根据自己需求创建频道。
 
 **超级社区中的频道基于即时通讯 IM 的群组或聊天室（频道 ID 为群组 ID 或聊天室 ID）创建，删除群组或聊天室时需注意以下几点：**

diff --git a/docs/product/circle/channel_mgmt_rest.md b/docs/product/circle/channel_mgmt_rest.md
@@ -1,5 +1,7 @@
 # 管理频道以及频道成员
 
+<Toc />
+
 频道（Channel）是一个社区下不同子话题的讨论分区，因此一个社区下可以有多个频道。社区创建时会自动创建默认频道，该频道中添加了所有社区成员，用于承载各种系统通知。从可见性角度看，频道社区分为公开和私密频道；从功能角度看，频道分为文字频道和语聊频道。用户可以根据自己需求创建频道。
 
 **超级社区中的频道基于即时通讯 IM 的群组或聊天室（频道 ID 为群组 ID 或聊天室 ID）创建，删除群组或聊天室时需注意以下几点：**

diff --git a/docs/product/circle/channel_mgmt_web.md b/docs/product/circle/channel_mgmt_web.md
@@ -1,5 +1,7 @@
 # 管理频道
 
+<Toc />
+
 频道（Channel）是一个社区下不同子话题的讨论分区，因此一个社区下可以有多个频道。社区创建时会自动创建默认频道，该频道中添加了所有社区成员，用于承载各种系统通知。从可见性角度看，频道社区分为公开和私密频道；从功能角度看，频道分为文字频道和语聊频道。社区创建者可以根据自己需求创建频道。
 
 **超级社区中的频道基于即时通讯 IM 的群组或聊天室（频道 ID 为群组 ID 或聊天室 ID）创建，删除群组或聊天室时需注意以下几点：**

diff --git a/docs/product/circle/circle_overview.md b/docs/product/circle/circle_overview.md
@@ -1,5 +1,7 @@
 # 环信超级社区概述
 
+<Toc />
+
 环信超级社区（Circle）是一款基于环信 IM 打造的类 Discord 实时社区应用场景方案，支持社区（Server）、频道（Channel） 和子区（Thread） 三层结构。一个 App 下可以有多个社区，同时支持陌生人/好友单聊。用户可创建和管理自己的社区，在社区中设置和管理频道将一个话题下的子话题进行分区，在频道中根据感兴趣的某条消息发起子区讨论，实现万人实时群聊，满足超大规模用户的顺畅沟通需求。
 
 ## 社区、频道和子区介绍

diff --git a/docs/product/circle/circle_quickstart_android.md b/docs/product/circle/circle_quickstart_android.md
@@ -1,5 +1,7 @@
 # 环信超级社区（Circle）快速开始
 
+<Toc />
+
 ## 集成准备
 
 使用 Circle 之前，确保你已经集成环信即时通讯 IM Android SDK 3.9.9.2，详见 [环信即时通讯 IM Android 快速开始](/document/android/quickstart.html)。

diff --git a/docs/product/circle/circle_quickstart_ios.md b/docs/product/circle/circle_quickstart_ios.md
@@ -1,5 +1,7 @@
 # 环信超级社区（Circle）快速开始
 
+<Toc />
+
 ## 集成准备
 
 使用 Circle 之前，确保你已经集成环信即时通讯 IM iOS SDK 3.9.9.1，详见 [环信即时通讯 IM iOS 快速开始](/document/ios/quickstart.html)。

diff --git a/docs/product/circle/circle_quickstart_web.md b/docs/product/circle/circle_quickstart_web.md
@@ -1,5 +1,7 @@
 # 环信超级社区 （Circle） 快速开始
 
+<Toc />
+
 ## 集成准备
 
 使用 Circle 前，确保你已经集成环信即时通讯 IM Web SDK 4.1.4-beta，详见 [环信即时通讯 IM Web 快速开始](/document/web/quickstart.html)。

diff --git a/docs/product/circle/server_mgmt_android.md b/docs/product/circle/server_mgmt_android.md
@@ -1,5 +1,7 @@
 # 管理社区
 
+<Toc />
+
 社区（Server）是一群有着共同兴趣爱好的人的专属天地，也可以是同学朋友的社交圈子。社区是环信圈子三层基础架构的最上层，各种消息事件均发生在社区内。社区分为公开社区和私密社区。对于公开社区，任何用户均可查询社区列表，可自由加入或退出社区，无需审批；对于私密社区，用户无法查询社区列表，只能通过社区成员邀请加入社区，无法申请加入社区。
 
 **超级社区中的频道基于即时通讯 IM 的群组或聊天室（频道 ID 为群组 ID 或聊天室 ID）创建，删除群组或聊天室时需注意以下几点：**

diff --git a/docs/product/circle/server_mgmt_ios.md b/docs/product/circle/server_mgmt_ios.md
@@ -1,5 +1,7 @@
 # 管理社区
 
+<Toc />
+
 社区（Server）是一群有着共同兴趣爱好的人的专属天地，也可以是同学朋友的社交圈子。社区是环信圈子三层基础架构的最上层，各种消息事件均发生在社区内。社区分为公开社区和私密社区。对于公开社区，任何用户均可查询社区列表，可自由加入或退出社区，无需审批；对于私密社区，用户无法查询社区列表，只能通过社区成员邀请加入社区，无法申请加入社区。
 
 **超级社区中的频道基于即时通讯 IM 的群组或聊天室（频道 ID 为群组 ID 或聊天室 ID）创建，删除群组或聊天室时需注意以下几点：**

diff --git a/docs/product/circle/server_mgmt_rest.md b/docs/product/circle/server_mgmt_rest.md
@@ -1,5 +1,7 @@
 # 管理社区及其成员
 
+<Toc />
+
 社区（Server）是一群有着共同兴趣爱好的人的专属天地，也可以是同学朋友的社交圈子。社区是环信圈子三层基础架构的最上层，各种消息事件均发生在社区内。社区分为公开社区和私密社区。用户可查询公开社区列表，但无法查询私密社区列表。
 
 **超级社区中的频道基于即时通讯 IM 的群组或聊天室（频道 ID 为群组 ID 或聊天室 ID）创建，删除群组或聊天室时需注意以下几点：**

diff --git a/docs/product/circle/server_mgmt_web.md b/docs/product/circle/server_mgmt_web.md
@@ -1,5 +1,7 @@
 # 管理社区
 
+<Toc />
+
 社区（Server）是一群有着共同兴趣爱好的人的专属天地，也可以是同学朋友的社交圈子。社区是环信圈子三层基础架构的最上层，各种消息事件均发生在社区内。社区分为公开社区和私密社区。对于公开社区，任何用户均可查询社区列表，可自由加入或退出社区，无需审批；对于私密社区，用户无法查询社区列表，只能通过社区成员邀请加入社区，无法申请加入社区。
 
 **超级社区中的频道基于即时通讯 IM 的群组或聊天室（频道 ID 为群组 ID 或聊天室 ID）创建，删除群组或聊天室时需注意以下几点：**