📝 update doc

archive/2.0.0a8/guide/cqhttp-guide.md

@@ -76,3 +76,26 @@ QQ 协议端举例:
 其中 `ws://127.0.0.1:8080/cqhttp/ws` 中的 `127.0.0.1` 和 `8080` 应分别对应 nonebot 配置的 HOST 和 PORT。
 
 `cqhttp` 是前述 `register_adapter` 时传入的第一个参数，代表设置的 `CQHTTPBot` 适配器的路径，你可以对不同的适配器设置不同路径以作区别。
+
+## 历史性的第一次对话
+
+一旦新的配置文件正确生效之后，NoneBot 所在的控制台（如果正在运行的话）应该会输出类似下面的内容（两条访问日志）：
+
+```default
+09-14 21:31:16 [INFO] uvicorn | ('127.0.0.1', 12345) - "WebSocket /cqhttp/ws" [accepted]
+09-14 21:31:16 [INFO] nonebot | WebSocket Connection from CQHTTP Bot 你的QQ号 Accepted!
+```
+
+这表示 CQHTTP 协议端已经成功地使用 CQHTTP 协议连接上了 NoneBot。
+
+现在，尝试向你的机器人账号发送如下内容：
+
+```default
+/echo 你好，世界
+```
+
+到这里如果一切 OK，你应该会收到机器人给你回复了 `你好，世界`。这一历史性的对话标志着你已经成功地运行了一个 NoneBot 的最小实例，开始了编写更强大的 QQ 机器人的创意之旅！
+
+<ClientOnly>
+  <Messenger :messages="[{ position: 'right', msg: '/echo 你好，世界' }, { position: 'left', msg: '你好，世界' }]"/>
+</ClientOnly>

archive/2.0.0a8/guide/getting-started.md

@@ -57,7 +57,7 @@ python bot.py
 09-14 21:02:00 [INFO] uvicorn | Uvicorn running on http://127.0.0.1:8080 (Press CTRL+C to quit)
 ```
 
-## 配置协议端
+## 配置协议端上报
 
 在 `bot.py` 文件中使用 `register_adapter` 注册协议适配之后即可配置协议端来完成与 NoneBot 的通信，详细配置方法参考：
 
@@ -71,40 +71,16 @@ NoneBot 接受的上报地址与 `Driver` 有关，默认使用的 `FastAPI Driv
 - `/{adapter name}/ws`: WebSocket 上报
 - `/{adapter name}/ws/`: WebSocket 上报
 
-## 历史性的第一次对话
-
-一旦新的配置文件正确生效之后，NoneBot 所在的控制台（如果正在运行的话）应该会输出类似下面的内容（两条访问日志）：
-
-```default
-09-14 21:31:16 [INFO] uvicorn | ('127.0.0.1', 12345) - "WebSocket /cqhttp/ws" [accepted]
-09-14 21:31:16 [INFO] nonebot | WebSocket Connection from CQHTTP Bot 你的QQ号 Accepted!
-```
-
-这表示 CQHTTP 协议端已经成功地使用 CQHTTP 协议连接上了 NoneBot。
-
 :::warning 注意
-如果到这一步你没有看到上面这样的成功日志，CQHTTP 的日志中在不断地重连或无反应，请注意检查配置中的 IP 和端口是否确实可以访问。比较常见的出错点包括：
+如果到这一步你没有在 NoneBot 看到连接成功日志，比较常见的出错点包括：
 
-- NoneBot 监听 `0.0.0.0`，然后在 CQHTTP 配置中填了 `ws://0.0.0.0:8080/cqhttp/ws`
+- NoneBot 监听 `0.0.0.0`，然后在协议端上报配置中填了 `ws://0.0.0.0:8080/***/ws`
-- 在 Docker 容器内运行 CQHTTP，并通过 `127.0.0.1` 访问宿主机上的 NoneBot
+- 在 Docker 容器内运行协议端，并通过 `127.0.0.1` 访问宿主机上的 NoneBot
 - 想从公网访问，但没有修改云服务商的安全组策略或系统防火墙
 - NoneBot 所监听的端口存在冲突，已被其它程序占用
-- 弄混了 NoneBot 的 `host`、`port` 参数与 CQHTTP 配置中的 `host`、`port` 参数
+- 弄混了 NoneBot 的 `host`、`port` 参数与协议端上报配置中的 `host`、`port` 参数
-- 使用了 `ws_reverse_api_url` 和 `ws_reverse_event_url` 而非 universal client
 - `ws://` 错填为 `http://`
-- CQHTTP 或 NoneBot 启动时遭到外星武器干扰
+- 协议端或 NoneBot 启动时遭到外星武器干扰
 
-请尝试重启 CQHTTP、重启 NoneBot、更换端口、修改防火墙、重启系统、仔细阅读前面的文档及提示、更新 CQHTTP 和 NoneBot 到最新版本等方式来解决。
+请尝试重启协议端 NoneBot、更换端口、修改防火墙、重启系统、仔细阅读前面的文档及提示、更新协议端 和 NoneBot 到最新版本等方式来解决。
 :::
-
-现在，尝试向你的机器人账号发送如下内容：
-
-```default
-/echo 你好，世界
-```
-
-到这里如果一切 OK，你应该会收到机器人给你回复了 `你好，世界`。这一历史性的对话标志着你已经成功地运行了一个 NoneBot 的最小实例，开始了编写更强大的 QQ 机器人的创意之旅！
-
-<ClientOnly>
-  <Messenger :messages="[{ position: 'right', msg: '/echo 你好，世界' }, { position: 'left', msg: '你好，世界' }]"/>
-</ClientOnly>

docs/guide/cqhttp-guide.md

@@ -76,3 +76,26 @@ QQ 协议端举例:
 其中 `ws://127.0.0.1:8080/cqhttp/ws` 中的 `127.0.0.1` 和 `8080` 应分别对应 nonebot 配置的 HOST 和 PORT。
 
 `cqhttp` 是前述 `register_adapter` 时传入的第一个参数，代表设置的 `CQHTTPBot` 适配器的路径，你可以对不同的适配器设置不同路径以作区别。
+
+## 历史性的第一次对话
+
+一旦新的配置文件正确生效之后，NoneBot 所在的控制台（如果正在运行的话）应该会输出类似下面的内容（两条访问日志）：
+
+```default
+09-14 21:31:16 [INFO] uvicorn | ('127.0.0.1', 12345) - "WebSocket /cqhttp/ws" [accepted]
+09-14 21:31:16 [INFO] nonebot | WebSocket Connection from CQHTTP Bot 你的QQ号 Accepted!
+```
+
+这表示 CQHTTP 协议端已经成功地使用 CQHTTP 协议连接上了 NoneBot。
+
+现在，尝试向你的机器人账号发送如下内容：
+
+```default
+/echo 你好，世界
+```
+
+到这里如果一切 OK，你应该会收到机器人给你回复了 `你好，世界`。这一历史性的对话标志着你已经成功地运行了一个 NoneBot 的最小实例，开始了编写更强大的 QQ 机器人的创意之旅！
+
+<ClientOnly>
+  <Messenger :messages="[{ position: 'right', msg: '/echo 你好，世界' }, { position: 'left', msg: '你好，世界' }]"/>
+</ClientOnly>

docs/guide/getting-started.md

@@ -57,7 +57,7 @@ python bot.py
 09-14 21:02:00 [INFO] uvicorn | Uvicorn running on http://127.0.0.1:8080 (Press CTRL+C to quit)
 ```
 
-## 配置协议端
+## 配置协议端上报
 
 在 `bot.py` 文件中使用 `register_adapter` 注册协议适配之后即可配置协议端来完成与 NoneBot 的通信，详细配置方法参考：
 
@@ -71,40 +71,16 @@ NoneBot 接受的上报地址与 `Driver` 有关，默认使用的 `FastAPI Driv
 - `/{adapter name}/ws`: WebSocket 上报
 - `/{adapter name}/ws/`: WebSocket 上报
 
-## 历史性的第一次对话
-
-一旦新的配置文件正确生效之后，NoneBot 所在的控制台（如果正在运行的话）应该会输出类似下面的内容（两条访问日志）：
-
-```default
-09-14 21:31:16 [INFO] uvicorn | ('127.0.0.1', 12345) - "WebSocket /cqhttp/ws" [accepted]
-09-14 21:31:16 [INFO] nonebot | WebSocket Connection from CQHTTP Bot 你的QQ号 Accepted!
-```
-
-这表示 CQHTTP 协议端已经成功地使用 CQHTTP 协议连接上了 NoneBot。
-
 :::warning 注意
-如果到这一步你没有看到上面这样的成功日志，CQHTTP 的日志中在不断地重连或无反应，请注意检查配置中的 IP 和端口是否确实可以访问。比较常见的出错点包括：
+如果到这一步你没有在 NoneBot 看到连接成功日志，比较常见的出错点包括：
 
-- NoneBot 监听 `0.0.0.0`，然后在 CQHTTP 配置中填了 `ws://0.0.0.0:8080/cqhttp/ws`
+- NoneBot 监听 `0.0.0.0`，然后在协议端上报配置中填了 `ws://0.0.0.0:8080/***/ws`
-- 在 Docker 容器内运行 CQHTTP，并通过 `127.0.0.1` 访问宿主机上的 NoneBot
+- 在 Docker 容器内运行协议端，并通过 `127.0.0.1` 访问宿主机上的 NoneBot
 - 想从公网访问，但没有修改云服务商的安全组策略或系统防火墙
 - NoneBot 所监听的端口存在冲突，已被其它程序占用
-- 弄混了 NoneBot 的 `host`、`port` 参数与 CQHTTP 配置中的 `host`、`port` 参数
+- 弄混了 NoneBot 的 `host`、`port` 参数与协议端上报配置中的 `host`、`port` 参数
-- 使用了 `ws_reverse_api_url` 和 `ws_reverse_event_url` 而非 universal client
 - `ws://` 错填为 `http://`
-- CQHTTP 或 NoneBot 启动时遭到外星武器干扰
+- 协议端或 NoneBot 启动时遭到外星武器干扰
 
-请尝试重启 CQHTTP、重启 NoneBot、更换端口、修改防火墙、重启系统、仔细阅读前面的文档及提示、更新 CQHTTP 和 NoneBot 到最新版本等方式来解决。
+请尝试重启协议端 NoneBot、更换端口、修改防火墙、重启系统、仔细阅读前面的文档及提示、更新协议端 和 NoneBot 到最新版本等方式来解决。
 :::
-
-现在，尝试向你的机器人账号发送如下内容：
-
-```default
-/echo 你好，世界
-```
-
-到这里如果一切 OK，你应该会收到机器人给你回复了 `你好，世界`。这一历史性的对话标志着你已经成功地运行了一个 NoneBot 的最小实例，开始了编写更强大的 QQ 机器人的创意之旅！
-
-<ClientOnly>
-  <Messenger :messages="[{ position: 'right', msg: '/echo 你好，世界' }, { position: 'left', msg: '你好，世界' }]"/>
-</ClientOnly>