Skip to content

docs: 添加subtask的中英文文档并修改markdownlint以修复map-tracker文档中的警告#1053

Merged
MistEO merged 4 commits intoMaaEnd:mainfrom
ocsin1:docs/subtask
Mar 6, 2026
Merged

docs: 添加subtask的中英文文档并修改markdownlint以修复map-tracker文档中的警告#1053
MistEO merged 4 commits intoMaaEnd:mainfrom
ocsin1:docs/subtask

Conversation

@ocsin1
Copy link
Contributor

@ocsin1 ocsin1 commented Mar 6, 2026

Summary by Sourcery

为 SubTask 自定义动作编写文档,并调整 markdownlint 配置以解决现有的文档警告。

新功能:

  • 添加 SubTask 自定义动作的英文文档,包括参数、行为和使用说明。
  • 添加与英文描述和指导相对应的 SubTask 自定义动作中文文档。

构建:

  • 更新 markdownlint 配置,以解决文档中的现有 lint 警告(例如 map-tracker 文档中的问题)。

文档:

  • 扩展自定义动作开发者文档(中/英),新增一节描述 SubTask 动作及其参数和执行语义。
Original summary in English

Summary by Sourcery

Document the SubTask custom action and adjust markdownlint configuration to address existing documentation warnings.

New Features:

  • Add English documentation for the SubTask custom action including parameters, behavior, and usage notes.
  • Add Chinese documentation for the SubTask custom action mirroring the English description and guidance.

Build:

  • Update markdownlint configuration to resolve existing lint warnings in the documentation (e.g., for the map-tracker docs).

Documentation:

  • Extend the custom action developer docs (EN/ZH) with a new section describing the SubTask action, its parameters, and execution semantics.
Original summary in English

Summary by Sourcery

为 SubTask 自定义动作编写文档,并调整 markdownlint 配置以解决现有的文档警告。

新功能:

  • 添加 SubTask 自定义动作的英文文档,包括参数、行为和使用说明。
  • 添加与英文描述和指导相对应的 SubTask 自定义动作中文文档。

构建:

  • 更新 markdownlint 配置,以解决文档中的现有 lint 警告(例如 map-tracker 文档中的问题)。

文档:

  • 扩展自定义动作开发者文档(中/英),新增一节描述 SubTask 动作及其参数和执行语义。
Original summary in English

Summary by Sourcery

Document the SubTask custom action and adjust markdownlint configuration to address existing documentation warnings.

New Features:

  • Add English documentation for the SubTask custom action including parameters, behavior, and usage notes.
  • Add Chinese documentation for the SubTask custom action mirroring the English description and guidance.

Build:

  • Update markdownlint configuration to resolve existing lint warnings in the documentation (e.g., for the map-tracker docs).

Documentation:

  • Extend the custom action developer docs (EN/ZH) with a new section describing the SubTask action, its parameters, and execution semantics.

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.

Hey - 我发现了 1 个问题,并留下了一些整体层面的反馈:

  • 建议将章节标题 ## subtask Action / ## subtask 动作 改名,使其大小写与类型名(SubTask)保持一致,从而与其余术语更一致。
  • 建议明确说明当同时设置 continue: truestrict: true 时的组合行为(即:所有子任务都会执行,但如果任一子任务失败,整个动作仍然会失败),这样用户就不需要靠自己推断。
提供给 AI Agent 的提示词
Please address the comments from this code review:

## Overall Comments
- Consider renaming the section headers from `## subtask Action` / `## subtask 动作` to use the same casing as the type (`SubTask`) for consistency with the rest of the terminology.
- It might help to explicitly describe the combined behavior when `continue: true` and `strict: true` are both set (i.e., all subtasks run but the overall action still fails if any subtask fails) so users don’t have to infer it.

## Individual Comments

### Comment 1
<location path="docs/zh_cn/developers/custom-action.md" line_range="22" />
<code_context>
+
+## subtask 动作
+
+`SubTask` 是一个通过 `Custom` 调用的子任务执行动作,实现位于 `agent/go-service/subtask`  
+按顺序执行 `custom_action_param``sub` 字段指定的任务名。
+
</code_context>
<issue_to_address>
**nitpick (typo):** 建议在这个句子末尾加一个句号,以保证标点正确。

这段描述在中文里是一个完整句子,因此应以“。”结尾,以符合标准标点用法,并与英文版本的句号对应。

Suggested implementation:

```
- 按顺序执行多个任务如 `SubTask` 动作。

```

```
- 按顺序执行多个任务如 `SubTask` 动作。

```
</issue_to_address>

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

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

  • Consider renaming the section headers from ## subtask Action / ## subtask 动作 to use the same casing as the type (SubTask) for consistency with the rest of the terminology.
  • It might help to explicitly describe the combined behavior when continue: true and strict: true are both set (i.e., all subtasks run but the overall action still fails if any subtask fails) so users don’t have to infer it.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Consider renaming the section headers from `## subtask Action` / `## subtask 动作` to use the same casing as the type (`SubTask`) for consistency with the rest of the terminology.
- It might help to explicitly describe the combined behavior when `continue: true` and `strict: true` are both set (i.e., all subtasks run but the overall action still fails if any subtask fails) so users don’t have to infer it.

## Individual Comments

### Comment 1
<location path="docs/zh_cn/developers/custom-action.md" line_range="22" />
<code_context>
+
+## subtask 动作
+
+`SubTask` 是一个通过 `Custom` 调用的子任务执行动作,实现位于 `agent/go-service/subtask`  
+按顺序执行 `custom_action_param``sub` 字段指定的任务名。
+
</code_context>
<issue_to_address>
**nitpick (typo):** Consider adding a full stop at the end of this sentence for proper punctuation.

This description is a complete sentence in Chinese, so it should end with a “。” to match standard punctuation and the English version’s period.

Suggested implementation:

```
- 按顺序执行多个任务如 `SubTask` 动作。

```

```
- 按顺序执行多个任务如 `SubTask` 动作。

```
</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.

@ocsin1 ocsin1 marked this pull request as draft March 6, 2026 15:33
@ocsin1 ocsin1 marked this pull request as ready for review March 6, 2026 15:38
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.

Hey - 我在这里给了一些总体性的反馈:

  • 在英文和中文两个部分中,建议显式说明当同时使用 continuestrict 时的行为(例如 continue: true 搭配 strict: truestrict: false 的区别),这样可以让用户更清楚地理解在这些组合下是如何判定整体成功/失败的。
给 AI Agent 的提示词
Please address the comments from this code review:

## Overall Comments
- In both the English and Chinese sections, it might help to explicitly describe the behavior when `continue` and `strict` are used together (e.g., `continue: true` and `strict: true` vs `strict: false`) so users clearly understand how overall success/failure is determined in those combinations.

Sourcery 对开源项目是免费的——如果你喜欢我们的代码审查,请考虑帮忙分享 ✨
帮我变得更有用!请在每条评论上点 👍 或 👎,我会根据你的反馈来改进后续的代码审查。
Original comment in English

Hey - I've left some high level feedback:

  • In both the English and Chinese sections, it might help to explicitly describe the behavior when continue and strict are used together (e.g., continue: true and strict: true vs strict: false) so users clearly understand how overall success/failure is determined in those combinations.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In both the English and Chinese sections, it might help to explicitly describe the behavior when `continue` and `strict` are used together (e.g., `continue: true` and `strict: true` vs `strict: false`) so users clearly understand how overall success/failure is determined in those combinations.

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.

@MistEO MistEO merged commit 4b2095f into MaaEnd:main Mar 6, 2026
1 check passed
@ocsin1 ocsin1 deleted the docs/subtask branch March 7, 2026 01:42
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