Skip to content

docs: improve deployment guide with categorized options and comparison table#4813

Open
awanawana wants to merge 2 commits intoAstrBotDevs:masterfrom
awanawana:master
Open

docs: improve deployment guide with categorized options and comparison table#4813
awanawana wants to merge 2 commits intoAstrBotDevs:masterfrom
awanawana:master

Conversation

@awanawana
Copy link

@awanawana awanawana commented Feb 2, 2026

Modifications / 改动点

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

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


Checklist / 检查清单

  • 😊 如果 PR 中有新加入的功能,已经通过 Issue / 邮件等方式和作者讨论过。/ If there are new features added in the PR, I have discussed it with the authors through issues/emails, etc.
  • 👀 我的更改经过了良好的测试,并已在上方提供了“验证步骤”和“运行截图”。/ My changes have been well-tested, and "Verification Steps" and "Screenshots" have been provided above.
  • 🤓 我确保没有引入新依赖库,或者引入了新依赖库的同时将其添加到了 requirements.txtpyproject.toml 文件相应位置。/ 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.
  • 😮 我的更改没有引入恶意代码。/ My changes do not introduce malicious code.

Summary by Sourcery

重新组织并充实 README 中的快速开始部署章节,通过分类的部署选项和常见故障排除提示来引导用户完成部署。

Documentation:

  • 在 README 中编写更清晰、分类明确的所有支持部署方式(Docker、面板、云端、Windows 安装程序、CasaOS、uv)的概览文档。
  • 为每种部署选项添加分步说明和直接链接,包括 Docker Compose 的使用方式以及一键面板或安装程序。
  • 引入一个对比表,总结主要部署方式的优缺点和推荐使用场景,并附上简要 FAQ,涵盖常见部署问题。
Original summary in English

Summary by Sourcery

Reorganize and enrich the quick start deployment section in the README to guide users through categorized deployment options and common troubleshooting tips.

Documentation:

  • Document a clearer, categorized overview of all supported deployment methods (Docker, panels, cloud, Windows installer, CasaOS, uv) in the README.
  • Add step-by-step instructions and direct links for each deployment option, including Docker compose usage and one-click panels or installers.
  • Introduce a comparison table summarizing the pros, cons, and recommended scenarios for major deployment methods, along with a brief FAQ for common deployment issues.

@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Feb 2, 2026
@dosubot
Copy link

dosubot bot commented Feb 2, 2026

Related Documentation

Checked 1 published document(s) in 1 knowledge base(s). No updates required.

How did I do? Any feedback?  Join Discord

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - 我在这里给出了一些总体反馈:

  • 现在出现了两个连续的 ## 快速开始 标题,并且中间没有任何内容;建议删除其中一个,以避免在渲染后的 README 中出现空章节和重复标题。
  • 当前 README 不再提及之前存在的 Replit 和 手动部署 选项;如果这些方式仍然受支持,建议在新的分类章节或对比表中添加相应链接,以便用户仍然可以找到它们。
给 AI Agents 使用的提示词
Please address the comments from this code review:

## Overall Comments
- There are now two consecutive `## 快速开始` headings with no content between them; consider removing one to avoid an empty section and redundant heading in the rendered README.
- The README no longer mentions the Replit and手动部署 options that previously existed; if these methods are still supported, consider linking them from the new categorized sections or the comparison table so users can still discover them.

Sourcery 对开源项目是免费的——如果你觉得我们的评审对你有帮助,欢迎分享 ✨
帮我变得更有用!请在每条评论上点击 👍 或 👎,我会根据你的反馈改进后续的评审。
Original comment in English

Hey - I've left some high level feedback:

  • There are now two consecutive ## 快速开始 headings with no content between them; consider removing one to avoid an empty section and redundant heading in the rendered README.
  • The README no longer mentions the Replit and手动部署 options that previously existed; if these methods are still supported, consider linking them from the new categorized sections or the comparison table so users can still discover them.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- There are now two consecutive `## 快速开始` headings with no content between them; consider removing one to avoid an empty section and redundant heading in the rendered README.
- The README no longer mentions the Replit and手动部署 options that previously existed; if these methods are still supported, consider linking them from the new categorized sections or the comparison table so users can still discover them.

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.

astrbot-doc-agent bot pushed a commit to AstrBotDevs/AstrBot-docs that referenced this pull request Feb 2, 2026
@astrbot-doc-agent
Copy link

已为该 PR 生成文档更新 PR(待人工审核):
AstrBotDevs/AstrBot-docs#113


AI 改动摘要:

Updated the documentation to include a categorized deployment guide and a comparison table, reflecting the improvements made in the upstream PR.

Changes:

  • New Deployment Overview Pages:

    • Created zh/deploy/astrbot/index.md (Chinese) and en/deploy/astrbot/index.md (English) to serve as a high-level guide for choosing a deployment method.
    • Categorized deployment options into:
      • Beginner Recommended: Docker, BT Panel, 1Panel.
      • Advanced: uv deployment.
      • Cloud: RainYun.
      • Special Platforms: Windows Installer, CasaOS.
    • Added a Comparison Table highlighting the pros, cons, and use cases for each method.
    • Included a FAQ section for common deployment issues.
  • Sidebar Configuration:

    • Updated .vitepress/config.mjs to include the new "Deployment Overview" (🚀 部署概览 / 🚀 Deployment Overview) at the top of the deployment section.
    • Configured the "Deploy AstrBot" sidebar category to be clickable, linking directly to the new overview page.

@LIghtJUNction
Copy link
Member

LIghtJUNction commented Feb 3, 2026

uvx 是uv run别名,我建议使用uv tool install安装,这两者有点区别。

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

Labels

size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants