Skip to content

docs(zh_cn): add note about avoiding Chinese characters in project path#37

Open
Craun718 wants to merge 1 commit intoMaaXYZ:mainfrom
Craun718:docs/ch_path
Open

docs(zh_cn): add note about avoiding Chinese characters in project path#37
Craun718 wants to merge 1 commit intoMaaXYZ:mainfrom
Craun718:docs/ch_path

Conversation

@Craun718
Copy link
Copy Markdown

@Craun718 Craun718 commented May 8, 2026

今天群里有人反馈存在中文目录时会导致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:

  • Add a note in the Chinese development guide warning against using Chinese characters in the project path.
  • Normalize note and warning block markup spacing in the Chinese development documentation.

Copy link
Copy Markdown

@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 - 我发现了两个问题,并留下了一些整体性的反馈:

  • 关于避免在项目路径中使用中文字符的新说明,如果能简要解释一下实际观察到的问题(例如 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>

Sourcery 对开源项目免费使用——如果你觉得我们的评审有帮助,欢迎分享 ✨
帮我变得更有用!请对每条评论点选 👍 或 👎,我会根据你的反馈持续改进评审质量。
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 Actionss to GitHub Actions in 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>

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.

@@ -58,7 +61,7 @@

本模板附带 GitHub Actionss 工作流的配置文件,CI 检测到 tag 会自动将 [MFAAvalonia](https://github.com/SweetSmellFox/MFAAvalonia) 与你的项目一同打包和发版。
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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`
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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`

@Windsland52
Copy link
Copy Markdown
Member

并没有这个bug

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants