Skip to content

docs: apply STE principles to Chinese developer documentation - #200

Merged
chamsechan merged 1 commit into
mainfrom
docs/ste-chinese-developer-guides
Oct 15, 2026
Merged

chamsechan merged 1 commit into
mainfrom
docs/ste-chinese-developer-guides

Conversation

@chamsechan

@chamsechan chamsechan commented Oct 15, 2026 •

Copy link
Copy Markdown
Owner

开发者文档中的长句、复合操作和不一致术语增加了理解成本。本次基于 main 的 4b3d08d,按 ASD-STE100 Issue 9 可用于中文的写作原则改写 24 份文档:统一术语,明确执行者,拆分操作,先说明条件,再给出动作和预期结果。

覆盖 README、编排与 Recipe、Node/Control/Adapter 教程、模型与构建、架构、SDK 生命周期和测试说明。删除历史过程描述和重复说明,总文字量由 156,436 字符减至 155,070 字符。90 个代码与图示代码块、全部标题锚点保持一致;未修改生产代码、命令或配置值。

ASD-STE100 面向英语。本次是写作原则的中文适配,不宣称中文符合其英语受控词表或英语词数限制。依据:ASD-STE100 官方说明。适用范围写入文档目录。

验证:相对链接与跨文件锚点检查通过;代码块和标题与基线逐项比较一致。本地完整门禁 431 项通过,3 项可选真实模型/分词器资产测试跳过。远端 PR CI 正在运行。本次仅推送分支并创建 PR,不合并 main。

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-15T06:07:31.112715Z 5f5c9fa PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chamsechan
chamsechan force-pushed the docs/ste-chinese-developer-guides branch from 5f5c9fa to 672947c Compare October 15, 2026 08:06
@chamsechan
chamsechan merged commit 40c37d8 into main Oct 15, 2026
6 checks passed
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.

1 participant