Skip to content

Commit fd3e06d

Browse files
committed
docs: refine documentation, correct refs
1 parent e108f19 commit fd3e06d

File tree

3 files changed

+23
-20
lines changed

3 files changed

+23
-20
lines changed

saltify-docs/.vitepress/config.mts

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,11 @@ export default defineConfig({
1212
],
1313

1414
sidebar: [
15-
{
16-
text: '快速上手',
17-
items: [ { text: 'API 概览', link: '/quick-tour' } ]
18-
},
15+
{ text: '快速上手', link: '/quick-tour' },
1916
{
2017
text: '开发指南',
2118
items: [
22-
{ text: '核心配置与异常处理', link: '/guide/application' },
19+
{ text: '核心配置', link: '/guide/application' },
2320
{ text: '插件开发', link: '/guide/plugin' },
2421
{ text: '指令系统', link: '/guide/command' }
2522
]

saltify-docs/content/guide/application.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# 核心配置与异常处理
1+
# 核心配置
22

3-
## 应用实例化与基础配置
3+
## 初始化 `SaltifyApplication`
44

55
可以通过以下方式快速配置一个 Saltify 实例。这里仅展示了核心配置。
66

@@ -36,17 +36,11 @@ suspend fun main() {
3636

3737
另外,应用和插件都有生命周期管理。在程序退出时,务必调用 `close()` 方法释放资源,这会触发所有已加载插件的 `onStop` 钩子并关闭 HTTP 客户端。
3838

39-
## 全局异常处理与事件服务状态
39+
## 全局异常处理
4040

41-
Saltify 提供了用于监控连接状态和异常的 Flow,一般必须收集以实现自定义逻辑,否则**全部异常都会被无视**
41+
Saltify 提供了用于监控未显式捕获的异常的 Flow,一般必须收集以实现自定义逻辑,否则**全部异常都会被无视**
4242

4343
```kotlin
44-
launch {
45-
client.eventConnectionStateFlow.collect { state ->
46-
println("连接状态变更: $state")
47-
}
48-
}
49-
5044
launch {
5145
client.exceptionFlow.collect { (context, exception) ->
5246
val component = context.saltifyComponent!!
@@ -61,3 +55,15 @@ launch {
6155
}
6256
}
6357
```
58+
59+
## 事件服务状态监听
60+
61+
Saltify 还提供了一个 Flow 用于监控事件服务连接状态的变更:
62+
63+
```kotlin
64+
launch {
65+
client.eventConnectionStateFlow.collect { state ->
66+
println("连接状态变更: $state")
67+
}
68+
}
69+
```

saltify-docs/content/quick-tour.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ dependencies {
2222
> [!warning]
2323
> 本项目仍处于开发阶段,**强烈建议自行构建项目并依赖你的本地构建**,目前本文档将基于最新提交而不是最新发行版。待项目稳定会区分稳定文档与开发文档。
2424
25-
## 配置应用
25+
## 初始化 `SaltifyApplication`
2626

2727
```kotlin
2828
val client = SaltifyApplication {
@@ -39,7 +39,7 @@ val client = SaltifyApplication {
3939
}
4040
```
4141

42-
更多内容请参见 [应用配置](guide/application.md)。请在浏览完本页后**一定仔细阅读**这一页。
42+
更多内容请参见[核心配置](guide/application.md)。请在浏览完本页后**一定仔细阅读**这一页。
4343

4444
## 调用 API
4545

@@ -54,7 +54,7 @@ client.sendGroupMessage(123456789L) {
5454
}
5555
```
5656

57-
更多 API 请参见项目源码与 IDE 补全
57+
更多 API 请参见项目源码与 [Milky 文档](https://milky.ntqqrev.org/)
5858

5959
## 定义插件
6060

@@ -84,7 +84,7 @@ val client = SaltifyApplication {
8484
}
8585
```
8686

87-
更多内容请参见 [插件开发](guide/plugin.md)
87+
更多内容请参见[插件开发](guide/plugin.md)
8888

8989
## 定义指令
9090

@@ -100,4 +100,4 @@ client.command("say") {
100100
}
101101
```
102102

103-
更多内容请参见 [指令开发](guide/command.md)
103+
更多内容请参见[指令系统](guide/command.md)

0 commit comments

Comments
 (0)