docs(zh_cn): add note about avoiding Chinese characters in project path#37
Open
Craun718 wants to merge 1 commit intoMaaXYZ:mainfrom
Open
docs(zh_cn): add note about avoiding Chinese characters in project path#37Craun718 wants to merge 1 commit intoMaaXYZ:mainfrom
Craun718 wants to merge 1 commit intoMaaXYZ:mainfrom
Conversation
There was a problem hiding this comment.
Hey - 我发现了两个问题,并留下了一些整体性的反馈:
- 关于避免在项目路径中使用中文字符的新说明,如果能简要解释一下实际观察到的问题(例如 OCR 模型加载失败或识别出错),以及这个问题是针对特定操作系统还是所有环境都会出现,会更清晰一些。
- 在你修改这一小节的同时,也可以顺手把同一文档中的现有拼写错误
GitHub Actionss修正为GitHub Actions,以提升一致性和清晰度。
供 AI Agent 使用的提示词
请根据本次代码评审的评论进行修改:
## 整体意见
- 关于避免在项目路径中使用中文字符的新说明,如果能简要解释一下实际观察到的问题(例如 OCR 模型加载失败或识别出错),以及这个问题是针对特定操作系统还是所有环境都会出现,会更清晰一些。
- 在你修改这一小节的同时,也可以顺手把同一文档中的现有拼写错误 `GitHub Actionss` 修正为 `GitHub Actions`,以提升一致性和清晰度。
## 单条评论
### Comment 1
<location path="docs/zh_cn/develop/how_to_develop.md" line_range="62" />
<code_context>
本模板附带 GitHub Actionss 工作流的配置文件,CI 检测到 tag 会自动将 [MFAAvalonia](https://github.com/SweetSmellFox/MFAAvalonia) 与你的项目一同打包和发版。
- > [!NOTE]
</code_context>
<issue_to_address>
**issue (typo):** “GitHub Actionss” 应为 “GitHub Actions”。
产品名末尾多了一个多余的 `s`,建议改为正确拼写以避免歧义。
```suggestion
本模板附带 GitHub Actions 工作流的配置文件,CI 检测到 tag 会自动将 [MFAAvalonia](https://github.com/SweetSmellFox/MFAAvalonia) 与你的项目一同打包和发版。
```
</issue_to_address>
### Comment 2
<location path="docs/zh_cn/develop/how_to_develop.md" line_range="64-65" />
<code_context>
- > [!NOTE]
+ > [!NOTE]
> 第一次操作前,需要**先**修改 Github 仓库设置 `Settings` - `Actions` - `General` - `Read and write permissions` - `Save`
```bash
</code_context>
<issue_to_address>
**nitpick (typo):** “Github” 建议统一为标准拼写 “GitHub”。
前文已使用 “GitHub workflow”,这里也建议改为 “GitHub 仓库设置”,统一品牌名拼写。
```suggestion
> [!NOTE]
> 第一次操作前,需要**先**修改 GitHub 仓库设置 `Settings` - `Actions` - `General` - `Read and write permissions` - `Save`
```
</issue_to_address>帮我变得更有用!请对每条评论点选 👍 或 👎,我会根据你的反馈持续改进评审质量。
Original comment in English
Hey - I've found 2 issues, and left some high level feedback:
- The new note about avoiding Chinese characters in the project path would be clearer if it briefly explained the observed issue (e.g., OCR model loading failure or recognition errors) and whether it applies to specific OSes or all environments.
- While you’re touching this section, consider correcting the existing typo
GitHub ActionsstoGitHub Actionsin the same document for consistency and clarity.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The new note about avoiding Chinese characters in the project path would be clearer if it briefly explained the observed issue (e.g., OCR model loading failure or recognition errors) and whether it applies to specific OSes or all environments.
- While you’re touching this section, consider correcting the existing typo `GitHub Actionss` to `GitHub Actions` in the same document for consistency and clarity.
## Individual Comments
### Comment 1
<location path="docs/zh_cn/develop/how_to_develop.md" line_range="62" />
<code_context>
本模板附带 GitHub Actionss 工作流的配置文件,CI 检测到 tag 会自动将 [MFAAvalonia](https://github.com/SweetSmellFox/MFAAvalonia) 与你的项目一同打包和发版。
- > [!NOTE]
</code_context>
<issue_to_address>
**issue (typo):** “GitHub Actionss” 应为 “GitHub Actions”。
产品名末尾多了一个多余的 `s`,建议改为正确拼写以避免歧义。
```suggestion
本模板附带 GitHub Actions 工作流的配置文件,CI 检测到 tag 会自动将 [MFAAvalonia](https://github.com/SweetSmellFox/MFAAvalonia) 与你的项目一同打包和发版。
```
</issue_to_address>
### Comment 2
<location path="docs/zh_cn/develop/how_to_develop.md" line_range="64-65" />
<code_context>
- > [!NOTE]
+ > [!NOTE]
> 第一次操作前,需要**先**修改 Github 仓库设置 `Settings` - `Actions` - `General` - `Read and write permissions` - `Save`
```bash
</code_context>
<issue_to_address>
**nitpick (typo):** “Github” 建议统一为标准拼写 “GitHub”。
前文已使用 “GitHub workflow”,这里也建议改为 “GitHub 仓库设置”,统一品牌名拼写。
```suggestion
> [!NOTE]
> 第一次操作前,需要**先**修改 GitHub 仓库设置 `Settings` - `Actions` - `General` - `Read and write permissions` - `Save`
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| @@ -58,7 +61,7 @@ | |||
|
|
|||
| 本模板附带 GitHub Actionss 工作流的配置文件,CI 检测到 tag 会自动将 [MFAAvalonia](https://github.com/SweetSmellFox/MFAAvalonia) 与你的项目一同打包和发版。 | |||
There was a problem hiding this comment.
issue (typo): “GitHub Actionss” 应为 “GitHub Actions”。
产品名末尾多了一个多余的 s,建议改为正确拼写以避免歧义。
Suggested change
| 本模板附带 GitHub Actionss 工作流的配置文件,CI 检测到 tag 会自动将 [MFAAvalonia](https://github.com/SweetSmellFox/MFAAvalonia) 与你的项目一同打包和发版。 | |
| 本模板附带 GitHub Actions 工作流的配置文件,CI 检测到 tag 会自动将 [MFAAvalonia](https://github.com/SweetSmellFox/MFAAvalonia) 与你的项目一同打包和发版。 |
Original comment in English
issue (typo): “GitHub Actionss” 应为 “GitHub Actions”。
产品名末尾多了一个多余的 s,建议改为正确拼写以避免歧义。
Suggested change
| 本模板附带 GitHub Actionss 工作流的配置文件,CI 检测到 tag 会自动将 [MFAAvalonia](https://github.com/SweetSmellFox/MFAAvalonia) 与你的项目一同打包和发版。 | |
| 本模板附带 GitHub Actions 工作流的配置文件,CI 检测到 tag 会自动将 [MFAAvalonia](https://github.com/SweetSmellFox/MFAAvalonia) 与你的项目一同打包和发版。 |
Comment on lines
+64
to
65
| > [!NOTE] | ||
| > 第一次操作前,需要**先**修改 Github 仓库设置 `Settings` - `Actions` - `General` - `Read and write permissions` - `Save` |
There was a problem hiding this comment.
nitpick (typo): “Github” 建议统一为标准拼写 “GitHub”。
前文已使用 “GitHub workflow”,这里也建议改为 “GitHub 仓库设置”,统一品牌名拼写。
Suggested change
| > [!NOTE] | |
| > 第一次操作前,需要**先**修改 Github 仓库设置 `Settings` - `Actions` - `General` - `Read and write permissions` - `Save` | |
| > [!NOTE] | |
| > 第一次操作前,需要**先**修改 GitHub 仓库设置 `Settings` - `Actions` - `General` - `Read and write permissions` - `Save` |
Original comment in English
nitpick (typo): “Github” 建议统一为标准拼写 “GitHub”。
前文已使用 “GitHub workflow”,这里也建议改为 “GitHub 仓库设置”,统一品牌名拼写。
Suggested change
| > [!NOTE] | |
| > 第一次操作前,需要**先**修改 Github 仓库设置 `Settings` - `Actions` - `General` - `Read and write permissions` - `Save` | |
| > [!NOTE] | |
| > 第一次操作前,需要**先**修改 GitHub 仓库设置 `Settings` - `Actions` - `General` - `Read and write permissions` - `Save` |
Member
|
并没有这个bug |
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
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.
今天群里有人反馈存在中文目录时会导致ocr结果异常,我不确定这是不是maafw的bug
Summary by Sourcery
记录项目路径要求并调整中文版开发指南中的说明格式。
Documentation:
Original summary in English
Summary by Sourcery
Document project path requirements and adjust Chinese development guide notes formatting.
Documentation: