Merge pull request #169 from simple-robot/dev/main

Release: v4.0.0-beta6
simple-robot · Jul 14, 2024 · 43aff49 · 43aff49
2 parents 41df9db + 871c014
commit 43aff49
Show file tree

Hide file tree

Showing 115 changed files with 6,275 additions and 634 deletions.
diff --git a/.changelog/v4.0.0-beta6.md b/.changelog/v4.0.0-beta6.md
@@ -0,0 +1,12 @@
+> 对应核心版本: [**v4.1.0**](https://github.com/simple-robot/simpler-robot/releases/tag/v4.1.0)
+
+
+我们欢迎并期望着您的的[反馈](https://github.com/simple-robot/simbot-component-qq-guild/issues)或[协助](https://github.com/simple-robot/simbot-component-qq-guild/pulls)，
+感谢您的贡献与支持！
+
+也欢迎您为我们献上一颗 `star`，这是对我们最大的鼓励与认可！
+
+> [!warning]
+> 此版本增加、修改了不少东西，可能会产生不兼容或者任何未知问题，
+> 十分欢迎积极地[反馈](https://github.com/simple-robot/simbot-component-qq-guild/issues)或[协助](https://github.com/simple-robot/simbot-component-qq-guild/pulls)，
+> 非常感谢~
diff --git a/.changelog/v4.0.0-dev1.md b/.changelog/v4.0.0-dev1.md
diff --git a/.changelog/v4.0.0-dev2.md b/.changelog/v4.0.0-dev2.md
diff --git a/.changelog/v4.0.0-dev3.md b/.changelog/v4.0.0-dev3.md
diff --git a/.changelog/v4.0.0-dev4.md b/.changelog/v4.0.0-dev4.md
diff --git a/.changelog/v4.0.0-dev5.md b/.changelog/v4.0.0-dev5.md
diff --git a/.changelog/v4.0.0-dev6.md b/.changelog/v4.0.0-dev6.md
diff --git a/.changelog/v4.0.0-dev7.md b/.changelog/v4.0.0-dev7.md
diff --git a/.changelog/v4.0.0-dev8.md b/.changelog/v4.0.0-dev8.md
diff --git a/.github/workflows/deploy-v4-website.yml b/.github/workflows/deploy-v4-website.yml
@@ -26,7 +26,7 @@ env:
   # Replace HI with the ID of the instance in capital letters
   ARTIFACT: webHelpQG2-all.zip
   # Writerside docker image version
-  DOCKER_VERSION: 233.14389
+  DOCKER_VERSION: 241.16003
   # Add the variable below to upload Algolia indexes
   # Replace HI with the ID of the instance in capital letters
   ALGOLIA_ARTIFACT: algolia-indexes-QG.zip
@@ -127,7 +127,7 @@ jobs:
     needs: [build, test]
     runs-on: ubuntu-latest
     container:
-      image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-2
+      image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-3
 
     env:
 

diff --git a/README.md b/README.md
@@ -25,24 +25,21 @@
 
 </div>
 
-这是一个基于 [Kotlin coroutines](https://github.com/Kotlin/kotlinx.coroutines)
-对 [**QQ频道机器人**][qg bot doc] 进行实现的 API/SDK
-[Kotlin 多平台][KMP]库，异步高效、Java友好。
+这是一个 [Kotlin 多平台][KMP] 
+的 [**QQ机器人官方API**][qg bot doc]
+SDK 实现库，
+也是 [Simple Robot][simbot4 gh] 标准API下实现的组件库，
+异步高效、Java友好！
 
-它同样是一个 [Simple Robot v4][simbot4 gh] (下文简称 simbot)
-的组件库，是 simbot 的子项目之一。
-借助 simbot 核心库提供的能力，它可以支持更多高级功能和封装，比如组件协同、Spring支持等。
+借助 simbot 核心库提供的能力，它可以支持很多高级功能和封装，比如组件协同、Spring支持等，
+助你快速开发机器人应用！
 
-它可以作为一个低级别的 API/SDK 辅助依赖库，
-也可在 simbot 核心库的支持下用作为一个轻量级的快速开发框架！
-
-序列化和网络请求相关分别基于 [Kotlin serialization](https://github.com/Kotlin/kotlinx.serialization)
+> 序列化和网络请求相关分别基于 [Kotlin serialization](https://github.com/Kotlin/kotlinx.serialization)
 和 [Ktor](https://ktor.io/).
 
 ## 文档与引导
 
-- QQ频道组件手册: [应用手册](https://component-qqguild.simbot.forte.love/) (即当前仓库的 GitHub Pages)
-- 了解simbot: [Simple Robot 应用手册](https://simbot.forte.love)
+- 手册: [Simple Robot 应用手册](https://simbot.forte.love) 及其中 [**QQ机器人组件**](https://simbot.forte.love/component-qq-guild.html) 部分
 - [文档引导站&API文档](https://docs.simbot.forte.love)
 - [**社群**](https://simbot.forte.love/communities.html) 文档中也有提供社群信息喔
 - 前往 [组织首页](https://github.com/simple-robot/) 了解更多有关组件、文档、以及社群等相关信息！
@@ -76,10 +73,9 @@
 
 👉 [前往模块](simbot-component-qq-guild-stdlib) 了解更多。
 
-### 核心组件模块
+### 核心组件模块 ⭐
 
-基于 
-[标准库模块](simbot-component-qq-guild-stdlib) 
+基于 [标准库模块](simbot-component-qq-guild-stdlib) 
 对 [simbot4核心库](https://github.com/simple-robot/simpler-robot) 
 的组件实现，
 是一个相对高度封装的模块，并提供simbot4大部分能力，包括事件监听、多组件协同、Spring Boot Starter 等。

diff --git a/Writerside/qg.tree b/Writerside/qg.tree
@@ -37,7 +37,7 @@
             <toc-element topic="tips-send-image.md"/>
         </toc-element>
     </toc-element>
-    <toc-element toc-title="其他版本">
+    <toc-element topic="old-versions.md">
         <toc-element toc-title="3.2.0.0">
             <toc-element toc-title="快速开始">
                 <toc-element topic="old-api.md"/>

diff --git a/Writerside/topics/ApiPermission.md b/Writerside/topics/ApiPermission.md
@@ -2,6 +2,8 @@
 
 # API权限信息
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 ## ApiPermission
 
 在API模块中，有一个类型 `ApiPermission`，它代表了一个频道服务器中、

diff --git a/Writerside/topics/Home.md b/Writerside/topics/Home.md
@@ -1,5 +1,7 @@
 # 欢迎！
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 这里是
 [**Simple Robot v4**](https://github.com/simple-robot/simpler-robot/tree/v4-dev)
 的 

diff --git a/Writerside/topics/QGBot.md b/Writerside/topics/QGBot.md
@@ -3,8 +3,11 @@ switcher-label: Java API 风格
 ---
 <show-structure for="chapter,procedure" depth="3"/>
 
+
 # QGBot
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 作为一个QQ频道的 Bot 库，有一个用于描述机器人的 `Bot` 想必肯定是很正常的。
 
 

diff --git a/Writerside/topics/QGChannel.md b/Writerside/topics/QGChannel.md
@@ -6,6 +6,8 @@ switcher-label: Java API 风格
 
 # 子频道 QGChannel
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 子频道，即 `Channel`，存在于频道服务器(`Guild`)中，
 有多种类型，例如文字子频道、论坛子频道等。
 

diff --git a/Writerside/topics/QGGuild.md b/Writerside/topics/QGGuild.md
@@ -6,6 +6,8 @@ switcher-label: Java API 风格
 
 # 频道 QGGuild
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 ## API模块中的Guild {id='guild-in-api'}
 
 API模块中部分用于获取频道信息的API中会返回一些与 `Guild` 相关的数据类型。

diff --git a/Writerside/topics/QGMember.md b/Writerside/topics/QGMember.md
@@ -6,6 +6,8 @@ switcher-label: Java API 风格
 
 # 频道成员 QGMember
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 频道成员，即 `Member`，存在于频道服务器(`Guild`)中。
 
 

diff --git a/Writerside/topics/actors.md b/Writerside/topics/actors.md
@@ -1,5 +1,7 @@
 # 行为对象
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 QQ频道的**行为对象**(例如 `QGGuild`、`QGMember` 等)
 都是对 simbot 标准库中的行为对象进行的实现与延伸扩展。
 

diff --git a/Writerside/topics/api-list.md b/Writerside/topics/api-list.md
@@ -1,5 +1,7 @@
 # API定义列表
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 此处会列举 `API 模块` 中、`love.forte.simbot.qguild.api` 包下定义的所有 `QQGuildApi` 实现。
 
 > 对于一个具体的API的详细说明，我们建议你前往 [API 文档](https://docs.simbot.forte.love/) 或源码注释查阅，

diff --git a/Writerside/topics/api.md b/Writerside/topics/api.md
@@ -4,6 +4,8 @@ switcher-label: Java API 风格
 
 <var name="jr" value="Reactor"/>
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 # API
 
 ## API模块 {id='api-module'}

diff --git a/Writerside/topics/ark/api_ark.md b/Writerside/topics/ark/api_ark.md
@@ -1,5 +1,7 @@
 # Ark消息
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 QQ频道中有一些针对 `Ark消息` 的API。
 
 

diff --git a/Writerside/topics/bot-config.md b/Writerside/topics/bot-config.md
@@ -1,5 +1,7 @@
 # Bot配置文件
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 <tldr>
 <p>在使用 <b>Spring Boot</b> 时自动注册 bot 所需的配置文件。</p>
 </tldr>

diff --git a/Writerside/topics/embed/api_embed.md b/Writerside/topics/embed/api_embed.md
@@ -1,5 +1,7 @@
 # Embed消息
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 QQ频道中有一些针对 `Embed消息` 的API。
 
 

diff --git a/Writerside/topics/event.md b/Writerside/topics/event.md
@@ -1,5 +1,7 @@
 # 事件定义列表
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 QQ频道组件中的**事件类型**包含两个层面：
 
 1. **API 模块** 中，对 QQ频道 API 中官方定义的事件结构的基本封装与实现。

diff --git a/Writerside/topics/forum/api_forum.md b/Writerside/topics/forum/api_forum.md
@@ -4,6 +4,8 @@ switcher-label: Java API 风格
 
 # 论坛 QGForum
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 QQ频道中有一些针对 `论坛子频道` 的API。([参考文档](https://bot.q.qq.com/wiki/develop/api/openapi/forum/model.html#thread))
 
 

diff --git a/Writerside/topics/messages.md b/Writerside/topics/messages.md
@@ -5,6 +5,8 @@ switcher-label: Java API 风格
 
 # 消息
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 <tldr>
 
 - 对那些 **核心库** 中、实现了 simbot4 标准库的 `Message.Element` 消息元素类型的说明，

diff --git a/Writerside/topics/modules.md b/Writerside/topics/modules.md
@@ -1,5 +1,7 @@
 # 模块概述
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 本章节对整个 [Simple Robot QQ频道组件库](https://github.com/simple-robot/simbot-component-qq-guild)
 中出现的各模块进行一个简单的介绍。
 

diff --git a/Writerside/topics/old-versions.md b/Writerside/topics/old-versions.md
@@ -0,0 +1,3 @@
+# 历史版本
+
+一些已经成为历史的过去...
diff --git a/Writerside/topics/role/api_role.md b/Writerside/topics/role/api_role.md
@@ -6,6 +6,8 @@ switcher-label: Java API 风格
 
 # 角色 QGRole
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 QQ频道中有一些针对 `角色` 的API。
 
 ## API中的角色 {id="api-roles"}
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,8 +3,11 @@ switcher-label: Java API 风格 @@
     ---
     <show-structure for="chapter,procedure" depth="3"/>
     # QGBot
+    <include from="snippets.md" element-id="to-main-doc" />
     作为一个QQ频道的 Bot 库，有一个用于描述机器人的 `Bot` 想必肯定是很正常的。
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,6 +6,8 @@ switcher-label: Java API 风格

		# 频道成员 QGMember

		<include from="snippets.md" element-id="to-main-doc" />

		频道成员，即 `Member`，存在于频道服务器(`Guild`)中。


Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,6 +4,8 @@ switcher-label: Java API 风格

		# 论坛 QGForum

		<include from="snippets.md" element-id="to-main-doc" />

		QQ频道中有一些针对 `论坛子频道` 的API。([参考文档](https://bot.q.qq.com/wiki/develop/api/openapi/forum/model.html#thread))


Expand Down
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# 历史版本

		一些已经成为历史的过去...