Skip to content

docs: 文档更新 - 指令、FAQ、网页搜索、插件发布等#8912

Open
NayukiChiba wants to merge 5 commits into
AstrBotDevs:masterfrom
NayukiChiba:docs/overhaul
Open

docs: 文档更新 - 指令、FAQ、网页搜索、插件发布等#8912
NayukiChiba wants to merge 5 commits into
AstrBotDevs:masterfrom
NayukiChiba:docs/overhaul

Conversation

@NayukiChiba

@NayukiChiba NayukiChiba commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Modifications / 改动点

变更内容

指令文档

  • 补齐主程序内置指令 /stats/provider,从 9 个更新为 11 个
  • 新增 /stats(Token 用量统计)和 /provider(Provider 切换)的详细说明
  • 修正 /provider 可达性检测配置路径

FAQ

  • 更新管理员指令列表:移除已废弃的 /wl/dewl,补充 /name/provider/llm/plugin/model/groupnew
  • WebUI 忘记密码章节双链到 FAQ 对应章节

网页搜索

  • 新增 Firecrawl 搜索源支持(共 5 种)
  • 同步更新 dev 配置文档中的 websearch_provider 选项

插件发布

  • 添加废弃警告:主仓库 Issue 提交方式已迁移至 AstrBot_Plugins_Collection

社区

  • 更新 QQ 群组信息

  • This is NOT a breaking change. / 这不是一个破坏性变更。

Screenshots or Test Results / 运行截图或测试结果


Checklist / 检查清单

  • 😊 If there are new features added in the PR, I have discussed it with the authors through issues/emails, etc.
    / 如果 PR 中有新加入的功能,已经通过 Issue / 邮件等方式和作者讨论过。

  • 👀 My changes have been well-tested, and "Verification Steps" and "Screenshots" have been provided above.
    / 我的更改经过了良好的测试,并已在上方提供了“验证步骤”和“运行截图”

  • 🤓 I have ensured that no new dependencies are introduced, OR if new dependencies are introduced, they have been added to the appropriate locations in requirements.txt and pyproject.toml.
    / 我确保没有引入新依赖库,或者引入了新依赖库的同时将其添加到 requirements.txtpyproject.toml 文件相应位置。

  • 😮 My changes do not introduce malicious code.
    / 我的更改没有引入恶意代码。

Summary by Sourcery

Update user and developer documentation to cover new commands, web search provider options, plugin submission flow, and community contact info.

Documentation:

  • Document the /stats and /provider built-in commands in both English and Chinese command guides, including usage and permissions.
  • Refresh FAQ admin command lists in English and Chinese to reflect the current default admin commands.
  • Expand web search usage docs to include Firecrawl as a supported provider with configuration instructions in both English and Chinese.
  • Update developer config docs to describe the new firecrawl web search provider type and its API key setting.
  • Clarify plugin publishing docs to deprecate submitting plugins via the main AstrBot repository and direct users to the AstrBot_Plugins_Collection repository instead.
  • Revise community and README QQ group sections (EN/ZH) with the latest group lineup and statuses, and cross-link WebUI password reset docs to the relevant FAQ entries.

- 移除了旧的 QQ 群组信息并添加了新的群组。
- 确保所有群组信息的准确性和完整性。
- 提升文档的可读性和用户体验。
- 在英文和中文文档的"忘记密码"章节末尾添加 TIP 提示框
- 提示框链接至对应 FAQ 条目,提供更详细的操作说明
- 增强文档之间的关联性,提升用户查阅体验
- 在英文和中文的命令文档中添加 /stats 和 /provider 指令的详细使用说明
- 更新中英文 FAQ 页面的管理员指令列表,与最新的默认指令保持一致
- 确保中英文文档内容同步,提升文档准确性和用户查阅体验
- 在开发版配置文档中补充 websearch_provider 选项,加入 firecrawl 及对应密钥配置项
- 更新中英文网页搜索使用指南,将支持搜索源数量同步为五种并提供 Firecrawl 注册指引
- 确保中英文文档内容一致,提升配置说明的完整性和用户查阅体验
- 废弃通过 AstrBot 主仓库 Issue 提交插件的方式
- 新增警告框提示正确提交入口为 AstrBot_Plugins_Collection
- 同步更新中英文版插件发布文档
@dosubot dosubot Bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Jun 20, 2026

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the English and Chinese documentation for AstrBot. Key changes include updating the QQ group listings, adding documentation for the new Firecrawl web search provider, updating the plugin publishing guidelines to point to the new repository, documenting the new /stats and /provider commands, and updating the default admin commands list. The review feedback suggests unifying UI terminology in the English FAQ (Config -> Other Config) and expanding the brief description of the /provider command in both English and Chinese docs to accurately reflect its support for LLM, TTS, and STT providers.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/en/faq.md
### No Permission to Execute Admin Commands

1. `/reset, /persona, /dashboard_update, /op, /deop, /wl, /dewl` are the default admin commands. You can use the `/sid` command to get a user's ID, then add it to the admin ID list in Settings -> Other Settings.
1. `/name, /provider, /dashboard_update, /op, /deop, /persona, /llm, /plugin, /model, /groupnew` are the default admin commands. You can use the `/sid` command to get a user's ID, then add it to the admin ID list in Settings -> Other Settings.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

docs/en/faq.md 中,第 91 行使用的是 Config -> Other Config,而第 103 行使用的是 Settings -> Other Settings。为了保持英文文档中界面术语的一致性,建议将 Settings -> Other Settings 统一修改为 Config -> Other Config

Suggested change
1. `/name, /provider, /dashboard_update, /op, /deop, /persona, /llm, /plugin, /model, /groupnew` are the default admin commands. You can use the `/sid` command to get a user's ID, then add it to the admin ID list in Settings -> Other Settings.
1. `/name, /provider, /dashboard_update, /op, /deop, /persona, /llm, /plugin, /model, /groupnew` are the default admin commands. You can use the `/sid` command to get a user's ID, then add it to the admin ID list in Config -> Other Config.

Comment thread docs/en/use/command.md
- `/stop`: Stop Agent tasks currently running in the current session.
- `/new`: Create and switch to a new conversation.
- `/stats`: View token usage statistics for the current conversation.
- `/provider`: View or switch LLM Provider. This command requires admin permission.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

根据下文第 122 行的详细说明,/provider 指令不仅可以查看或切换 LLM 提供商,还可以用于 TTS 和 STT 提供商。因此,建议将此处的简短描述修改为包含 LLM、TTS 和 STT,以保证文档的准确性。

Suggested change
- `/provider`: View or switch LLM Provider. This command requires admin permission.
- `/provider`: View or switch LLM, TTS, or STT Provider. This command requires admin permission.

Comment thread docs/zh/use/command.md
- `/stop`:停止当前会话中正在运行的 Agent 任务。
- `/new`:创建并切换到一个新对话。
- `/stats`:查看当前会话的 Token 用量统计。
- `/provider`:查看或切换 LLM Provider。该指令需要管理员权限。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

根据下文第 116 行的详细说明,/provider 指令不仅可以查看或切换 LLM 提供商,还可以用于 TTS 和 STT 提供商。因此,建议将此处的简短描述修改为包含 LLM、TTS 和 STT,以保证文档的准确性。

Suggested change
- `/provider`:查看或切换 LLM Provider。该指令需要管理员权限。
- `/provider`:查看或切换 LLM、TTS 或 STT Provider。该指令需要管理员权限。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant