docs: align deployment sections across multilingual readmes#5734
Merged
zouyonghe merged 3 commits intoAstrBotDevs:masterfrom Mar 4, 2026
Merged
docs: align deployment sections across multilingual readmes#5734zouyonghe merged 3 commits intoAstrBotDevs:masterfrom
zouyonghe merged 3 commits intoAstrBotDevs:masterfrom
Conversation
dosubot
bot
added
the
size:L
Contributor
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the clarity and consistency of deployment instructions across various language versions of the project's READMEs. The changes aim to provide more precise guidance for users, detailing prerequisites for different deployment methods and standardizing the presentation of desktop application options. This ensures that users accessing the documentation in any supported language receive up-to-date and coherent information. Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - 我在这里给出了一些总体反馈：
- 在多种语言版本中，Docker 文档链接后面的句号丢失了（例如
README.md、README_fr.md、README_ja.md、README_zh*.md）。为了可读性，建议在各个部署小节中统一行内链接之后的标点用法。 - 你只在 AUR 小节中引入了明确的“deployment difficulty: low（部署难度：低）”说明；建议要么删除这一难度标签，要么为其他部署方式也加入相应的难度提示，以保持整体指引的一致性。
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In several languages the Docker docs link lost its trailing period (e.g., `README.md`, `README_fr.md`, `README_ja.md`, `README_zh*.md`); consider making punctuation after inline links consistent across the deployment sections for readability.
- You’ve introduced an explicit "deployment difficulty: low" note only in the AUR sections; consider either dropping the difficulty label or adding comparable difficulty cues for other deployment methods to keep the guidance consistent.帮我变得更有用！请在每条评论上点 👍 或 👎，我会根据你的反馈改进后续的评审。
Original comment in English
Hey - I've left some high level feedback:
- In several languages the Docker docs link lost its trailing period (e.g.,
README.md,README_fr.md,README_ja.md,README_zh*.md); consider making punctuation after inline links consistent across the deployment sections for readability. - You’ve introduced an explicit "deployment difficulty: low" note only in the AUR sections; consider either dropping the difficulty label or adding comparable difficulty cues for other deployment methods to keep the guidance consistent.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In several languages the Docker docs link lost its trailing period (e.g., `README.md`, `README_fr.md`, `README_ja.md`, `README_zh*.md`); consider making punctuation after inline links consistent across the deployment sections for readability.
- You’ve introduced an explicit "deployment difficulty: low" note only in the AUR sections; consider either dropping the difficulty label or adding comparable difficulty cues for other deployment methods to keep the guidance consistent.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
Related Documentation Checked 1 published document(s) in 1 knowledge base(s). No updates required. How did I do? Any feedback? |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request does a great job of aligning the deployment sections across all multilingual READMEs. The added clarifications for uv and Docker deployments, along with the expanded descriptions for AUR, Replit, and other methods, significantly improve the clarity and usefulness of the documentation. The restructuring of the desktop and launcher sections also makes the intended use cases clearer. I've only found a minor grammatical consistency issue across the files, where sentence-ending punctuation was removed. My suggestions aim to restore this for better readability.
Note: Security Review has been skipped due to the limited scope of the PR.
| For users familiar with containers and looking for a more stable, production-ready deployment method, we recommend deploying AstrBot with Docker / Docker Compose. | ||
|
|
||
| Please refer to the official documentation: [Deploy AstrBot with Docker](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot). | ||
| Please refer to the official documentation: [Deploy AstrBot with Docker](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) |
Contributor
There was a problem hiding this comment.
For grammatical correctness and consistency with other sentences in this document, this line should end with a period. It seems this was removed, but other descriptive sentences retain their punctuation.
Suggested change
| Please refer to the official documentation: [Deploy AstrBot with Docker](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) | |
| Please refer to the official documentation: [Deploy AstrBot with Docker](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot). |
| Pour les utilisateurs familiers avec les conteneurs et qui souhaitent une méthode plus stable et adaptée à la production, nous recommandons de déployer AstrBot avec Docker / Docker Compose. | ||
|
|
||
| Veuillez consulter la documentation officielle : [Déployer AstrBot avec Docker](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot). | ||
| Veuillez consulter la documentation officielle [Déployer AstrBot avec Docker](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) |
Contributor
There was a problem hiding this comment.
Pour la correction grammaticale et la cohérence, cette phrase devrait se terminer par un point. De plus, le deux-points (:) avant le lien a été supprimé, ce qui rend la phrase moins claire. Il est suggéré de les restaurer pour être cohérent avec la version anglaise et la version précédente de ce fichier.
Suggested change
| Veuillez consulter la documentation officielle [Déployer AstrBot avec Docker](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) | |
| Veuillez consulter la documentation officielle : [Déployer AstrBot avec Docker](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot). |
| コンテナ運用に慣れており、より安定した本番向けのデプロイ方法を求めるユーザーには、Docker / Docker Compose での AstrBot デプロイをおすすめします。 | ||
|
|
||
| 公式ドキュメント [Docker を使用した AstrBot のデプロイ](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) をご参照ください。 | ||
| 公式ドキュメント [Docker を使用した AstrBot のデプロイ](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) をご参照ください |
Contributor
There was a problem hiding this comment.
文法的な正しさと一貫性のために、この文は句点（。）で終わるべきです。他の説明文では句点が保持されているため、ここでも追加することをお勧めします。
Suggested change
| 公式ドキュメント [Docker を使用した AstrBot のデプロイ](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) をご参照ください | |
| 公式ドキュメント [Docker を使用した AstrBot のデプロイ](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) をご参照ください。 |
| Для пользователей, знакомых с контейнерами и которым нужен более стабильный и подходящий для production способ, мы рекомендуем разворачивать AstrBot через Docker / Docker Compose. | ||
|
|
||
| См. официальную документацию: [Развёртывание AstrBot с Docker](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot). | ||
| См. официальную документацию [Развёртывание AstrBot с Docker](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) |
Contributor
There was a problem hiding this comment.
Для грамматической правильности и единообразия это предложение должно заканчиваться точкой. Также было удалено двоеточие (:) перед ссылкой. Рекомендуется вернуть их для ясности и последовательности, как в английской версии и предыдущей версии этого файла.
Suggested change
| См. официальную документацию [Развёртывание AstrBot с Docker](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) | |
| См. официальную документацию: [Развёртывание AstrBot с Docker](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot). |
| 對於熟悉容器、希望獲得更穩定且更適合正式環境部署方式的使用者，我們推薦使用 Docker / Docker Compose 部署 AstrBot。 | ||
|
|
||
| 請參閱官方文件 [使用 Docker 部署 AstrBot](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot)。 | ||
| 請參考官方文件 [使用 Docker 部署 AstrBot](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) |
Contributor
There was a problem hiding this comment.
為了語法正確性和一致性，此句應以句號（。）結尾。其他描述性句子都保留了標點符號，建議此處也加上。
Suggested change
| 請參考官方文件 [使用 Docker 部署 AstrBot](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) | |
| 請參考官方文件 [使用 Docker 部署 AstrBot](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot)。 |
| 对于熟悉容器、希望获得更稳定且更适合生产环境部署方式的用户，我们推荐使用 Docker / Docker Compose 部署 AstrBot。 | ||
|
|
||
| 请参阅官方文档 [使用 Docker 部署 AstrBot](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) 。 | ||
| 请参考官方文档 [使用 Docker 部署 AstrBot](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) |
Contributor
There was a problem hiding this comment.
为了语法正确性和一致性，此句应以句号（。）结尾。其他描述性句子都保留了标点符号，建议此处也加上。
Suggested change
| 请参考官方文档 [使用 Docker 部署 AstrBot](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot) | |
| 请参考官方文档 [使用 Docker 部署 AstrBot](https://astrbot.app/deploy/astrbot/docker.html#%E4%BD%BF%E7%94%A8-docker-%E9%83%A8%E7%BD%B2-astrbot)。 |
Member
Author
|
@sourcery-ai review |
Contributor
There was a problem hiding this comment.
嗨——我发现了 2 个问题
面向 AI 代理的提示
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="README_fr.md" line_range="76" />
<code_context>
### Déploiement en un clic
-Pour les utilisateurs qui souhaitent découvrir AstrBot rapidement, nous recommandons la méthode de déploiement en un clic avec `uv` ⚡️ :
+Pour les utilisateurs qui veulent découvrir AstrBot rapidement, sont familiers avec la ligne de commande et peuvent installer eux-mêmes l'environnement `uv`, nous recommandons la méthode de déploiement en un clic avec `uv` ⚡️ :
```bash
</code_context>
<issue_to_address>
**suggestion (typo):** Rendre la proposition relative plus fluide en répétant « qui » avant « sont familiers ».
Par exemple :
« Pour les utilisateurs qui veulent découvrir AstrBot rapidement, **qui sont familiers** avec la ligne de commande et peuvent installer eux-mêmes l'environnement `uv`, nous recommandons… »
```suggestion
Pour les utilisateurs qui veulent découvrir AstrBot rapidement, qui sont familiers avec la ligne de commande et peuvent installer eux-mêmes l'environnement `uv`, nous recommandons la méthode de déploiement en un clic avec `uv` ⚡️ :
```
</issue_to_address>
### Comment 2
<location path="README_ru.md" line_range="118" />
<code_context>
### AUR
+AUR-вариант предназначен для пользователей Arch Linux, которым удобна установка через системный пакетный поток.
+
+Выполните команду ниже для установки `astrbot-git`, затем запустите AstrBot локально.
</code_context>
<issue_to_address>
**issue (typo):** Уточнить формулировку «системный пакетный поток» на более привычное «системный менеджер пакетов».
Лучше использовать термин «системный менеджер пакетов», например:
«…которым удобна установка через **системный менеджер пакетов**.»
```suggestion
AUR-вариант предназначен для пользователей Arch Linux, которым удобна установка через системный менеджер пакетов.
```
</issue_to_address>帮我变得更有用！请在每条评论上点 👍 或 👎，我会根据你的反馈改进之后的评审。
Original comment in English
Hey - I've found 2 issues
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="README_fr.md" line_range="76" />
<code_context>
### Déploiement en un clic
-Pour les utilisateurs qui souhaitent découvrir AstrBot rapidement, nous recommandons la méthode de déploiement en un clic avec `uv` ⚡️ :
+Pour les utilisateurs qui veulent découvrir AstrBot rapidement, sont familiers avec la ligne de commande et peuvent installer eux-mêmes l'environnement `uv`, nous recommandons la méthode de déploiement en un clic avec `uv` ⚡️ :
```bash
</code_context>
<issue_to_address>
**suggestion (typo):** Rendre la proposition relative plus fluide en répétant « qui » avant « sont familiers ».
Par exemple :
« Pour les utilisateurs qui veulent découvrir AstrBot rapidement, **qui sont familiers** avec la ligne de commande et peuvent installer eux-mêmes l'environnement `uv`, nous recommandons… »
```suggestion
Pour les utilisateurs qui veulent découvrir AstrBot rapidement, qui sont familiers avec la ligne de commande et peuvent installer eux-mêmes l'environnement `uv`, nous recommandons la méthode de déploiement en un clic avec `uv` ⚡️ :
```
</issue_to_address>
### Comment 2
<location path="README_ru.md" line_range="118" />
<code_context>
### AUR
+AUR-вариант предназначен для пользователей Arch Linux, которым удобна установка через системный пакетный поток.
+
+Выполните команду ниже для установки `astrbot-git`, затем запустите AstrBot локально.
</code_context>
<issue_to_address>
**issue (typo):** Уточнить формулировку «системный пакетный поток» на более привычное «системный менеджер пакетов».
Лучше использовать термин «системный менеджер пакетов», например:
«…которым удобна установка через **системный менеджер пакетов**.»
```suggestion
AUR-вариант предназначен для пользователей Arch Linux, которым удобна установка через системный менеджер пакетов.
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Member
Author
|
@sourcery-ai review |
Contributor
There was a problem hiding this comment.
Hey - 我已经审查了你的更改，一切看起来都很棒！
帮我变得更有用！请在每条评论上点 👍 或 👎，我会根据你的反馈改进后续的代码评审。
Original comment in English
Hey - I've reviewed your changes and they look great!
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Soulter
pushed a commit
that referenced
this pull request
Mar 5, 2026
* docs: align deployment sections across multilingual readmes * docs: normalize deployment punctuation and AUR guidance * docs: fix french and russian deployment wording
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
The Chinese README deployment section was updated with a new writing style and recommendation criteria. This PR syncs that structure and meaning to multilingual READMEs.
Changes
README.mdREADME_zh-TW.mdREADME_fr.mdREADME_ru.mdREADME_ja.mduvone-click deployment now targets users familiar with CLI and able to set up auvenvironment.Scope
Verification
uv run ruff format .uv run ruff check .Reference
README_zh.md.由 Sourcery 提供的摘要
在多语言 README 中对部署文档进行对齐，澄清每种部署方式的推荐使用场景和目标用户。
文档更新：
Original summary in English
Summary by Sourcery
在多语言 README 中统一部署文档，并为不同类型的用户明确推荐的部署方式。
文档：
Original summary in English
Summary by Sourcery
Align deployment documentation across multilingual READMEs and clarify recommended deployment paths for different user profiles.
Documentation: