Fix/docs#8229
Conversation
There was a problem hiding this comment.
Code Review
This pull request significantly updates the AstrBot documentation, introducing a new deployment guide for the Desktop Client, expanding the OpenAPI specification with scope permissions and message formats, and updating developer guides for AI tools and message events. It also transitions tool management instructions from CLI commands to the WebUI and corrects several code examples and typos across both English and Chinese versions. Feedback was provided regarding inconsistencies in the AI guide's imports and a potential NameError in code examples where Field was imported but used in lowercase.
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- The newly added
Scope Permissionsandmessageformat sections indocs/en/dev/openapi.mdare fairly detailed; it would be good to cross-check each documented scope and supported message segment type against the actual backend handlers to avoid future drift between docs and implementation. - In
docs/zh/dev/star/guides/other.md, you now show bothget_platform_inst(>= v4.0.0) and the deprecatedget_platformusage; consider explicitly labeling the old snippet as deprecated with a short warning so readers don’t copy it into new plugins.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The newly added `Scope Permissions` and `message` format sections in `docs/en/dev/openapi.md` are fairly detailed; it would be good to cross-check each documented scope and supported message segment type against the actual backend handlers to avoid future drift between docs and implementation.
- In `docs/zh/dev/star/guides/other.md`, you now show both `get_platform_inst` (>= v4.0.0) and the deprecated `get_platform` usage; consider explicitly labeling the old snippet as deprecated with a short warning so readers don’t copy it into new plugins.
## Individual Comments
### Comment 1
<location path="docs/.vitepress/config.mjs" line_range="290" />
<code_context>
collapsed: false,
items: [
{ text: "Package Manager", link: "/astrbot/package" },
+ { text: "Desktop Client", link: "/astrbot/desktop" },
{ text: "One-click Launcher", link: "/astrbot/launcher" },
{ text: "Docker", link: "/astrbot/docker" },
</code_context>
<issue_to_address>
**issue (bug_risk):** Sidebar link path likely mismatches the new desktop doc location.
The doc lives at `docs/en/deploy/astrbot/desktop.md`, which should route to `/deploy/astrbot/desktop`, but this entry uses `/astrbot/desktop`, likely causing a 404. Please update the link (and any localized equivalents) to the correct path.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request provides extensive updates to the AstrBot documentation, introducing a guide for the new Desktop Client and expanding the OpenAPI documentation with details on scope permissions and message formats. Developer guides were updated to reflect API changes in Multi-Agent tools, event hooks, and platform adapter retrieval, while user guides now emphasize WebUI-based tool management over CLI commands. Feedback from the review suggests ensuring internal links in English documentation use the correct language prefix and correcting a code example where certain variables were used without being defined.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request provides extensive updates to the AstrBot documentation, including a new deployment guide for the Desktop Client and detailed OpenAPI specifications for scopes and message formats. Developer guides were updated to reflect API changes such as the on_waiting_llm_request hook, the use of ToolExecResult, and corrected Pydantic field usage. Furthermore, platform documentation for Matrix was expanded, and tool management instructions were transitioned from CLI commands to the WebUI. I have no feedback to provide.
持续修复中英文插件开发文档及平台文档中的多处错误和缺失内容。
Modifications / 改动点
以下这个env不知道为什么留着,故删除)
- docs/zh/dev/star/guides/env.md:删除未挂载的孤立文件
- docs/en/dev/star/guides/env.md:删除未挂载的孤立文件
Screenshots or Test Results / 运行截图或测试结果
这只是一个文档pr)
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.txtandpyproject.toml./ 我确保没有引入新依赖库,或者引入了新依赖库的同时将其添加到
requirements.txt和pyproject.toml文件相应位置。😮 My changes do not introduce malicious code.
/ 我的更改没有引入恶意代码。
Summary by Sourcery
Update and expand AstrBot documentation for OpenAPI, plugin development, platform adapters, and deployment, correcting inaccuracies and clarifying current behavior.
New Features:
Bug Fixes:
Enhancements:
on_waiting_llm_requesthook in both English and Chinese listen-message-event guides to explain its purpose and usage.