Skip to content

Commit ca1a6c8

Browse files
fix(docs): Fix multiple errors in the document, including broken links, spelling errors, and step numbering. (AstrBotDevs#7979)
* fix: remove trailing comma in JSON example in plugin-config doc * fix: remove trailing comma in JSON example in plugin-config doc * Update knowledge-base.md * Update knowledge-base.md * Update websearch.md * Update websearch.md * Update websearch.md * Update plugin-publish.md * Update lark.md * Update unified-webhook.md * Update discord.md * Update wecom.md * html * html * Update websearch.md * html * Update start.md * Update start.md * Apply suggestions from code review Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent 39386ee commit ca1a6c8

12 files changed

Lines changed: 16 additions & 16 deletions

File tree

docs/en/dev/star/guides/plugin-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The file content is a `Schema` that represents the configuration. The Schema is
1515
{
1616
"token": {
1717
"description": "Bot Token",
18-
"type": "string",
18+
"type": "string"
1919
},
2020
"sub_config": {
2121
"description": "Test nested configuration",

docs/en/providers/start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ Using DeepSeek as an example, assuming you have registered and logged in to a De
3838

3939
> Introduced in v4.13.0.
4040
41-
You can use environment variables to load provider API keys. In the provider configuration page, set the API Key field to `$ENV_VARIABLE_NAME`, for example: `$DEESEEK_API_KEY`.
41+
You can use environment variables to load provider API keys. In the provider configuration page, set the API Key field to `$ENV_VARIABLE_NAME`, for example: `$DEEPSEEK_API_KEY`.

docs/en/use/websearch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
The web search feature gives large language models internet retrieval capability for recent information, which can improve response accuracy and reduce hallucinations to some extent.
55

6-
AstrBot's built-in web search functionality relies on the large language model's `function calling` capability. If you're not familiar with function calling, please refer to: [Function Calling](/use/websearch).
6+
AstrBot's built-in web search functionality relies on the large language model's `function calling` capability. If you're not familiar with function calling, please refer to: [Function Calling](/en/use/function-calling.html).
77

88
When using a large language model that supports function calling with the web search feature enabled, you can try saying:
99

docs/zh/dev/star/guides/plugin-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ AstrBot 提供了“强大”的配置解析和可视化功能。能够让用户
1515
{
1616
"token": {
1717
"description": "Bot Token",
18-
"type": "string",
18+
"type": "string"
1919
},
2020
"sub_config": {
2121
"description": "测试嵌套配置",

docs/zh/dev/star/plugin-publish.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44

55
AstrBot 使用 GitHub 托管插件,因此你需要先将插件代码推送到之前创建的 GitHub 插件仓库中。
66

7-
你可以前往 [AstrBot 插件市场](https://plugins.astrbot.app) 提交你的插件。进入该网站后,点击右下角的 `+` 按钮,填写好基本信息、作者信息、仓库信息等内容后,点击 `提交到 GTIHUB` 按钮,你将会被导航到 AstrBot 仓库的 Issue 提交页面,请确认信息无误后点击 `Create` 按钮提交,即可完成插件发布。
7+
你可以前往 [AstrBot 插件市场](https://plugins.astrbot.app) 提交你的插件。进入该网站后,点击右下角的 `+` 按钮,填写好基本信息、作者信息、仓库信息等内容后,点击 `提交到 GITHUB` 按钮,你将会被导航到 AstrBot 仓库的 Issue 提交页面,请确认信息无误后点击 `Create` 按钮提交,即可完成插件发布。
88

99
![fill out the form](https://files.astrbot.app/docs/source/images/plugin-publish/image.png)

docs/zh/platform/discord.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@
2424
2. 点击左边栏的 Bot,点击 Reset Token 按钮,创建好 Token 后,点击 Copy 按钮,将 Token 填入配置中的 Discord Bot Token 处。
2525

2626
![token选项](https://files.astrbot.app/docs/source/images/discord/image-4.png)
27-
4. 下滑找到这三个选项全开启
27+
3. 下滑找到这三个选项全开启
2828

2929
![Presence Intent,Server Members Intent,Message Content Intent截图](https://files.astrbot.app/docs/source/images/discord/image-2.png)
3030

3131
- Presence Intent:允许机器人获取用户在线状态
3232
- Server Members Intent:允许机器人获取服务器成员信息
3333
- Message Content Intent:允许机器人读取消息内容
3434

35-
5. 点击左边栏的 OAuth2,在 OAuth2 URL Generator 中选中 `Bot`
35+
4. 点击左边栏的 OAuth2,在 OAuth2 URL Generator 中选中 `Bot`
3636
也就是这样
3737
![OAuth2 URL Generator](https://files.astrbot.app/docs/source/images/discord/image-6.png)
3838
然后在下方出现的 Bot Permissions 处选择允许的权限。一般来说,建议添加如下权限:
@@ -49,10 +49,10 @@
4949
如果你觉得麻烦也可以直接使用administrator权限,但仍然建议在使用环境中使用上文的配置权限(或您自己需要的权限)
5050
> 记住,权限越高,风险越大。
5151
52-
6. 复制下方出现的 Generated URL。打开这个 URL,将 Bot 添加到所需要的服务器。
52+
5. 复制下方出现的 Generated URL。打开这个 URL,将 Bot 添加到所需要的服务器。
5353
![Generated URL位置](https://files.astrbot.app/docs/source/images/discord/image-5.png)
5454

55-
7. 进入 Discord 服务器,你的机器人应该已经提示在线了
55+
6. 进入 Discord 服务器,你的机器人应该已经提示在线了
5656
![机器人在线](https://files.astrbot.app/docs/source/images/discord/image-7.png)
5757
@ 刚刚创建的机器人(也可以不 @),输入 `/help`,如果成功返回,则测试成功。
5858

docs/zh/platform/lark.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
### `webhook` 将事件发送至开发者服务器方式
6969

7070
> [!TIP]
71-
> 为了更好地使用这种方式,请先参考 [统一 Webhook 模式](/zh/use/unified-webhook.md#如何使用统一-webhook-模式) 做好相关配置。
71+
> 为了更好地使用这种方式,请先参考 [统一 Webhook 模式](/use/unified-webhook.html) 做好相关配置。
7272
7373
在点击 `保存` 后,机器人卡片会显示「查看 Webhook 链接」,点击查看,复制回调 URL。
7474

docs/zh/platform/wecom.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ AstrBot 支持接入企业微信应用和微信客服。
119119
将你的 公网 IP 地址填写到此处,点击确定。
120120

121121

122-
重启成功后,回到API 接收页面,点击下面的保存,看是否能\够保存成功。如果出现 `openapi 请求回调地址不通过` 说明配置有问题,请检查四个配置项是否填写正确。
122+
重启成功后,回到API 接收页面,点击下面的保存,看是否能够保存成功。如果出现 `openapi 请求回调地址不通过` 说明配置有问题,请检查四个配置项是否填写正确。
123123

124124
如果能够保存成功,AstrBot 就已经能够接收信息。
125125

docs/zh/providers/start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ AstrBot 适配了 OpenAI、Google GenAI、Anthropic 三种原生 API 格式。
3838

3939
> v4.13.0 之后引入
4040
41-
支持使用环境变量加载模型服务提供商的 API Key。在提供商配置页面,将 API Key 一栏填写为 `$环境变量名称` 的名称即可,例如填写 `$DEESEEK_API_KEY`
41+
支持使用环境变量加载模型服务提供商的 API Key。在提供商配置页面,将 API Key 一栏填写为 `$环境变量名称` 的名称即可,例如填写 `$DEEPSEEK_API_KEY`

docs/zh/use/knowledge-base.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
> [!TIP]
44
> 需要 AstrBot 版本 >= 4.5.0。
55
>
6-
> 我们在 4.5.0 版本中重新设计了全新的知识库系统,AstrBot 将原生支持知识库功能。下文介绍的是新版知识库的使用方法。如果您使用的是之前的版本,请参考[旧版知识库使用文档](https://docs.astrbot.app/zh/use/knowledge-base-old), 我们建议您升级到最新版以获得更好的体验。
6+
> 我们在 4.5.0 版本中重新设计了全新的知识库系统,AstrBot 将原生支持知识库功能。下文介绍的是新版知识库的使用方法。如果您使用的是之前的版本,请参考[旧版知识库使用文档](/use/knowledge-base-old.html)我们建议您升级到最新版以获得更好的体验。
77
88
![知识库预览](https://files.astrbot.app/docs/zh/use/image-3.png)
99

@@ -46,7 +46,7 @@ AstrBot 支持多知识库管理。在聊天时,您可以**自由指定知识
4646

4747
在配置文件中,可以为不同的配置文件指定不同的知识库。
4848

49-
## 附录 2:高性价比的嵌入模型申请
49+
## 附录:高性价比的嵌入模型申请
5050

5151
### 硅基流动
5252

0 commit comments

Comments
 (0)