Skip to content

docs: 修复开发手册错误、同步中英文文档并新增 AutoFight 英文文档#1087

Merged
MistEO merged 2 commits intoMaaEnd:mainfrom
ocsin1:docs/development
Mar 7, 2026
Merged

docs: 修复开发手册错误、同步中英文文档并新增 AutoFight 英文文档#1087
MistEO merged 2 commits intoMaaEnd:mainfrom
ocsin1:docs/development

Conversation

@ocsin1
Copy link
Contributor

@ocsin1 ocsin1 commented Mar 7, 2026

Summary by Sourcery

更新开发者文档,以纠正工作区路径、澄清资源链接行为,并记录 AutoFight 战斗自动化模块。

Documentation:

  • 在中英文开发指南中,澄清推荐工作目录、资源文件夹链接方式,以及 interface.json 的处理方式。
  • 统一英文 MapTracker 文档中的术语,并在流水线低代码规范中补充命名规范和无等待冻结(wait-freeze)的最佳实践。
  • 新增英文 AutoFight 参考文档,说明相关概念、使用模式、接口约定,以及当前轮转实现的限制与待办事项(TODO)。
Original summary in English

Summary by Sourcery

Update developer documentation to correct workspace paths, clarify resource linkage behavior, and document the AutoFight combat automation module.

Documentation:

  • Clarify recommended working directory, resource folder linkage, and interface.json handling in both Chinese and English development guides.
  • Align English MapTracker documentation terminology and expand pipeline low-code specifications with naming and wait-freeze best practices.
  • Add an English AutoFight reference document describing concepts, usage patterns, interface conventions, and current rotation implementation with limitations and TODOs.

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.

你好——我发现了 1 个问题,并留了一些整体性的反馈:

  • 在中文文档的小节标题 ### 关于秦始皇节点(可复用节点或 Custon ) 中,Custon 看起来像是拼写错误,为了与文档其余部分保持一致,应该为 Custom
  • 修改后的中文句子 工作目录可设置为**项目根目录**的文件夹 有点含糊;可以考虑改写为 工作目录建议设置为项目根目录(或其下的某个子文件夹),以更清楚地说明具体应该选择什么。
  • 在关于 interface.json(assets/install 关联)的中文描述中,结尾的标点和空格有些问题(...再进行ui中的测试。(或运行 build_and_install.py ,运行方法同上));建议统一为更规范的空格与大小写,例如使用 UI,并去掉重复的句号。
提供给 AI Agent 的提示词
Please address the comments from this code review:

## Overall Comments
- 在中文文档的小节标题 `### 关于秦始皇节点(可复用节点或 Custon )` 中,`Custon` 看起来像是拼写错误,为了与文档其余部分保持一致,应该为 `Custom`- 修改后的中文句子 `工作目录可设置为**项目根目录**的文件夹` 有点含糊;可以考虑改写为 `工作目录建议设置为项目根目录(或其下的某个子文件夹)`,以更清楚地说明具体应该选择什么。
- 在关于 `interface.json`(assets/install 关联)的中文描述中,结尾的标点和空格有些问题(`...再进行ui中的测试。(或运行 build_and_install.py ,运行方法同上)`);建议统一为更规范的空格与大小写,例如使用 `UI`,并去掉重复的句号。

## Individual Comments

### Comment 1
<location path="docs/zh_cn/developers/development.md" line_range="83" />
<code_context>
   _说人话就是 `resource_fast` 难写的多,每次操作之后下一帧画面可能还是过渡动画,你也要想办法识别。但运行速度也更快,对自己有信心的可以试试。搞不定或者懒得弄就放 `resource` 里,操作慢一点但写起来简单。_

-### 关于秦始皇节点
+### 关于秦始皇节点(可复用节点或 Custon )

 某些具有高可复用性的节点已经予以封装,并撰写了详细文档,以避免重复造轮子。参见:
</code_context>
<issue_to_address>
**issue (typo):** 将标题中的拼写错误 “Custon” 修正为 “Custom”。

把标题文字中的 “Custon” 改为 “Custom”:`(可复用节点或 Custom)````suggestion
### 关于秦始皇节点(可复用节点或 Custom )
```
</issue_to_address>

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

Hey - I've found 1 issue, and left some high level feedback:

  • In the Chinese doc section title ### 关于秦始皇节点(可复用节点或 Custon ), Custon looks like a typo and should likely be Custom to stay consistent with the rest of the docs.
  • The revised Chinese sentence 工作目录可设置为**项目根目录**的文件夹 is a bit ambiguous; consider rephrasing to something like 工作目录建议设置为项目根目录(或其下的某个子文件夹) to make it clearer what exactly should be selected.
  • In the Chinese description of interface.json (assets/install linkage), the ending punctuation and spacing are slightly off (...再进行ui中的测试。(或运行 build_and_install.py ,运行方法同上)); consider normalizing to standard spacing and casing, e.g. UI and removing the duplicated full stop.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In the Chinese doc section title `### 关于秦始皇节点(可复用节点或 Custon )`, `Custon` looks like a typo and should likely be `Custom` to stay consistent with the rest of the docs.
- The revised Chinese sentence `工作目录可设置为**项目根目录**的文件夹` is a bit ambiguous; consider rephrasing to something like `工作目录建议设置为项目根目录(或其下的某个子文件夹)` to make it clearer what exactly should be selected.
- In the Chinese description of `interface.json` (assets/install linkage), the ending punctuation and spacing are slightly off (`...再进行ui中的测试。(或运行 build_and_install.py ,运行方法同上)`); consider normalizing to standard spacing and casing, e.g. `UI` and removing the duplicated full stop.

## Individual Comments

### Comment 1
<location path="docs/zh_cn/developers/development.md" line_range="83" />
<code_context>
   _说人话就是 `resource_fast` 难写的多,每次操作之后下一帧画面可能还是过渡动画,你也要想办法识别。但运行速度也更快,对自己有信心的可以试试。搞不定或者懒得弄就放 `resource` 里,操作慢一点但写起来简单。_

-### 关于秦始皇节点
+### 关于秦始皇节点(可复用节点或 Custon )

 某些具有高可复用性的节点已经予以封装,并撰写了详细文档,以避免重复造轮子。参见:
</code_context>
<issue_to_address>
**issue (typo):** Fix the typo “Custon” to “Custom” in the heading.

Update the heading text to use “Custom” instead of “Custon”: `(可复用节点或 Custom)`.

```suggestion
### 关于秦始皇节点(可复用节点或 Custom )
```
</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.

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@MistEO
Copy link
Contributor

MistEO commented Mar 7, 2026

题外话,能不能详细说说怎么用 vscode 调试 go,带点截图一步步教一下。感觉大伙都在古法 print 调试,太难受了()

@MistEO MistEO merged commit f4fc142 into MaaEnd:main Mar 7, 2026
1 check passed
@ocsin1 ocsin1 deleted the docs/development branch March 7, 2026 16:26
@ocsin1
Copy link
Contributor Author

ocsin1 commented Mar 7, 2026

题外话,能不能详细说说怎么用 vscode 调试 go,带点截图一步步教一下。感觉大伙都在古法 print 调试,太难受了()

我也不会用,我都是把所有日志提到err在控制台看(

@MistEO
Copy link
Contributor

MistEO commented Mar 7, 2026

看来得我亲自出马.jpg

MistEO pushed a commit that referenced this pull request Mar 9, 2026
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
MistEO pushed a commit that referenced this pull request Mar 9, 2026
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
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