@aigne/doc-smith 0.8.3 → 0.8.5

package/docs/changelog.zh.md

@@ -1,34 +1,71 @@
----
-labels: ["Reference"]
----
-
 # 更新日志
 
-项目每个版本所有重要变更、功能和错误修复的详细日志。
+项目每个版本的所有重要变更、功能和错误修复的详细日志。
+
+## [0.8.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.1...v0.8.2) (2025-09-04)
+
+
+### 其他杂项
+
+* 发布 0.8.2 ([849bc69](https://github.com/AIGNE-io/aigne-doc-smith/commit/849bc694edf167187f65cb34f1dd9a3966efd96c))
+
+## [0.8.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.0...v0.8.1) (2025-09-03)
+
+
+### 功能
+
+* 通过综合示例调整 d2 图表生成 ([#80](https://github.com/AIGNE-io/aigne-doc-smith/issues/80)) ([3423e4c](https://github.com/AIGNE-io/aigne-doc-smith/commit/3423e4cff24335552503916694a3489e5d91bf6c))
+
+
+### 其他杂项
+
+* 发布 0.8.1 ([21f64d4](https://github.com/AIGNE-io/aigne-doc-smith/commit/21f64d450377b1aef00f12613ba3b87aa4ef1d31))
+
+## [0.8.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.7.2...v0.8.0) (2025-09-03)
+
+
+### 功能
+
+* **测试：**添加全面的工作流测试覆盖率 ([#76](https://github.com/AIGNE-io/aigne-doc-smith/issues/76)) ([d5f6062](https://github.com/AIGNE-io/aigne-doc-smith/commit/d5f6062311f36dc5b6394ae0768583fb8f3853a4))
+* 更新自定义组件指南，增加格式限制 ([#79](https://github.com/AIGNE-io/aigne-doc-smith/issues/79)) ([76158de](https://github.com/AIGNE-io/aigne-doc-smith/commit/76158de236696e68c63c057f5ea4b8458a15e787))
+
+## [0.7.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.7.1...v0.7.2) (2025-09-01)
+
+
+### 其他杂项
+
+* 发布 0.7.2 ([c3be232](https://github.com/AIGNE-io/aigne-doc-smith/commit/c3be2323e885cf5d11d654629fe30cc3720f79d3))
+
+## [0.7.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.7.0...v0.7.1) (2025-08-31)
+
+
+### 错误修复
+
+* 修复 Tab 键路径选择错误 ([#72](https://github.com/AIGNE-io/aigne-doc-smith/issues/72)) ([369b342](https://github.com/AIGNE-io/aigne-doc-smith/commit/369b342d8ab8ce95b61a3b72e367157d2f71cce4))
 
 ## [0.7.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.6.0...v0.7.0) (2025-08-30)
 
 
 ### 功能
 
-* 新增聊天模式支持 ([#60](https://github.com/AIGNE-io/aigne-doc-smith/issues/60)) ([9b2ce50](https://github.com/AIGNE-io/aigne-doc-smith/commit/9b2ce50014d1894a4e41bf043e699fdc4f1d74b7))
-* 支持自定义组件和更稳健的配置处理 ([#70](https://github.com/AIGNE-io/aigne-doc-smith/issues/70)) ([727ab42](https://github.com/AIGNE-io/aigne-doc-smith/commit/727ab429b00f924ef605530b35d2a12b4be77e3a))
+* 增加聊天模式支持 ([#60](https://github.com/AIGNE-io/aigne-doc-smith/issues/60)) ([9b2ce50](https://github.com/AIGNE-io/aigne-doc-smith/commit/9b2ce50014d1894a4e41bf043e699fdc4f1d74b7))
+* 支持自定义组件和更强大的配置处理 ([#70](https://github.com/AIGNE-io/aigne-doc-smith/issues/70)) ([727ab42](https://github.com/AIGNE-io/aigne-doc-smith/commit/727ab429b00f924ef605530b35d2a12b4be77e3a))
 * 在文档生成和发布工作流中支持 d2 图表 ([#69](https://github.com/AIGNE-io/aigne-doc-smith/issues/69)) ([bf95889](https://github.com/AIGNE-io/aigne-doc-smith/commit/bf958891516973636c4847b084c6fe75d1ea124b))
-* 支持多用途文档规划与生成 ([#68](https://github.com/AIGNE-io/aigne-doc-smith/issues/68)) ([44152c5](https://github.com/AIGNE-io/aigne-doc-smith/commit/44152c53b7e8f82e3af1245a1affd77b9817486d))
+* 支持多用途文档规划和生成 ([#68](https://github.com/AIGNE-io/aigne-doc-smith/issues/68)) ([44152c5](https://github.com/AIGNE-io/aigne-doc-smith/commit/44152c53b7e8f82e3af1245a1affd77b9817486d))
 
 ## [0.6.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.5.1...v0.6.0) (2025-08-27)
 
 
 ### 功能
 
-* 在发布前全面支持媒体处理 ([#63](https://github.com/AIGNE-io/aigne-doc-smith/issues/63)) ([5257ca1](https://github.com/AIGNE-io/aigne-doc-smith/commit/5257ca1756f47487b65a1813949e547b6fc51aca))
+* 完成发布前媒体处理的全面支持 ([#63](https://github.com/AIGNE-io/aigne-doc-smith/issues/63)) ([5257ca1](https://github.com/AIGNE-io/aigne-doc-smith/commit/5257ca1756f47487b65a1813949e547b6fc51aca))
 
 ## [0.5.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.5.0...v0.5.1) (2025-08-26)
 
 
 ### 其他杂项
 
-* 发布 0.5.1 版本 ([892d96e](https://github.com/AIGNE-io/aigne-doc-smith/commit/892d96e939a6404a42e8d2521f95bb7acfeabe27))
+* 发布 0.5.1 ([892d96e](https://github.com/AIGNE-io/aigne-doc-smith/commit/892d96e939a6404a42e8d2521f95bb7acfeabe27))
 
 ## [0.5.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.4.5...v0.5.0) (2025-08-26)
 
@@ -40,14 +77,14 @@ labels: ["Reference"]
 
 ### 错误修复
 
-* 优化初始化问题的文案 ([#65](https://github.com/AIGNE-io/aigne-doc-smith/issues/65)) ([d4e8762](https://github.com/AIGNE-io/aigne-doc-smith/commit/d4e8762f26fd757bde43427860a0c1dade384269))
+* 优化初始问题文案 ([#65](https://github.com/AIGNE-io/aigne-doc-smith/issues/65)) ([d4e8762](https://github.com/AIGNE-io/aigne-doc-smith/commit/d4e8762f26fd757bde43427860a0c1dade384269))
 
 ## [0.4.5](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.4.4...v0.4.5) (2025-08-25)
 
 
 ### 其他杂项
 
-* 发布 0.4.5 版本 ([12aa6c3](https://github.com/AIGNE-io/aigne-doc-smith/commit/12aa6c340fdd95cbd74833662f4c3a80f19dfa30))
+* 发布 0.4.5 ([12aa6c3](https://github.com/AIGNE-io/aigne-doc-smith/commit/12aa6c340fdd95cbd74833662f4c3a80f19dfa30))
 
 ## [0.4.4](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.4.3...v0.4.4) (2025-08-22)
 
@@ -61,14 +98,14 @@ labels: ["Reference"]
 
 ### 其他杂项
 
-* 发布 0.4.3 版本 ([f37ac7c](https://github.com/AIGNE-io/aigne-doc-smith/commit/f37ac7cd1fd129d8e3019cc7e952a0cf7dcb3db7))
+* 发布 0.4.3 ([f37ac7c](https://github.com/AIGNE-io/aigne-doc-smith/commit/f37ac7cd1fd129d8e3019cc7e952a0cf7dcb3db7))
 
 ## [0.4.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.4.1...v0.4.2) (2025-08-21)
 
 
 ### 其他杂项
 
-* 发布 0.4.2 版本 ([9e36cf6](https://github.com/AIGNE-io/aigne-doc-smith/commit/9e36cf678ac51a0f4e7b3c19e4b5248e42b80437))
+* 发布 0.4.2 ([9e36cf6](https://github.com/AIGNE-io/aigne-doc-smith/commit/9e36cf678ac51a0f4e7b3c19e4b5248e42b80437))
 
 ## [0.4.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.4.0...v0.4.1) (2025-08-21)
 
@@ -89,14 +126,14 @@ labels: ["Reference"]
 
 ### 错误修复
 
-* 优化加载源的模式 ([#48](https://github.com/AIGNE-io/aigne-doc-smith/issues/48)) ([5f83b91](https://github.com/AIGNE-io/aigne-doc-smith/commit/5f83b917ea6779ba79418e3ff2490eb692c3e48a))
+* 优化加载源模式 ([#48](https://github.com/AIGNE-io/aigne-doc-smith/issues/48)) ([5f83b91](https://github.com/AIGNE-io/aigne-doc-smith/commit/5f83b917ea6779ba79418e3ff2490eb692c3e48a))
 
 ## [0.3.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.11...v0.3.0) (2025-08-19)
 
 
 ### 功能
 
-* **core:** 优化生成上下文收集工作流 ([#46](https://github.com/AIGNE-io/aigne-doc-smith/issues/46)) ([687d06a](https://github.com/AIGNE-io/aigne-doc-smith/commit/687d06afd648e0e697d25e85dcc841b17c3c311c))
+* **核心：**优化生成上下文收集工作流 ([#46](https://github.com/AIGNE-io/aigne-doc-smith/issues/46)) ([687d06a](https://github.com/AIGNE-io/aigne-doc-smith/commit/687d06afd648e0e697d25e85dcc841b17c3c311c))
 
 
 ### 错误修复
@@ -129,7 +166,7 @@ labels: ["Reference"]
 
 ### 其他杂项
 
-* 发布 0.2.8 版本 ([da19bc0](https://github.com/AIGNE-io/aigne-doc-smith/commit/da19bc0b2c6c4e5fddaff84b4fa85c9d495b3ba0))
+* 发布 0.2.8 ([da19bc0](https://github.com/AIGNE-io/aigne-doc-smith/commit/da19bc0b2c6c4e5fddaff84b4fa85c9d495b3ba0))
 
 ## [0.2.7](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.6...v0.2.7) (2025-08-12)
 
@@ -141,28 +178,28 @@ labels: ["Reference"]
 
 ### 其他杂项
 
-* 发布 0.2.7 版本 ([3b807fe](https://github.com/AIGNE-io/aigne-doc-smith/commit/3b807fed833a5160931747bce37aac00cf11d9ac))
+* 发布 0.2.7 ([3b807fe](https://github.com/AIGNE-io/aigne-doc-smith/commit/3b807fed833a5160931747bce37aac00cf11d9ac))
 
 ## [0.2.6](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.5...v0.2.6) (2025-08-12)
 
 
 ### 其他杂项
 
-* 发布 0.2.6 版本 ([c5b5ea5](https://github.com/AIGNE-io/aigne-doc-smith/commit/c5b5ea5c404d44f3b0d420f0b57e4ae64ae5d624))
+* 发布 0.2.6 ([c5b5ea5](https://github.com/AIGNE-io/aigne-doc-smith/commit/c5b5ea5c404d44f3b0d420f0b57e4ae64ae5d624))
 
 ## [0.2.5](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.4...v0.2.5) (2025-08-08)
 
 
 ### 错误修复
 
-* 优化 cli 流程 ([#17](https://github.com/AIGNE-io/aigne-doc-smith/issues/17)) ([4c94263](https://github.com/AIGNE-io/aigne-doc-smith/commit/4c9426378dff9ca3270bd0e455aa6fb1045f6abb))
+* 优化 CLI 流程 ([#17](https://github.com/AIGNE-io/aigne-doc-smith/issues/17)) ([4c94263](https://github.com/AIGNE-io/aigne-doc-smith/commit/4c9426378dff9ca3270bd0e455aa6fb1045f6abb))
 
 ## [0.2.4](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.3...v0.2.4) (2025-08-07)
 
 
 ### 错误修复
 
-* 优化 agent 输出日志 ([40a2451](https://github.com/AIGNE-io/aigne-doc-smith/commit/40a245122ce4d8747e5b5dbe88be6986047c38ae))
+* 优化 Agent 输出日志 ([40a2451](https://github.com/AIGNE-io/aigne-doc-smith/commit/40a245122ce4d8747e5b5dbe88be6986047c38ae))
 
 ## [0.2.3](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.2...v0.2.3) (2025-08-07)
 
@@ -176,21 +213,21 @@ labels: ["Reference"]
 
 ### 其他杂项
 
-* 发布 0.2.2 版本 ([c3fb52a](https://github.com/AIGNE-io/aigne-doc-smith/commit/c3fb52a78b95676e1c13361b30ebec2914a89fa8))
+* 发布 0.2.2 ([c3fb52a](https://github.com/AIGNE-io/aigne-doc-smith/commit/c3fb52a78b95676e1c13361b30ebec2914a89fa8))
 
 ## [0.2.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.0...v0.2.1) (2025-08-06)
 
 
 ### 其他杂项
 
-* 发布 0.2.1 版本 ([e3a39ae](https://github.com/AIGNE-io/aigne-doc-smith/commit/e3a39aedcee129deae424e96942f9798b9191663))
+* 发布 0.2.1 ([e3a39ae](https://github.com/AIGNE-io/aigne-doc-smith/commit/e3a39aedcee129deae424e96942f9798b9191663))
 
 ## [0.2.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.1.4...v0.2.0) (2025-08-05)
 
 
 ### 功能
 
-* 支持调用 agents 时自动初始化配置 ([24d29db](https://github.com/AIGNE-io/aigne-doc-smith/commit/24d29db4dd86709750aa22ff649e7dacc4124126))
+* 支持调用 Agent 时自动初始化配置 ([24d29db](https://github.com/AIGNE-io/aigne-doc-smith/commit/24d29db4dd86709750aa22ff649e7dacc4124126))
 * 源文件变更时更新文档 ([#9](https://github.com/AIGNE-io/aigne-doc-smith/issues/9)) ([4adcecf](https://github.com/AIGNE-io/aigne-doc-smith/commit/4adcecfb32e72c9e88d0b0bd8ce0a91022847ca7))
 
 ## [0.1.4](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.1.3...v0.1.4) (2025-08-04)
@@ -198,14 +235,14 @@ labels: ["Reference"]
 
 ### 其他杂项
 
-* 发布 0.1.4 版本 ([4122cf5](https://github.com/AIGNE-io/aigne-doc-smith/commit/4122cf5cc0285bef2b96803f393e744121d22acf))
+* 发布 0.1.4 ([4122cf5](https://github.com/AIGNE-io/aigne-doc-smith/commit/4122cf5cc0285bef2b96803f393e744121d22acf))
 
 ## [0.1.3](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.1.2...v0.1.3) (2025-08-04)
 
 
 ### 错误修复
 
-* 从 options.context 访问 agents，而不是加载新的 aigne 实例 ([#6](https://github.com/AIGNE-io/aigne-doc-smith/issues/6)) ([0e7ce1d](https://github.com/AIGNE-io/aigne-doc-smith/commit/0e7ce1d3889aab435b029a511cb7ebdbb213ab8a))
+* 从 options.context 访问 Agent，而不是加载新的 AIGNE 实例 ([#6](https://github.com/AIGNE-io/aigne-doc-smith/issues/6)) ([0e7ce1d](https://github.com/AIGNE-io/aigne-doc-smith/commit/0e7ce1d3889aab435b029a511cb7ebdbb213ab8a))
 
 ## [0.1.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.1.1...v0.1.2) (2025-08-01)
 
@@ -219,7 +256,7 @@ labels: ["Reference"]
 
 ### 错误修复
 
-* agent 添加别名 ([7e25014](https://github.com/AIGNE-io/aigne-doc-smith/commit/7e250147309849fe0f4cc554077134d2e443d344))
+* Agent 添加别名 ([7e25014](https://github.com/AIGNE-io/aigne-doc-smith/commit/7e250147309849fe0f4cc554077134d2e443d344))
 * docs mcp 添加文档搜索 ([de96e0e](https://github.com/AIGNE-io/aigne-doc-smith/commit/de96e0e08455831dc6918d5fbc59d38b6a921373))
 * 优化代码 ([8cb0a5c](https://github.com/AIGNE-io/aigne-doc-smith/commit/8cb0a5ce67cf009c672b2fb1aa9b89ef6d965a86))
 
@@ -228,33 +265,33 @@ labels: ["Reference"]
 
 ### 功能
 
-* 为 mcp 服务器和 cli 添加入口 agents ([fa85d65](https://github.com/AIGNE-io/aigne-doc-smith/commit/fa85d651e8dc723e2b97150fc2258b115c6c5bb0))
+* 为 mcp 服务器和 CLI 添加入口 Agent ([fa85d65](https://github.com/AIGNE-io/aigne-doc-smith/commit/fa85d651e8dc723e2b97150fc2258b115c6c5bb0))
 
 
 ### 错误修复
 
 * 优化命令参数 ([#3](https://github.com/AIGNE-io/aigne-doc-smith/issues/3)) ([003f6b8](https://github.com/AIGNE-io/aigne-doc-smith/commit/003f6b8ae2c9e1af55ba1841458fa8567a0eb2f0))
-* 优化 docs mcp agent ([8654cd4](https://github.com/AIGNE-io/aigne-doc-smith/commit/8654cd4ea38034f3af0244f56b27acf66ba704e1))
+* 优化 docs mcp Agent ([8654cd4](https://github.com/AIGNE-io/aigne-doc-smith/commit/8654cd4ea38034f3af0244f56b27acf66ba704e1))
 
 ## 0.0.2 (2025-07-30)
 
 
 ### 功能
 
-* 新增自动创建看板 ([3ff06ad](https://github.com/AIGNE-io/aigne-doc-smith/commit/3ff06ad0241e208b09bcf828c52c2c5051c67ef8))
-* 新增 docs-mcp ([a7508a1](https://github.com/AIGNE-io/aigne-doc-smith/commit/a7508a13abb2222968b1bc9c14948427af509f97))
-* 新增 input generator agent ([20c01bb](https://github.com/AIGNE-io/aigne-doc-smith/commit/20c01bbca6d6f9414695071fc907bd7cf43d7f62))
-* 新增发布文档功能 ([41bb126](https://github.com/AIGNE-io/aigne-doc-smith/commit/41bb126caeb1c3c242c7a2be27abb114aeab9953))
-* 新增对文档标签的支持 ([4522c07](https://github.com/AIGNE-io/aigne-doc-smith/commit/4522c07b1ceb05664a1f5b5fb4df06feee536eba))
-* 详情添加审查功能 ([8f1aa4f](https://github.com/AIGNE-io/aigne-doc-smith/commit/8f1aa4f22e2d2e590d7aa37288c2e1ee7ea48f07))
+* 添加自动创建看板 ([3ff06ad](https://github.com/AIGNE-io/aigne-doc-smith/commit/3ff06ad0241e208b09bcf828c52c2c5051c67ef8))
+* 添加 docs-mcp ([a7508a1](https://github.com/AIGNE-io/aigne-doc-smith/commit/a7508a13abb2222968b1bc9c14948427af509f97))
+* 添加输入生成器 Agent ([20c01bb](https://github.com/AIGNE-io/aigne-doc-smith/commit/20c01bbca6d6f9414695071fc907bd7cf43d7f62))
+* 添加发布文档功能 ([41bb126](https://github.com/AIGNE-io/aigne-doc-smith/commit/41bb126caeb1c3c242c7a2be27abb114aeab9953))
+* 添加对文档标签的支持 ([4522c07](https://github.com/AIGNE-io/aigne-doc-smith/commit/4522c07b1ceb05664a1f5b5fb4df06feee536eba))
+* 详情添加审查 ([8f1aa4f](https://github.com/AIGNE-io/aigne-doc-smith/commit/8f1aa4f22e2d2e590d7aa37288c2e1ee7ea48f07))
 * 初始提交 ([dafc40e](https://github.com/AIGNE-io/aigne-doc-smith/commit/dafc40e94f3c407e50b2c46ecb46237f23a15cf7))
-* 结构规划添加审查功能 ([b56e83e](https://github.com/AIGNE-io/aigne-doc-smith/commit/b56e83e558f509302b422205f30e9b2adb42d452))
+* 结构规划添加审查 ([b56e83e](https://github.com/AIGNE-io/aigne-doc-smith/commit/b56e83e558f509302b422205f30e9b2adb42d452))
 
 
 ### 错误修复
 
-* 优化 agent 名称 ([25875a0](https://github.com/AIGNE-io/aigne-doc-smith/commit/25875a0688ebbca71f6c25bf4bd5246361f3dd2d))
-* 优化 agent 参数和描述 ([290eb24](https://github.com/AIGNE-io/aigne-doc-smith/commit/290eb240ce986b0f1f406bf42824ce1235df11e5))
+* 优化 Agent 名称 ([25875a0](https://github.com/AIGNE-io/aigne-doc-smith/commit/25875a0688ebbca71f6c25bf4bd5246361f3dd2d))
+* 优化 Agent 参数和描述 ([290eb24](https://github.com/AIGNE-io/aigne-doc-smith/commit/290eb240ce986b0f1f406bf42824ce1235df11e5))
 * 优化代码 ([34f9a24](https://github.com/AIGNE-io/aigne-doc-smith/commit/34f9a24fc3748b4177cad2b5330fe6b3ccd99175))
 * 优化代码 ([0343486](https://github.com/AIGNE-io/aigne-doc-smith/commit/0343486aa086bbe2ced8de849de6a4a42567719c))
 * 优化代码 ([7b7dfb9](https://github.com/AIGNE-io/aigne-doc-smith/commit/7b7dfb925b3aa55956ef7a99ededc749fb6a42d7))
@@ -262,11 +299,11 @@ labels: ["Reference"]
 * 优化代码 ([74fee51](https://github.com/AIGNE-io/aigne-doc-smith/commit/74fee51ad6337af8811a35f2a4334b67ec109439))
 * 优化代码 ([7fa1675](https://github.com/AIGNE-io/aigne-doc-smith/commit/7fa1675b2cab6144d1fb9d4388130209c6cfa0bc))
 * 优化文档审查 ([70374ab](https://github.com/AIGNE-io/aigne-doc-smith/commit/70374abed74946eafa7b0f87331c2e496fa61592))
-* 优化 input generator agent ([ae908bb](https://github.com/AIGNE-io/aigne-doc-smith/commit/ae908bbc0cb98b9b196e8b08f23149e5693e0abe))
+* 优化输入生成器 Agent ([ae908bb](https://github.com/AIGNE-io/aigne-doc-smith/commit/ae908bbc0cb98b9b196e8b08f23149e5693e0abe))
 * 优化结构规划 ([3a0a196](https://github.com/AIGNE-io/aigne-doc-smith/commit/3a0a196a97196ba445c4709d3466ff355917ac53))
 * 保存文档时移除无用文档 ([bec5ba3](https://github.com/AIGNE-io/aigne-doc-smith/commit/bec5ba3afd462c990a0aa813bbe38ce9a61363ee))
 
 
 ### 其他杂项
 
-* 发布 0.0.2 版本 ([73bf26a](https://github.com/AIGNE-io/aigne-doc-smith/commit/73bf26a5c55fa4726d866cff64bd48d1ca37a3b3))
+* 发布 0.0.2 ([73bf26a](https://github.com/AIGNE-io/aigne-doc-smith/commit/73bf26a5c55fa4726d866cff64bd48d1ca37a3b3))

package/docs/cli-reference.md

@@ -1,10 +1,6 @@
----
-labels: ["Reference"]
----
-
 # CLI Command Reference
 
-This guide provides a comprehensive reference for all available `aigne doc` sub-commands, their arguments, and options. It's designed for users who want to understand the full capabilities of the command-line interface.
+This guide provides a reference for all available `aigne doc` sub-commands, their arguments, and options. It is intended for users who want to use the command-line interface to its full potential.
 
 The general syntax is:
 
@@ -12,13 +8,82 @@ The general syntax is:
 aigne doc <command> [options]
 ```
 
+### Command Workflow
+
+The following diagram illustrates the typical lifecycle of creating and maintaining documentation with DocSmith's CLI commands:
+
+```d2
+direction: down
+
+Start: {
+  label: "Project Setup"
+  shape: circle
+}
+
+init: {
+  label: "aigne doc init\n(Interactive Setup)"
+  shape: rectangle
+}
+
+generate: {
+  label: "aigne doc generate\n(Create/Update All Docs)"
+  shape: rectangle
+}
+
+refinement-cycle: {
+  label: "Refinement Cycle"
+  shape: rectangle
+  grid-columns: 2
+
+  update: {
+    label: "aigne doc update\n(Refine Single Doc)"
+  }
+  translate: {
+    label: "aigne doc translate\n(Localize Content)"
+  }
+}
+
+publish: {
+  label: "aigne doc publish\n(Deploy Docs)"
+  shape: rectangle
+}
+
+End: {
+  label: "Docs Live"
+  shape: circle
+  style.fill: "#a2eeaf"
+}
+
+prefs: {
+  label: "aigne doc prefs\n(Manage Learned Rules)"
+  shape: cylinder
+}
+
+Start -> init: "Optional" {
+  style.stroke-dash: 4
+}
+init -> generate: "Configure"
+Start -> generate: "Direct"
+generate -> refinement-cycle: "Refine"
+refinement-cycle -> publish: "Ready"
+generate -> publish: "Direct Deploy"
+publish -> End
+
+prefs <-> generate: "Influences" {
+  style.stroke-dash: 2
+}
+prefs <-> refinement-cycle: "Influences" {
+  style.stroke-dash: 2
+}
+```
+
 ---
 
 ## `aigne doc generate`
 
 **Aliases:** `gen`, `g`
 
-Automatically analyzes your source code and generates a complete set of documentation based on your configuration. If no configuration is found, it will automatically launch the interactive setup wizard.
+Analyzes your source code and generates a complete set of documentation based on your configuration. If no configuration is found, it automatically launches the interactive setup wizard.
 
 ### Options
 
@@ -26,7 +91,7 @@ Automatically analyzes your source code and generates a complete set of document
 |---|---|---|
 | `--feedback` | string | Provides feedback to adjust and refine the overall document structure plan. |
 | `--forceRegenerate` | boolean | Discards existing content and regenerates all documentation from scratch. |
-| `--model` | string | Specifies a particular LLM to use for generation (e.g., `openai:gpt-4o`, `claude:claude-3-5-sonnet`). Overrides the default model. |
+| `--model` | string | Specifies a particular LLM to use for generation (e.g., `openai:gpt-4o`). Overrides the default model. |
 | `--glossary` | string | Path to a glossary file for consistent terminology. Use the format `@path/to/glossary.md`. |
 
 ### Usage Examples
@@ -63,9 +128,10 @@ Optimizes and regenerates specific documents. You can run it interactively to se
 
 | Option | Type | Description |
 |---|---|---|
-| `--docs` | array | A list of document paths to regenerate (e.g., `--docs overview.md --docs /features/authentication.md`). |
+| `--docs` | array | A list of document paths to regenerate (e.g., `--docs overview.md`). Can be used multiple times. |
 | `--feedback` | string | Provides specific feedback to improve the content of the selected document(s). |
 | `--glossary` | string | Path to a glossary file for consistent terminology. Use the format `@path/to/glossary.md`. |
+| `--reset` | boolean | Ignores previous results and regenerates content from scratch for the selected documents. |
 
 ### Usage Examples
 
@@ -76,7 +142,7 @@ aigne doc update
 
 **Update a specific document with targeted feedback:**
 ```bash
-aigne doc update --docs /cli-reference.md --feedback "Clarify the difference between the --docs and --langs options."
+aigne doc update --docs /cli-reference --feedback "Clarify the difference between the --docs and --langs options."
 ```
 
 ---
@@ -89,8 +155,8 @@ Translates existing documentation into one or more languages. It can be run inte
 
 | Option | Type | Description |
 |---|---|---|
-| `--docs` | array | A list of document paths to translate. If omitted in interactive mode, you can select them. |
-| `--langs` | array | A list of target language codes (e.g., `zh`, `ja`, `es`). If omitted, you can select them interactively. |
+| `--docs` | array | A list of document paths to translate. Can be used multiple times. |
+| `--langs` | array | A list of target language codes (e.g., `zh`, `ja`, `es`). Can be used multiple times. |
 | `--feedback` | string | Provides feedback to improve the quality of the translation. |
 | `--glossary` | string | Path to a glossary file to ensure consistent terminology across languages. Use `@path/to/glossary.md`. |
 
@@ -123,7 +189,7 @@ Publishes your generated documentation to a Discuss Kit platform. You can publis
 
 | Option | Type | Description |
 |---|---|---|
-| `--appUrl` | string | The URL of your self-hosted Discuss Kit instance. If not provided, the command runs interactively, allowing you to choose between the official platform and a custom URL. |
+| `--appUrl` | string | The URL of your self-hosted Discuss Kit instance. If not provided, the command runs interactively. |
 
 ### Usage Examples
 
@@ -163,7 +229,7 @@ Manages user preferences that DocSmith learns from your feedback over time. Thes
 | `--list` | boolean | Lists all saved preferences, showing their status (active/inactive), scope, and content. |
 | `--remove` | boolean | Removes one or more preferences. Runs interactively if `--id` is not provided. |
 | `--toggle` | boolean | Toggles the active status of one or more preferences. Runs interactively if `--id` is not provided. |
-| `--id` | array | Specifies the preference ID(s) to act upon for `--remove` or `--toggle`. |
+| `--id` | array | Specifies the preference ID(s) to act upon for `--remove` or `--toggle`. Can be used multiple times. |
 
 ### Usage Examples
 

package/docs/cli-reference.zh.md

@@ -1,10 +1,6 @@
----
-labels: ["Reference"]
----
-
 # CLI 命令参考
 
-本指南为所有可用的 `aigne doc` 子命令及其参数和选项提供了全面的参考。它专为希望了解命令行界面全部功能的用户设计。
+本指南为所有可用的 `aigne doc` 子命令及其参数和选项提供了参考。旨在帮助用户充分利用命令行界面。
 
 通用语法如下：
 
@@ -12,21 +8,90 @@ labels: ["Reference"]
 aigne doc <command> [options]
 ```
 
+### 命令工作流
+
+下图展示了使用 DocSmith 的 CLI 命令创建和维护文档的典型生命周期：
+
+```d2
+direction: down
+
+Start: {
+  label: "项目设置"
+  shape: circle
+}
+
+init: {
+  label: "aigne doc init\n(交互式设置)"
+  shape: rectangle
+}
+
+generate: {
+  label: "aigne doc generate\n(创建/更新所有文档)"
+  shape: rectangle
+}
+
+refinement-cycle: {
+  label: "优化周期"
+  shape: rectangle
+  grid-columns: 2
+
+  update: {
+    label: "aigne doc update\n(优化单个文档)"
+  }
+  translate: {
+    label: "aigne doc translate\n(本地化内容)"
+  }
+}
+
+publish: {
+  label: "aigne doc publish\n(部署文档)"
+  shape: rectangle
+}
+
+End: {
+  label: "文档上线"
+  shape: circle
+  style.fill: "#a2eeaf"
+}
+
+prefs: {
+  label: "aigne doc prefs\n(管理学习到的规则)"
+  shape: cylinder
+}
+
+Start -> init: "可选" {
+  style.stroke-dash: 4
+}
+init -> generate: "配置"
+Start -> generate: "直接"
+generate -> refinement-cycle: "优化"
+refinement-cycle -> publish: "就绪"
+generate -> publish: "直接部署"
+publish -> End
+
+prefs <-> generate: "影响" {
+  style.stroke-dash: 2
+}
+prefs <-> refinement-cycle: "影响" {
+  style.stroke-dash: 2
+}
+```
+
 ---
 
 ## `aigne doc generate`
 
 **别名：** `gen`, `g`
 
-自动分析您的源代码，并根据您的配置生成一整套文档。如果未找到配置，它将自动启动交互式设置向导。
+分析您的源代码，并根据您的配置生成一套完整的文档。如果未找到配置，它将自动启动交互式设置向导。
 
 ### 选项
 
-| 选项 | 类型 | 描述 |
+| Option | Type | Description |
 |---|---|---|
 | `--feedback` | string | 提供反馈以调整和优化整体文档结构规划。 |
-| `--forceRegenerate` | boolean | 丢弃现有内容并从头开始重新生成所有文档。 |
-| `--model` | string | 指定用于生成的特定 LLM（例如，`openai:gpt-4o`、`claude:claude-3-5-sonnet`）。这将覆盖默认模型。 |
+| `--forceRegenerate` | boolean | 丢弃现有内容，从头开始重新生成所有文档。 |
+| `--model` | string | 指定用于生成的特定 LLM（例如，`openai:gpt-4o`）。此选项将覆盖默认模型。 |
 | `--glossary` | string | 用于保持术语一致性的术语表文件路径。使用 `@path/to/glossary.md` 格式。 |
 
 ### 使用示例
@@ -57,15 +122,16 @@ aigne doc generate --model google:gemini-1.5-flash
 
 **别名：** `up`
 
-优化并重新生成特定文档。您可以以交互方式运行它来选择文档，或直接使用选项指定文档。这对于根据反馈进行有针对性的改进非常有用，而无需重新生成整个项目。
+优化并重新生成特定文档。您可以以交互方式运行以选择文档，或直接使用选项指定文档。此命令对于根据反馈进行有针对性的改进非常有用，无需重新生成整个项目。
 
 ### 选项
 
-| 选项 | 类型 | 描述 |
+| Option | Type | Description |
 |---|---|---|
-| `--docs` | array | 要重新生成的文档路径列表（例如，`--docs overview.md --docs /features/authentication.md`）。 |
+| `--docs` | array | 要重新生成的文档路径列表（例如，`--docs overview.md`）。可多次使用。 |
 | `--feedback` | string | 提供具体反馈以改进所选文档的内容。 |
 | `--glossary` | string | 用于保持术语一致性的术语表文件路径。使用 `@path/to/glossary.md` 格式。 |
+| `--reset` | boolean | 忽略之前的结果，为所选文档从头开始重新生成内容。 |
 
 ### 使用示例
 
@@ -74,23 +140,23 @@ aigne doc generate --model google:gemini-1.5-flash
 aigne doc update
 ```
 
-**使用有针对性的反馈更新特定文档：**
+**使用针对性反馈更新特定文档：**
 ```bash
-aigne doc update --docs /cli-reference.md --feedback "阐明 --docs 和 --langs 选项之间的区别。"
+aigne doc update --docs /cli-reference --feedback "阐明 --docs 和 --langs 选项之间的区别。"
 ```
 
 ---
 
 ## `aigne doc translate`
 
-将现有文档翻译成一种或多种语言。可以以交互方式运行以选择文档和语言，也可以通过将它们指定为参数以非交互方式运行。
+将现有文档翻译成一种或多种语言。可以以交互方式运行以选择文档和语言，也可以通过参数指定以非交互方式运行。
 
 ### 选项
 
-| 选项 | 类型 | 描述 |
+| Option | Type | Description |
 |---|---|---|
-| `--docs` | array | 要翻译的文档路径列表。如果在交互模式下省略，您可以进行选择。 |
-| `--langs` | array | 目标语言代码列表（例如，`zh`、`ja`、`es`）。如果省略，您可以以交互方式选择它们。 |
+| `--docs` | array | 要翻译的文档路径列表。可多次使用。 |
+| `--langs` | array | 目标语言代码列表（例如，`zh`、`ja`、`es`）。可多次使用。 |
 | `--feedback` | string | 提供反馈以提高翻译质量。 |
 | `--glossary` | string | 用于确保跨语言术语一致性的术语表文件路径。使用 `@path/to/glossary.md`。 |
 
@@ -117,13 +183,13 @@ aigne doc translate --glossary @glossary.md --feedback "日语翻译请使用正
 
 **别名：** `pub`, `p`
 
-将您生成的文档发布到 Discuss Kit 平台。您可以发布到官方的 AIGNE DocSmith 平台，也可以发布到您自己自托管的实例。
+将您生成的文档发布到 Discuss Kit 平台。您可以发布到官方的 AIGNE DocSmith 平台，也可以发布到您自己托管的实例。
 
 ### 选项
 
-| 选项 | 类型 | 描述 |
+| Option | Type | Description |
 |---|---|---|
-| `--appUrl` | string | 您自托管的 Discuss Kit 实例的 URL。如果未提供，该命令将以交互方式运行，允许您在官方平台和自定义 URL 之间进行选择。 |
+| `--appUrl` | string | 您自托管的 Discuss Kit 实例的 URL。如果未提供，该命令将以交互方式运行。 |
 
 ### 使用示例
 
@@ -141,7 +207,7 @@ aigne doc publish --appUrl https://docs.my-company.com
 
 ## `aigne doc init`
 
-手动启动交互式配置向导。这对于设置新项目或修改现有项目的配置非常有用。该向导会引导您定义源代码路径、设置输出目录、选择语言以及定义文档的风格和目标受众。
+手动启动交互式配置向导。这对于设置新项目或修改现有项目的配置非常有用。该向导将引导您定义源代码路径、设置输出目录、选择语言以及定义文档的风格和目标受众。
 
 ### 使用示例
 
@@ -154,16 +220,16 @@ aigne doc init
 
 ## `aigne doc prefs`
 
-管理 DocSmith 随着时间的推移从您的反馈中学习到的用户偏好。这些偏好将在未来的生成和更新任务中作为规则应用，以保持与您的风格一致。
+管理 DocSmith 随时间从您的反馈中学习到的用户偏好。这些偏好将在未来的生成和更新任务中作为规则应用，以保持与您的风格一致。
 
 ### 选项
 
-| 选项 | 类型 | 描述 |
+| Option | Type | Description |
 |---|---|---|
 | `--list` | boolean | 列出所有已保存的偏好，显示其状态（激活/未激活）、范围和内容。 |
 | `--remove` | boolean | 移除一个或多个偏好。如果未提供 `--id`，则以交互方式运行。 |
 | `--toggle` | boolean | 切换一个或多个偏好的激活状态。如果未提供 `--id`，则以交互方式运行。 |
-| `--id` | array | 指定要执行 `--remove` 或 `--toggle` 操作的偏好 ID。 |
+| `--id` | array | 为 `--remove` 或 `--toggle` 指定要操作的偏好 ID。可多次使用。 |
 
 ### 使用示例
 
@@ -182,4 +248,4 @@ aigne doc prefs --remove
 aigne doc prefs --toggle --id <preference-id>
 ```
 
-有关如何根据您的需求定制 DocSmith 的更多详细信息，请参阅 [配置指南](./configuration.md)。
+有关如何根据您的需求定制 DocSmith 的更多详细信息，请参阅[配置指南](./configuration.md)。