Skip to content

Add CSM module interface docs for Engine, ExecutionView, and App#14

Merged
nevstop merged 7 commits intomainfrom
copilot/add-csm-module-api-documentation
Apr 7, 2026
Merged

Add CSM module interface docs for Engine, ExecutionView, and App#14
nevstop merged 7 commits intomainfrom
copilot/add-csm-module-api-documentation

Conversation

Copy link
Copy Markdown

Copilot AI commented Apr 7, 2026

按照 CSM-Module-Repo-Template 规范,为 CSMScript-Lite 的三个 CSM 模块补充接口文档。

新增文档 (docs/)

  • Engine(CSM).md — 核心脚本执行引擎

    • 消息接口:TS: Load SequenceTS: Unload SequenceTS: SinglePassTS: Terminate
    • 广播:SequenceLoaded/Unloaded/Started/Completed EventStepStart/StepComplete EventError Occurred
  • ExecutionView(CSM).md — UI 显示模块

    • 消息接口:TS: Link to EngineTS: Load SequenceUI: Front Panel StateUI: Cursor Set
    • 通过 TS: Link to Engine 自动订阅引擎广播,内部处理器无需外部调用
  • App.md — 顶层应用模块(整合 Engine + ExecutionView)

    • 消息接口:API: Load Script FileAPI: Unload Sequence FileAPI: InformationAPI: SettingsUI: Front Panel State

更新

  • README.md / README(zh-cn).md:模块名称增加指向对应文档的链接

@nevstop
Copy link
Copy Markdown
Contributor

nevstop commented Apr 7, 2026

@copilot template 及要求发生了修改,根据修改,更新创建的接口文档
https://github.com/NEVSTOP-LAB/CSM-Module-Repo-Template

Copy link
Copy Markdown
Author

Copilot AI commented Apr 7, 2026

@copilot template 及要求发生了修改,根据修改,更新创建的接口文档
https://github.com/NEVSTOP-LAB/CSM-Module-Repo-Template

已按照最新模板更新三份接口文档(commit 16edcc3):

  1. "调用限制与注意事项":从 - [ ] 复选框列表改为 > [!IMPORTANT] callout 格式
  2. 新增"参数类型说明"表格:在三份文档的 API 接口章节末尾增加了参数类型说明表(APIStringHexStrSafeStrMassData、用户自定义)

模板中新增的"属性接口"和"配置说明"章节,由于这三个模块未暴露可公开访问的属性且无专属 INI 配置项,按模板说明已省略。

Copilot AI requested a review from nevstop April 7, 2026 01:58
@nevstop
Copy link
Copy Markdown
Contributor

nevstop commented Apr 7, 2026

@copilot template 及要求发生了修改,根据修改,更新创建的接口文档
https://github.com/NEVSTOP-LAB/CSM-Module-Repo-Template

…d fix IMPORTANT callout format

Agent-Logs-Url: https://github.com/NEVSTOP-LAB/CSMScript-Lite/sessions/d584daf4-882e-4963-b9c2-6d683319b803

Co-authored-by: nevstop <8196752+nevstop@users.noreply.github.com>
Copy link
Copy Markdown
Author

Copilot AI commented Apr 7, 2026

@copilot template 及要求发生了修改,根据修改,更新创建的接口文档
https://github.com/NEVSTOP-LAB/CSM-Module-Repo-Template

已按最新模板更新三份文档(commit c6db667):

  1. 参数类型说明 表格后增加注意说明> **注意**:接口文档中对 String 类型数据统一使用 APIString 标注(不直接写 SafeStr)...
  2. > [!IMPORTANT] callout 格式修正:在 Engine(CSM).mdApp.md 中补全了 > 后的空行,与模板保持一致

@nevstop nevstop requested a review from Copilot April 7, 2026 06:16
@nevstop nevstop marked this pull request as ready for review April 7, 2026 06:20
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@nevstop nevstop merged commit 9ce9122 into main Apr 7, 2026
5 checks passed
@nevstop nevstop deleted the copilot/add-csm-module-api-documentation branch April 7, 2026 06:47
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.

3 participants