docs: default README to English#87
Conversation
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 standardizes the primary 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}
There was a problem hiding this comment.
Hey - 我在这里提供了一些整体性的反馈：
- 建议尽量保持常用标签的措辞与上游一致（例如链接文本使用 “Releases” 还是 “Download Releases”，使用 “正式版” 还是 “Stable release”），这样用户在阅读桌面端文档时，更容易与主 AstrBot 文档和界面中的标签对应起来。
- 为了便于后续维护，建议尽量让英文和中文的 README 在结构上保持便于对比 diff（例如使用相同的章节顺序和标题），这样在更新内容时，可以在不同语言之间更方便地同步，减少偏移。
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider keeping the wording of common labels consistent with upstream (e.g., link text like “Releases” vs “Download Releases”, “正式版” vs “Stable release”) so users can more easily match the desktop docs with the main AstrBot docs and UI labels.
- It may help future maintenance to keep the English and Chinese READMEs structurally diff-friendly (e.g., same section order and headings), so content updates can be mirrored between languages with minimal drift.帮我变得更有用！请在每条评论上点 👍 或 👎，我会根据你的反馈改进后续的评审质量。
Original comment in English
Hey - I've left some high level feedback:
- Consider keeping the wording of common labels consistent with upstream (e.g., link text like “Releases” vs “Download Releases”, “正式版” vs “Stable release”) so users can more easily match the desktop docs with the main AstrBot docs and UI labels.
- It may help future maintenance to keep the English and Chinese READMEs structurally diff-friendly (e.g., same section order and headings), so content updates can be mirrored between languages with minimal drift.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider keeping the wording of common labels consistent with upstream (e.g., link text like “Releases” vs “Download Releases”, “正式版” vs “Stable release”) so users can more easily match the desktop docs with the main AstrBot docs and UI labels.
- It may help future maintenance to keep the English and Chinese READMEs structurally diff-friendly (e.g., same section order and headings), so content updates can be mirrored between languages with minimal drift.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the repository's documentation to make English the default language for the README.md file. The previous Chinese content has been moved to README_zh.md, and language-switching links have been added to both files. My review focuses on ensuring a consistent and clear experience for English-speaking users. I've identified a minor issue where the English README links to documentation that is still in Chinese, which could be confusing. I've suggested a fix to clarify the language of the linked documents.
| - [`docs/data-migration.md`](docs/data-migration.md): data migration between the desktop app and source deployment. | ||
| - [`docs/development.md`](docs/development.md): local build, maintenance commands, version syncing, and release notes. | ||
| - [`docs/environment-variables.md`](docs/environment-variables.md): environment variable reference. | ||
| - [`docs/architecture.md`](docs/architecture.md): current desktop architecture. | ||
| - [`docs/repository-structure.md`](docs/repository-structure.md): repository structure overview. |
There was a problem hiding this comment.
The descriptions for these documents have been translated to English, but the documents themselves (docs/*.md) are still in Chinese. This can be confusing for users who click the links expecting English content.
To avoid this, I suggest keeping the original Chinese descriptions to clearly indicate the language of the linked documents until they are translated.
| - [`docs/data-migration.md`](docs/data-migration.md): data migration between the desktop app and source deployment. | |
| - [`docs/development.md`](docs/development.md): local build, maintenance commands, version syncing, and release notes. | |
| - [`docs/environment-variables.md`](docs/environment-variables.md): environment variable reference. | |
| - [`docs/architecture.md`](docs/architecture.md): current desktop architecture. | |
| - [`docs/repository-structure.md`](docs/repository-structure.md): repository structure overview. | |
| - [`docs/data-migration.md`](docs/data-migration.md)：桌面端与源码部署之间的数据迁移说明。 | |
| - [`docs/development.md`](docs/development.md)：本地构建、维护命令、版本同步与发布说明。 | |
| - [`docs/environment-variables.md`](docs/environment-variables.md)：环境变量清单。 | |
| - [`docs/architecture.md`](docs/architecture.md)：当前桌面端架构说明。 | |
| - [`docs/repository-structure.md`](docs/repository-structure.md)：仓库目录职责总览. |
|
@sourcery-ai review |
There was a problem hiding this comment.
Hey - 我在这里给出了一些总体反馈：
- 在
README_zh.md中，顶部导航里的发布链接仍然使用英文标签Releases；建议将这个标签本地化（例如像之前那样使用下载 Releases），以保证中文 README 与原始英文文档在措辞上保持完全一致。
给 AI Agents 的提示
请根据本次代码评审中的评论进行修改：
## 总体评论
- 在 `README_zh.md` 中，顶部导航里的发布链接仍然使用英文标签 `Releases`；建议将这个标签本地化（例如像之前那样使用 `下载 Releases`），以保证中文 README 与原始英文文档在措辞上保持完全一致。帮我变得更有用！请在每条评论上点击 👍 或 👎，我会根据你的反馈改进后续评审。
Original comment in English
Hey - I've left some high level feedback:
- In
README_zh.md, the top navigation still labels the releases link asReleasesin English; consider localizing this label (e.g.,下载 Releasesas before) to keep the Chinese README fully consistent with the original wording.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In `README_zh.md`, the top navigation still labels the releases link as `Releases` in English; consider localizing this label (e.g., `下载 Releases` as before) to keep the Chinese README fully consistent with the original wording.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
@sourcery-ai review |
1 participant
Summary
README.mdthe default English entry to match the upstream AstrBot language-switch patternREADME_zh.mdand add cross-links between the two filesTest Plan
git diff --check -- README.md README_zh.mdSummary by Sourcery
将主要的 README 重写为默认的英文版本，并新增一份简体中文 README，同时保持桌面端文档布局的一致性。
Documentation:
Original summary in English
Summary by Sourcery
Rewrite the primary README as the English default and introduce a separate Simplified Chinese README while keeping the desktop documentation layout consistent.
Documentation:
文档：
Original summary in English
Summary by Sourcery
将主要的 README 重写为默认的英文版本，并新增一份简体中文 README，同时保持桌面端文档布局的一致性。
Documentation:
Original summary in English
Summary by Sourcery
Rewrite the primary README as the English default and introduce a separate Simplified Chinese README while keeping the desktop documentation layout consistent.
Documentation:
Original summary in English
Summary by Sourcery
将主要的 README 重写为默认的英文版本，并新增一份简体中文 README，同时保持桌面端文档布局的一致性。
Documentation:
Original summary in English
Summary by Sourcery
Rewrite the primary README as the English default and introduce a separate Simplified Chinese README while keeping the desktop documentation layout consistent.
Documentation:
文档：
Original summary in English
Summary by Sourcery
将主要的 README 重写为默认的英文版本，并新增一份简体中文 README，同时保持桌面端文档布局的一致性。
Documentation:
Original summary in English
Summary by Sourcery
Rewrite the primary README as the English default and introduce a separate Simplified Chinese README while keeping the desktop documentation layout consistent.
Documentation: