站点迁移公告、README相关说明

simple-robot · Jul 13, 2024 · c902164 · c902164
1 parent f12ecdb
commit c902164
Show file tree

Hide file tree

Showing 16 changed files with 63 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -26,11 +26,11 @@
 </p>
 </div>
 
-Simple Robot OneBot 组件是一个将
+Simple Robot OneBot 组件是一个
 [OneBot11](https://github.com/botuniverse/onebot-11)
-协议在
-[Simple Robot](http://github.com/simple-robot/simpler-robot) 标准API下实现的组件库，
-并由此提供simbot中的各项能力。
+协议的客户端SDK，是基于
+[Simple Robot](http://github.com/simple-robot/simpler-robot) 标准API实现的组件库，
+提供simbot中的各项能力。
 
 它是一个 
 [Kotlin 多平台](https://kotlinlang.org/docs/multiplatform.html) 
@@ -44,11 +44,11 @@ Simple Robot OneBot 组件是一个将
 
 ## 文档与引导
 
-- OneBot组件手册: [OneBot组件手册](https://simple-robot.github.io/simbot-component-onebot/)
-- 了解simbot: [Simple Robot 应用手册](https://simbot.forte.love)
-- [文档引导站&API文档](https://docs.simbot.forte.love)
-- [**社群**](https://simbot.forte.love/communities.html) 文档中也有提供社群信息喔
-- 前往 [组织首页](https://github.com/simple-robot/) 了解更多有关组件、文档、以及社群等相关信息！
+- 手册：[Simple Robot 应用手册](https://simbot.forte.love) 
+  与手册内的 [OneBot组件](https://simbot.forte.love/component-onebot.html) 部分。
+- [文档引导站 & API文档](https://docs.simbot.forte.love)
+- [**社群**](https://simbot.forte.love/communities.html) (文档中也有提供社群信息喔~)
+- [组织库首页](https://github.com/simple-robot/): 了解更多有关组件、文档、以及社群等相关信息！
 
 ---
 
@@ -60,8 +60,8 @@ Simple Robot OneBot 组件是一个将
 
 ## 快速开始
 
-前往 [OneBot组件手册](https://simple-robot.github.io/simbot-component-onebot/)
-参考其中的[开始使用](https://simple-robot.github.io/simbot-component-onebot/onebot11-quick-start.html)。
+前往手册 [OneBot组件部分](https://simbot.forte.love/component-onebot.html) 了解更多、
+参考其中的[开始使用OneBot11](https://simbot.forte.love/component-onebot-v11-start-using.html)。
 
 
 ## 事件关系

diff --git a/Writerside/topics/Home.md b/Writerside/topics/Home.md
@@ -4,6 +4,8 @@
 <img alt="release" src="https://img.shields.io/github/v/release/simple-robot/simbot-component-onebot" />
 </a>
 
+<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/OneBot11.md b/Writerside/topics/OneBot11.md
@@ -1,5 +1,7 @@
 # OneBot11
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 OneBot组件是一个对
 [OneBot11协议](https://github.com/botuniverse/onebot-11)
 的**客户端**实现。

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" />
+
 ## 公共模块
 
 OneBot组件为所有协议实现的模块提供了一些共享内容的模块，

diff --git a/Writerside/topics/onebot11-OneBotBot.md b/Writerside/topics/onebot11-OneBotBot.md
@@ -6,6 +6,8 @@ switcher-label: JavaAPI风格
 
 # OneBotBot
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 表示一个 OneBot 的 bot 客户端实例，实现 `Bot`，由 `OneBotBotManager` 注册产生。
 
 ## Bot

diff --git a/Writerside/topics/onebot11-OneBotFriend.md b/Writerside/topics/onebot11-OneBotFriend.md
@@ -6,6 +6,8 @@ switcher-label: JavaAPI风格
 
 # 好友 OneBotFriend
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 `OneBotFriend` 实现 `Contact`, `OneBotStrangerAware` 
 和其他一些功能接口（后续 "更多能力" 中会介绍），
 用于表示一个 OneBot11 协议中的 **好友**。

diff --git a/Writerside/topics/onebot11-OneBotGroup.md b/Writerside/topics/onebot11-OneBotGroup.md
@@ -6,6 +6,8 @@ switcher-label: JavaAPI风格
 
 # 群 OneBotGroup
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 `OneBotGroup` 实现 `ChatGroup` 和 `DeleteSupport`，
 用于表示一个 OneBot11 协议中的 **群聊**。
 

diff --git a/Writerside/topics/onebot11-OneBotMember.md b/Writerside/topics/onebot11-OneBotMember.md
@@ -6,6 +6,8 @@ switcher-label: JavaAPI风格
 
 #  群成员 OneBotMember
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 `OneBotMember` 实现 `Member`, `OneBotStrangerAware`
 以及其他一些功能接口（后续 "更多能力" 中会介绍），
 用于表示一个 OneBot11 协议中的 **群成员**。

diff --git a/Writerside/topics/onebot11-actors.md b/Writerside/topics/onebot11-actors.md
@@ -1,5 +1,7 @@
 # 行为对象
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 行为对象，指的是实现了simbot标准API中 `Actor` 接口的类型，
 例如 `OneBotMember`、`OneBotGroup` 等，
 它们与 `OneBotBot` 存在某种关系、并具有很多行为性的API。

diff --git a/Writerside/topics/onebot11-bot-config.md b/Writerside/topics/onebot11-bot-config.md
@@ -1,5 +1,7 @@
 # Bot配置文件
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 Bot配置文件通常情况下是配合Spring Boot starter的时候用的。
 
 当使用Spring Boot starter时，

diff --git a/Writerside/topics/onebot11-event.md b/Writerside/topics/onebot11-event.md
@@ -1,5 +1,7 @@
 # 事件
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 ## 原始事件
 
 我们根据 OneBot11 协议中定义的所有事件结构，

diff --git a/Writerside/topics/onebot11-message.md b/Writerside/topics/onebot11-message.md
@@ -1,5 +1,7 @@
 # 消息
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 ## 标准消息元素
 
 作为一个simbot组件，OneBot组件理所当然的会支持部分simbot核心库所定义的标准消息元素。

diff --git a/Writerside/topics/onebot11-quick-start.md b/Writerside/topics/onebot11-quick-start.md
@@ -2,6 +2,8 @@
 
 开始使用OneBot11协议组件。
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 ## 前期准备
 
 ### OneBot11协议服务端

diff --git a/Writerside/topics/snippets.md b/Writerside/topics/snippets.md
@@ -295,3 +295,27 @@ implementation 'io.ktor:ktor-client-darwin:$ktor_version'
 
 
 </snippet>
+
+<procedure title="公告" id="to-main-doc">
+
+<h2>站点迁移啦~！</h2>
+
+<warning>
+
+OneBot组件的内容已经迁移合并到了[**核心库手册**](https://simbot.forte.love/component-onebot.html)中！
+本站点将不再更新，直接前往[**核心库手册**](https://simbot.forte.love/component-onebot.html)吧~！
+
+</warning>
+
+<procedure title="为什么迁移?" id="Why" collapsible="true">
+
+作为由我们官方维护的组件库，分散在各自的文档站点中的确有好处：它们可以各自维护自己所需的东西、互不干扰。
+
+但是缺点也很明显：**太过分散。**
+
+组件库与核心库之间的关系是比较**紧密**的，
+我们希望你能够在一个站点内就可以查阅或搜索到所有你想要得知的信息。
+
+</procedure>
+
+</procedure>
diff --git a/Writerside/topics/suspend-API-transform.md b/Writerside/topics/suspend-API-transform.md
@@ -1,5 +1,7 @@
 # 挂起API桥接
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 <tip>
 
 有关更多Java友好的内容，

diff --git a/Writerside/topics/use-onebot11.md b/Writerside/topics/use-onebot11.md
@@ -4,6 +4,8 @@ switcher-label: JavaAPI风格
 
 # 使用核心库或Spring
 
+<include from="snippets.md" element-id="to-main-doc" />
+
 ## 前期准备
 
 参考
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,8 @@ switcher-label: JavaAPI风格 @@
     # OneBotBot
+    <include from="snippets.md" element-id="to-main-doc" />
     表示一个 OneBot 的 bot 客户端实例，实现 `Bot`，由 `OneBotBotManager` 注册产生。
     ## Bot
@@ Expand Down @@