@aigne/doc-smith 0.8.3 → 0.8.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/.aigne/doc-smith/config.yaml +3 -3
  2. package/.aigne/doc-smith/preferences.yml +58 -12
  3. package/.aigne/doc-smith/upload-cache.yaml +600 -207
  4. package/CHANGELOG.md +10 -0
  5. package/README.md +77 -5
  6. package/docs/advanced-how-it-works.md +55 -60
  7. package/docs/advanced-how-it-works.zh.md +60 -65
  8. package/docs/advanced-quality-assurance.md +73 -38
  9. package/docs/advanced-quality-assurance.zh.md +73 -38
  10. package/docs/advanced.md +2 -14
  11. package/docs/advanced.zh.md +5 -17
  12. package/docs/changelog.md +41 -4
  13. package/docs/changelog.zh.md +77 -40
  14. package/docs/cli-reference.md +79 -13
  15. package/docs/cli-reference.zh.md +92 -26
  16. package/docs/configuration-interactive-setup.md +102 -49
  17. package/docs/configuration-interactive-setup.zh.md +102 -49
  18. package/docs/configuration-language-support.md +69 -39
  19. package/docs/configuration-language-support.zh.md +68 -38
  20. package/docs/configuration-llm-setup.md +25 -62
  21. package/docs/configuration-llm-setup.zh.md +25 -62
  22. package/docs/configuration-preferences.md +79 -67
  23. package/docs/configuration-preferences.zh.md +78 -67
  24. package/docs/configuration.md +122 -109
  25. package/docs/configuration.zh.md +130 -117
  26. package/docs/features-generate-documentation.md +44 -24
  27. package/docs/features-generate-documentation.zh.md +52 -32
  28. package/docs/features-publish-your-docs.md +41 -40
  29. package/docs/features-publish-your-docs.zh.md +50 -49
  30. package/docs/features-translate-documentation.md +73 -17
  31. package/docs/features-translate-documentation.zh.md +76 -20
  32. package/docs/features-update-and-refine.md +72 -21
  33. package/docs/features-update-and-refine.zh.md +80 -29
  34. package/docs/features.md +24 -28
  35. package/docs/features.zh.md +25 -29
  36. package/docs/getting-started.md +87 -38
  37. package/docs/getting-started.zh.md +88 -39
  38. package/docs/overview.md +17 -35
  39. package/docs/overview.zh.md +18 -36
  40. package/package.json +9 -8
  41. package/prompts/content-detail-generator.md +1 -0
  42. package/prompts/document/custom-code-block.md +101 -0
  43. package/prompts/document/d2-chart/rules.md +941 -1031
  44. package/prompts/document/detail-generator.md +7 -53
  45. package/tests/kroki-utils.test.mjs +88 -17
  46. package/utils/constants.mjs +15 -1
  47. package/utils/kroki-utils.mjs +22 -14
  48. package/utils/markdown-checker.mjs +1 -1
  49. package/utils/utils.mjs +3 -2
  50. package/prompts/document/d2-chart/diy-examples.md +0 -44
  51. package/prompts/document/d2-chart/shape-rules.md +0 -182
@@ -1,64 +1,99 @@
1
- ---
2
- labels: ["Reference"]
3
- ---
4
-
5
1
  # 质量保证
6
2
 
7
- 为确保您的文档始终保持高质量,DocSmith 内置了一个强大的自动化质量保证流程。这些内置检查在生成和更新过程中自动运行,以检测并报告常见问题(从链接失效到格式错误),从而在问题影响到读者之前予以解决。
3
+ 为确保所有生成的文档功能正常、清晰且专业,DocSmith 引入了自动化的质量保证流程。该流程会对 Markdown 内容执行一系列检查,以便在发布前检测并报告从链接失效到图表格式错误等常见问题。
8
4
 
9
- 该流程会验证您内容的多个方面,以保持结构的完整性和准确性。
5
+ 该自动化流程会验证内容结构、链接、媒体和语法,以保持一致的质量标准。
10
6
 
11
7
  ```d2
12
- direction: right
8
+ direction: down
9
+
10
+ Input-Markdown-Content: {
11
+ label: "输入:Markdown 内容"
12
+ shape: rectangle
13
+ }
14
+
15
+ QA-Pipeline: {
16
+ label: "质量保证流程"
17
+ shape: rectangle
18
+ grid-columns: 1
19
+ grid-gap: 50
13
20
 
14
- Input: "Markdown 内容"
21
+ Structural-Checks: {
22
+ label: "结构检查"
23
+ shape: rectangle
24
+ grid-columns: 2
25
+ Completeness: "确保内容未被截断"
26
+ Code-Blocks: "验证代码块语法和缩进"
27
+ }
28
+
29
+ Content-Validation: {
30
+ label: "内容验证"
31
+ shape: rectangle
32
+ grid-columns: 2
33
+ Link-Integrity: "验证内部链接"
34
+ Image-Paths: "检查本地图片是否存在"
35
+ Table-Formatting: "匹配列数"
36
+ }
15
37
 
16
- QA_Pipeline: "DocSmith QA 流程" {
17
- shape: package
18
-
19
- Checks: {
38
+ Syntax-Validation: {
39
+ label: "语法验证"
40
+ shape: rectangle
20
41
  grid-columns: 2
21
- "结构完整性": "代码块不完整和缩进不一致"
22
- "链接和资源健康状况": "失效链接和本地图片缺失"
23
- "图表验证": "D2 语法检查"
24
- "Markdown 语法检查": "表格格式和标准规则"
42
+ D2-Diagrams: "验证 D2 语法"
43
+ Mermaid-Diagrams: "验证 Mermaid 语法"
44
+ Markdown-Linting: "强制执行样式规则"
25
45
  }
26
46
  }
27
47
 
28
- Output: "经验证的文档"
48
+ Output-Validated-Content-or-Error-Report: {
49
+ label: "输出:验证通过的内容或错误报告"
50
+ shape: rectangle
51
+ }
29
52
 
30
- Input -> QA_Pipeline: "分析"
31
- QA_Pipeline -> Output: "生成"
53
+ Input-Markdown-Content -> QA-Pipeline
54
+ QA-Pipeline -> Output-Validated-Content-or-Error-Report
32
55
  ```
33
56
 
34
- ### 内容和结构完整性
57
+ ### 核心验证领域
58
+
59
+ DocSmith 的质量保证流程涵盖了几个关键领域,以确保文档的完整性。
60
+
61
+ #### 内容结构与完整性
35
62
 
36
- DocSmith 会分析 Markdown 文件的基本结构,以捕获那些经常导致渲染失败或输出混乱的问题。
63
+ DocSmith 会执行多项检查以确保内容的结构完整性:
37
64
 
38
- - **代码块不完整**:验证器会确保每个以 ` ``` ` 开始的代码块都已正确关闭。未关闭的代码块可能导致文档的大部分内容无法正确渲染。
39
- - **缩进不一致**:系统会标记出缩进不一致的代码块。这对于缩进具有语法意义的代码示例以及防止意外的渲染问题尤为重要。
40
- - **内容完整性**:系统通过验证内容是否以适当的标点符号(例如 `.`、`)`、`|`)结尾,来检查内容是否被截断。这有助于捕获不完整的生成结果。
65
+ - **不完整的代码块**:检测以 ```` ``` ```` 开头但未关闭的代码块。
66
+ - **缺少换行符**:识别显示在单行上的内容,这可能表示缺少换行符。
67
+ - **内容结尾**:验证内容是否以适当的标点符号(例如 `.`、`)`、`|`、`>`)结尾,以防止输出被截断。
41
68
 
42
- ### 链接和资源验证
69
+ #### 链接和媒体完整性
43
70
 
44
- 失效链接和缺失图片会降低用户体验。DocSmith 会自动验证这些资源,以确保读者始终可以访问它们。
71
+ - **链接完整性**:文档中的所有相对链接都会根据项目的 `structurePlan` 进行验证,以防止出现死链接。这确保了所有内部导航都能正常工作。检查程序会忽略外部链接(以 `http://` 或 `https://` 开头)和 `mailto:` 链接。
45
72
 
46
- - **失效链接检查**:所有内部链接都会与您项目结构计划中定义的路径进行交叉引用。任何指向不存在页面的链接都将被报告为失效链接。
47
- - **本地图片验证**:对于本地图片(即未托管在外部服务器上的图片),系统会检查引用的图片文件是否存在于指定的相对或绝对路径中。
73
+ - **图片验证**:为避免图片损坏,检查程序会验证文档中引用的任何本地图片文件是否存在于文件系统中。它会解析相对路径和绝对路径以确认文件存在。外部图片 URL 和数据 URL 不会被检查。
48
74
 
49
- ### 图表验证
75
+ #### 图表语法验证
50
76
 
51
- 为确保所有图表都能正确渲染,DocSmith 会专门验证 D2 代码块的语法。在处理之前,系统会检查 D2 内容的语法正确性。如果发现错误,系统会进行标记,以防止发布损坏的图表。
77
+ - **D2 图表**:DocSmith 通过将代码发送到渲染服务来验证 D2 图表语法。此过程会确认图表能否成功编译为 SVG 图片,从而在导致图形损坏前捕获任何语法错误。
52
78
 
53
- ### Markdown 格式化与语法检查
79
+ - **Mermaid 图表**:Mermaid 图表会经过多项检查:一次主语法验证,以及针对已知会导致渲染问题的模式的特定检查,例如节点标签内的反引号或编号列表,以及需要加引号但未加的特殊字符。
54
80
 
55
- 除了主要的结构性问题,DocSmith 还会对 Markdown 进行语法检查,以确保格式的一致性和正确性,并利用既定标准来强制执行清晰易读的风格。关键检查包括:
81
+ #### 格式化与样式强制
56
82
 
57
- | 检查类别 | 描述 |
83
+ - **表格格式化**:检查表格的表头、分隔线和数据行之间的列数是否不匹配。此检查可防止常见的表格渲染失败。
84
+
85
+ - **代码块缩进**:检查程序会分析代码块中不一致的缩进。如果某行代码的缩进小于开头的 ```` ``` ```` 标记,可能会导致渲染问题。此检查有助于保持正确的代码呈现。
86
+
87
+ - **Markdown Linting**:内置的 linter 会强制执行一致的 Markdown 结构。关键规则包括:
88
+
89
+ | 规则 ID | 描述 |
58
90
  |---|---|
59
- | **表格格式化** | 验证表格的表头、分隔线和数据行中的列数是否一致。列数不匹配是导致表格损坏的常见原因。 |
60
- | **标题问题** | 检测同一文档中的重复标题或使用不当缩进的标题,这些问题可能会破坏文档大纲。 |
61
- | **引用验证** | 检查未定义的引用,例如使用了链接引用 `[text][ref]`,但未在其他地方定义 `[ref]: url`。 |
62
- | **代码块样式** | 确保一致地使用代码块标记,以提高可读性和解析效率。 |
91
+ | `no-duplicate-headings` | 防止同一节中出现内容相同的多个标题。 |
92
+ | `no-undefined-references` | 确保所有链接和图片引用都已定义。 |
93
+ | `no-heading-content-indent` | 不允许在标题内容前缩进。 |
94
+ | `no-multiple-toplevel-headings` | 每个文档只允许一个顶级标题 (H1)。 |
95
+ | `code-block-style` | 强制代码块使用一致的样式(例如,使用反引号)。 |
96
+
97
+ 通过自动化这些检查,DocSmith 保持了文档的一致标准,确保最终输出准确且易于导航。
63
98
 
64
- 这个自动化的质量保证层是 DocSmith 架构的核心部分,旨在最大限度地减少人工审查,并确保您的文档始终准确、专业且可靠。要了解有关整体生成流程的更多信息,请参阅[工作原理](./advanced-how-it-works.md)
99
+ 要了解有关整体架构的更多信息,请参阅 [工作原理](./advanced-how-it-works.md) 部分。
package/docs/advanced.md CHANGED
@@ -1,18 +1,6 @@
1
- ---
2
- labels: ["Reference"]
3
- ---
4
-
5
1
  # Advanced Topics
6
2
 
7
- For those who wish to look under the hood, this section provides a deeper dive into the architecture of AIGNE DocSmith. Here, you'll learn how the tool functions, its place within the AIGNE ecosystem, and the internal mechanisms it uses to generate high-quality documentation.
8
-
9
- While a deep understanding of these topics isn't necessary for general use, it can be valuable for customizing behavior, troubleshooting issues, or contributing to the project.
10
-
11
- ## The AIGNE Ecosystem
12
-
13
- AIGNE DocSmith is not a standalone tool; it is a key component of the [AIGNE Framework](https://www.aigne.io/en/framework), a comprehensive platform for AI application development. This integration allows DocSmith to leverage the platform's advanced AI capabilities and robust infrastructure. The following diagram illustrates how DocSmith fits into the broader ecosystem.
14
-
15
- ![AIGNE Ecosystem Architecture](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
3
+ For users who wish to understand the internal mechanics, this section provides a deeper look into the architecture of AIGNE DocSmith. It explains how the tool functions behind the scenes. While this level of detail is not required for general use, it can be valuable for customizing behavior or contributing to the project.
16
4
 
17
5
  To better understand the internal processes and quality controls, explore the following sections.
18
6
 
@@ -21,7 +9,7 @@ To better understand the internal processes and quality controls, explore the fo
21
9
  An architectural overview of DocSmith, explaining the role of AI agents in the documentation generation pipeline.
22
10
  </x-card>
23
11
  <x-card data-title="Quality Assurance" data-href="/advanced/quality-assurance" data-icon="lucide:shield-check">
24
- Understand the built-in checks DocSmith performs to ensure high-quality, well-formatted, and error-free documentation.
12
+ Understand the built-in checks DocSmith performs to ensure well-formatted and error-free documentation, including link checking and diagram validation.
25
13
  </x-card>
26
14
  </x-cards>
27
15
 
@@ -1,28 +1,16 @@
1
- ---
2
- labels: ["Reference"]
3
- ---
4
-
5
1
  # 高级主题
6
2
 
7
- 对于希望深入了解其内部机制的用户,本节将深入解析 AIGNE DocSmith 的架构。在这里,你将了解到该工具的运作方式、其在 AIGNE 生态系统中的定位,以及它用于生成高质量文档的内部机制。
8
-
9
- 虽然深入理解这些主题对于一般使用并非必要,但它对于自定义行为、排查问题或为项目做出贡献非常有价值。
10
-
11
- ## AIGNE 生态系统
12
-
13
- AIGNE DocSmith 并非一个独立的工具,而是 [AIGNE 框架](https://www.aigne.io/en/framework) 的关键组件,该框架是一个用于 AI 应用开发的综合平台。这种集成使 DocSmith 能够利用该平台的先进 AI 功能和强大的基础设施。下图展示了 DocSmith 如何融入更广泛的生态系统。
14
-
15
- ![AIGNE 生态系统架构](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
3
+ 对于希望了解内部机制的用户,本节将深入介绍 AIGNE DocSmith 的架构。它解释了该工具在后台如何运作。虽然一般使用不需要了解这些细节,但对于自定义行为或为项目做贡献而言,这些信息可能很有价值。
16
4
 
17
- 要更好地了解其内部流程和质量控制,请浏览以下章节。
5
+ 要更好地了解内部流程和质量控制,请浏览以下部分。
18
6
 
19
7
  <x-cards data-columns="2">
20
8
  <x-card data-title="工作原理" data-href="/advanced/how-it-works" data-icon="lucide:cpu">
21
- DocSmith 的架构概览,解释了 AI Agent 在文档生成流程中的作用。
9
+ DocSmith 的架构概述,解释了 AI Agent 在文档生成流程中的作用。
22
10
  </x-card>
23
11
  <x-card data-title="质量保证" data-href="/advanced/quality-assurance" data-icon="lucide:shield-check">
24
- 了解 DocSmith 为确保文档高质量、格式良好且无错误而执行的内置检查。
12
+ 了解 DocSmith 为确保文档格式正确、无错误而执行的内置检查,包括链接检查和图表验证。
25
13
  </x-card>
26
14
  </x-cards>
27
15
 
28
- 通过探索这些主题,你可以更全面地了解 DocSmith 的功能。要获取所有可用命令及其选项的详细说明,请参阅 [CLI 命令参考](./cli-reference.md)。
16
+ 通过探索这些主题,你可以更全面地了解 DocSmith 的功能。要详细了解所有可用命令及其选项,请继续阅读 [CLI 命令参考](./cli-reference.md)。
package/docs/changelog.md CHANGED
@@ -1,11 +1,48 @@
1
- ---
2
- labels: ["Reference"]
3
- ---
4
-
5
1
  # Changelog
6
2
 
7
3
  A detailed log of all notable changes, features, and bug fixes for each version of the project.
8
4
 
5
+ ## [0.8.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.1...v0.8.2) (2025-09-04)
6
+
7
+
8
+ ### Miscellaneous Chores
9
+
10
+ * release 0.8.2 ([849bc69](https://github.com/AIGNE-io/aigne-doc-smith/commit/849bc694edf167187f65cb34f1dd9a3966efd96c))
11
+
12
+ ## [0.8.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.0...v0.8.1) (2025-09-03)
13
+
14
+
15
+ ### Features
16
+
17
+ * tune d2 chart generating with comprehensive examples ([#80](https://github.com/AIGNE-io/aigne-doc-smith/issues/80)) ([3423e4c](https://github.com/AIGNE-io/aigne-doc-smith/commit/3423e4cff24335552503916694a3489e5d91bf6c))
18
+
19
+
20
+ ### Miscellaneous Chores
21
+
22
+ * release 0.8.1 ([21f64d4](https://github.com/AIGNE-io/aigne-doc-smith/commit/21f64d450377b1aef00f12613ba3b87aa4ef1d31))
23
+
24
+ ## [0.8.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.7.2...v0.8.0) (2025-09-03)
25
+
26
+
27
+ ### Features
28
+
29
+ * **tests:** add comprehensive workflow test coverage ([#76](https://github.com/AIGNE-io/aigne-doc-smith/issues/76)) ([d5f6062](https://github.com/AIGNE-io/aigne-doc-smith/commit/d5f6062311f36dc5b6394ae0768583fb8f3853a4))
30
+ * update custom component guidelines with formatting restrictions ([#79](https://github.com/AIGNE-io/aigne-doc-smith/issues/79)) ([76158de](https://github.com/AIGNE-io/aigne-doc-smith/commit/76158de236696e68c63c057f5ea4b8458a15e787))
31
+
32
+ ## [0.7.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.7.1...v0.7.2) (2025-09-01)
33
+
34
+
35
+ ### Miscellaneous Chores
36
+
37
+ * release 0.7.2 ([c3be232](https://github.com/AIGNE-io/aigne-doc-smith/commit/c3be2323e885cf5d11d654629fe30cc3720f79d3))
38
+
39
+ ## [0.7.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.7.0...v0.7.1) (2025-08-31)
40
+
41
+
42
+ ### Bug Fixes
43
+
44
+ * fix tab key path selection bug ([#72](https://github.com/AIGNE-io/aigne-doc-smith/issues/72)) ([369b342](https://github.com/AIGNE-io/aigne-doc-smith/commit/369b342d8ab8ce95b61a3b72e367157d2f71cce4))
45
+
9
46
  ## [0.7.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.6.0...v0.7.0) (2025-08-30)
10
47
 
11
48
 
@@ -1,34 +1,71 @@
1
- ---
2
- labels: ["Reference"]
3
- ---
4
-
5
1
  # 更新日志
6
2
 
7
- 项目每个版本所有重要变更、功能和错误修复的详细日志。
3
+ 项目每个版本的所有重要变更、功能和错误修复的详细日志。
4
+
5
+ ## [0.8.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.1...v0.8.2) (2025-09-04)
6
+
7
+
8
+ ### 其他杂项
9
+
10
+ * 发布 0.8.2 ([849bc69](https://github.com/AIGNE-io/aigne-doc-smith/commit/849bc694edf167187f65cb34f1dd9a3966efd96c))
11
+
12
+ ## [0.8.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.0...v0.8.1) (2025-09-03)
13
+
14
+
15
+ ### 功能
16
+
17
+ * 通过综合示例调整 d2 图表生成 ([#80](https://github.com/AIGNE-io/aigne-doc-smith/issues/80)) ([3423e4c](https://github.com/AIGNE-io/aigne-doc-smith/commit/3423e4cff24335552503916694a3489e5d91bf6c))
18
+
19
+
20
+ ### 其他杂项
21
+
22
+ * 发布 0.8.1 ([21f64d4](https://github.com/AIGNE-io/aigne-doc-smith/commit/21f64d450377b1aef00f12613ba3b87aa4ef1d31))
23
+
24
+ ## [0.8.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.7.2...v0.8.0) (2025-09-03)
25
+
26
+
27
+ ### 功能
28
+
29
+ * **测试:**添加全面的工作流测试覆盖率 ([#76](https://github.com/AIGNE-io/aigne-doc-smith/issues/76)) ([d5f6062](https://github.com/AIGNE-io/aigne-doc-smith/commit/d5f6062311f36dc5b6394ae0768583fb8f3853a4))
30
+ * 更新自定义组件指南,增加格式限制 ([#79](https://github.com/AIGNE-io/aigne-doc-smith/issues/79)) ([76158de](https://github.com/AIGNE-io/aigne-doc-smith/commit/76158de236696e68c63c057f5ea4b8458a15e787))
31
+
32
+ ## [0.7.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.7.1...v0.7.2) (2025-09-01)
33
+
34
+
35
+ ### 其他杂项
36
+
37
+ * 发布 0.7.2 ([c3be232](https://github.com/AIGNE-io/aigne-doc-smith/commit/c3be2323e885cf5d11d654629fe30cc3720f79d3))
38
+
39
+ ## [0.7.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.7.0...v0.7.1) (2025-08-31)
40
+
41
+
42
+ ### 错误修复
43
+
44
+ * 修复 Tab 键路径选择错误 ([#72](https://github.com/AIGNE-io/aigne-doc-smith/issues/72)) ([369b342](https://github.com/AIGNE-io/aigne-doc-smith/commit/369b342d8ab8ce95b61a3b72e367157d2f71cce4))
8
45
 
9
46
  ## [0.7.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.6.0...v0.7.0) (2025-08-30)
10
47
 
11
48
 
12
49
  ### 功能
13
50
 
14
- * 新增聊天模式支持 ([#60](https://github.com/AIGNE-io/aigne-doc-smith/issues/60)) ([9b2ce50](https://github.com/AIGNE-io/aigne-doc-smith/commit/9b2ce50014d1894a4e41bf043e699fdc4f1d74b7))
15
- * 支持自定义组件和更稳健的配置处理 ([#70](https://github.com/AIGNE-io/aigne-doc-smith/issues/70)) ([727ab42](https://github.com/AIGNE-io/aigne-doc-smith/commit/727ab429b00f924ef605530b35d2a12b4be77e3a))
51
+ * 增加聊天模式支持 ([#60](https://github.com/AIGNE-io/aigne-doc-smith/issues/60)) ([9b2ce50](https://github.com/AIGNE-io/aigne-doc-smith/commit/9b2ce50014d1894a4e41bf043e699fdc4f1d74b7))
52
+ * 支持自定义组件和更强大的配置处理 ([#70](https://github.com/AIGNE-io/aigne-doc-smith/issues/70)) ([727ab42](https://github.com/AIGNE-io/aigne-doc-smith/commit/727ab429b00f924ef605530b35d2a12b4be77e3a))
16
53
  * 在文档生成和发布工作流中支持 d2 图表 ([#69](https://github.com/AIGNE-io/aigne-doc-smith/issues/69)) ([bf95889](https://github.com/AIGNE-io/aigne-doc-smith/commit/bf958891516973636c4847b084c6fe75d1ea124b))
17
- * 支持多用途文档规划与生成 ([#68](https://github.com/AIGNE-io/aigne-doc-smith/issues/68)) ([44152c5](https://github.com/AIGNE-io/aigne-doc-smith/commit/44152c53b7e8f82e3af1245a1affd77b9817486d))
54
+ * 支持多用途文档规划和生成 ([#68](https://github.com/AIGNE-io/aigne-doc-smith/issues/68)) ([44152c5](https://github.com/AIGNE-io/aigne-doc-smith/commit/44152c53b7e8f82e3af1245a1affd77b9817486d))
18
55
 
19
56
  ## [0.6.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.5.1...v0.6.0) (2025-08-27)
20
57
 
21
58
 
22
59
  ### 功能
23
60
 
24
- * 在发布前全面支持媒体处理 ([#63](https://github.com/AIGNE-io/aigne-doc-smith/issues/63)) ([5257ca1](https://github.com/AIGNE-io/aigne-doc-smith/commit/5257ca1756f47487b65a1813949e547b6fc51aca))
61
+ * 完成发布前媒体处理的全面支持 ([#63](https://github.com/AIGNE-io/aigne-doc-smith/issues/63)) ([5257ca1](https://github.com/AIGNE-io/aigne-doc-smith/commit/5257ca1756f47487b65a1813949e547b6fc51aca))
25
62
 
26
63
  ## [0.5.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.5.0...v0.5.1) (2025-08-26)
27
64
 
28
65
 
29
66
  ### 其他杂项
30
67
 
31
- * 发布 0.5.1 版本 ([892d96e](https://github.com/AIGNE-io/aigne-doc-smith/commit/892d96e939a6404a42e8d2521f95bb7acfeabe27))
68
+ * 发布 0.5.1 ([892d96e](https://github.com/AIGNE-io/aigne-doc-smith/commit/892d96e939a6404a42e8d2521f95bb7acfeabe27))
32
69
 
33
70
  ## [0.5.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.4.5...v0.5.0) (2025-08-26)
34
71
 
@@ -40,14 +77,14 @@ labels: ["Reference"]
40
77
 
41
78
  ### 错误修复
42
79
 
43
- * 优化初始化问题的文案 ([#65](https://github.com/AIGNE-io/aigne-doc-smith/issues/65)) ([d4e8762](https://github.com/AIGNE-io/aigne-doc-smith/commit/d4e8762f26fd757bde43427860a0c1dade384269))
80
+ * 优化初始问题文案 ([#65](https://github.com/AIGNE-io/aigne-doc-smith/issues/65)) ([d4e8762](https://github.com/AIGNE-io/aigne-doc-smith/commit/d4e8762f26fd757bde43427860a0c1dade384269))
44
81
 
45
82
  ## [0.4.5](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.4.4...v0.4.5) (2025-08-25)
46
83
 
47
84
 
48
85
  ### 其他杂项
49
86
 
50
- * 发布 0.4.5 版本 ([12aa6c3](https://github.com/AIGNE-io/aigne-doc-smith/commit/12aa6c340fdd95cbd74833662f4c3a80f19dfa30))
87
+ * 发布 0.4.5 ([12aa6c3](https://github.com/AIGNE-io/aigne-doc-smith/commit/12aa6c340fdd95cbd74833662f4c3a80f19dfa30))
51
88
 
52
89
  ## [0.4.4](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.4.3...v0.4.4) (2025-08-22)
53
90
 
@@ -61,14 +98,14 @@ labels: ["Reference"]
61
98
 
62
99
  ### 其他杂项
63
100
 
64
- * 发布 0.4.3 版本 ([f37ac7c](https://github.com/AIGNE-io/aigne-doc-smith/commit/f37ac7cd1fd129d8e3019cc7e952a0cf7dcb3db7))
101
+ * 发布 0.4.3 ([f37ac7c](https://github.com/AIGNE-io/aigne-doc-smith/commit/f37ac7cd1fd129d8e3019cc7e952a0cf7dcb3db7))
65
102
 
66
103
  ## [0.4.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.4.1...v0.4.2) (2025-08-21)
67
104
 
68
105
 
69
106
  ### 其他杂项
70
107
 
71
- * 发布 0.4.2 版本 ([9e36cf6](https://github.com/AIGNE-io/aigne-doc-smith/commit/9e36cf678ac51a0f4e7b3c19e4b5248e42b80437))
108
+ * 发布 0.4.2 ([9e36cf6](https://github.com/AIGNE-io/aigne-doc-smith/commit/9e36cf678ac51a0f4e7b3c19e4b5248e42b80437))
72
109
 
73
110
  ## [0.4.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.4.0...v0.4.1) (2025-08-21)
74
111
 
@@ -89,14 +126,14 @@ labels: ["Reference"]
89
126
 
90
127
  ### 错误修复
91
128
 
92
- * 优化加载源的模式 ([#48](https://github.com/AIGNE-io/aigne-doc-smith/issues/48)) ([5f83b91](https://github.com/AIGNE-io/aigne-doc-smith/commit/5f83b917ea6779ba79418e3ff2490eb692c3e48a))
129
+ * 优化加载源模式 ([#48](https://github.com/AIGNE-io/aigne-doc-smith/issues/48)) ([5f83b91](https://github.com/AIGNE-io/aigne-doc-smith/commit/5f83b917ea6779ba79418e3ff2490eb692c3e48a))
93
130
 
94
131
  ## [0.3.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.11...v0.3.0) (2025-08-19)
95
132
 
96
133
 
97
134
  ### 功能
98
135
 
99
- * **core:** 优化生成上下文收集工作流 ([#46](https://github.com/AIGNE-io/aigne-doc-smith/issues/46)) ([687d06a](https://github.com/AIGNE-io/aigne-doc-smith/commit/687d06afd648e0e697d25e85dcc841b17c3c311c))
136
+ * **核心:**优化生成上下文收集工作流 ([#46](https://github.com/AIGNE-io/aigne-doc-smith/issues/46)) ([687d06a](https://github.com/AIGNE-io/aigne-doc-smith/commit/687d06afd648e0e697d25e85dcc841b17c3c311c))
100
137
 
101
138
 
102
139
  ### 错误修复
@@ -129,7 +166,7 @@ labels: ["Reference"]
129
166
 
130
167
  ### 其他杂项
131
168
 
132
- * 发布 0.2.8 版本 ([da19bc0](https://github.com/AIGNE-io/aigne-doc-smith/commit/da19bc0b2c6c4e5fddaff84b4fa85c9d495b3ba0))
169
+ * 发布 0.2.8 ([da19bc0](https://github.com/AIGNE-io/aigne-doc-smith/commit/da19bc0b2c6c4e5fddaff84b4fa85c9d495b3ba0))
133
170
 
134
171
  ## [0.2.7](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.6...v0.2.7) (2025-08-12)
135
172
 
@@ -141,28 +178,28 @@ labels: ["Reference"]
141
178
 
142
179
  ### 其他杂项
143
180
 
144
- * 发布 0.2.7 版本 ([3b807fe](https://github.com/AIGNE-io/aigne-doc-smith/commit/3b807fed833a5160931747bce37aac00cf11d9ac))
181
+ * 发布 0.2.7 ([3b807fe](https://github.com/AIGNE-io/aigne-doc-smith/commit/3b807fed833a5160931747bce37aac00cf11d9ac))
145
182
 
146
183
  ## [0.2.6](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.5...v0.2.6) (2025-08-12)
147
184
 
148
185
 
149
186
  ### 其他杂项
150
187
 
151
- * 发布 0.2.6 版本 ([c5b5ea5](https://github.com/AIGNE-io/aigne-doc-smith/commit/c5b5ea5c404d44f3b0d420f0b57e4ae64ae5d624))
188
+ * 发布 0.2.6 ([c5b5ea5](https://github.com/AIGNE-io/aigne-doc-smith/commit/c5b5ea5c404d44f3b0d420f0b57e4ae64ae5d624))
152
189
 
153
190
  ## [0.2.5](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.4...v0.2.5) (2025-08-08)
154
191
 
155
192
 
156
193
  ### 错误修复
157
194
 
158
- * 优化 cli 流程 ([#17](https://github.com/AIGNE-io/aigne-doc-smith/issues/17)) ([4c94263](https://github.com/AIGNE-io/aigne-doc-smith/commit/4c9426378dff9ca3270bd0e455aa6fb1045f6abb))
195
+ * 优化 CLI 流程 ([#17](https://github.com/AIGNE-io/aigne-doc-smith/issues/17)) ([4c94263](https://github.com/AIGNE-io/aigne-doc-smith/commit/4c9426378dff9ca3270bd0e455aa6fb1045f6abb))
159
196
 
160
197
  ## [0.2.4](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.3...v0.2.4) (2025-08-07)
161
198
 
162
199
 
163
200
  ### 错误修复
164
201
 
165
- * 优化 agent 输出日志 ([40a2451](https://github.com/AIGNE-io/aigne-doc-smith/commit/40a245122ce4d8747e5b5dbe88be6986047c38ae))
202
+ * 优化 Agent 输出日志 ([40a2451](https://github.com/AIGNE-io/aigne-doc-smith/commit/40a245122ce4d8747e5b5dbe88be6986047c38ae))
166
203
 
167
204
  ## [0.2.3](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.2...v0.2.3) (2025-08-07)
168
205
 
@@ -176,21 +213,21 @@ labels: ["Reference"]
176
213
 
177
214
  ### 其他杂项
178
215
 
179
- * 发布 0.2.2 版本 ([c3fb52a](https://github.com/AIGNE-io/aigne-doc-smith/commit/c3fb52a78b95676e1c13361b30ebec2914a89fa8))
216
+ * 发布 0.2.2 ([c3fb52a](https://github.com/AIGNE-io/aigne-doc-smith/commit/c3fb52a78b95676e1c13361b30ebec2914a89fa8))
180
217
 
181
218
  ## [0.2.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.2.0...v0.2.1) (2025-08-06)
182
219
 
183
220
 
184
221
  ### 其他杂项
185
222
 
186
- * 发布 0.2.1 版本 ([e3a39ae](https://github.com/AIGNE-io/aigne-doc-smith/commit/e3a39aedcee129deae424e96942f9798b9191663))
223
+ * 发布 0.2.1 ([e3a39ae](https://github.com/AIGNE-io/aigne-doc-smith/commit/e3a39aedcee129deae424e96942f9798b9191663))
187
224
 
188
225
  ## [0.2.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.1.4...v0.2.0) (2025-08-05)
189
226
 
190
227
 
191
228
  ### 功能
192
229
 
193
- * 支持调用 agents 时自动初始化配置 ([24d29db](https://github.com/AIGNE-io/aigne-doc-smith/commit/24d29db4dd86709750aa22ff649e7dacc4124126))
230
+ * 支持调用 Agent 时自动初始化配置 ([24d29db](https://github.com/AIGNE-io/aigne-doc-smith/commit/24d29db4dd86709750aa22ff649e7dacc4124126))
194
231
  * 源文件变更时更新文档 ([#9](https://github.com/AIGNE-io/aigne-doc-smith/issues/9)) ([4adcecf](https://github.com/AIGNE-io/aigne-doc-smith/commit/4adcecfb32e72c9e88d0b0bd8ce0a91022847ca7))
195
232
 
196
233
  ## [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"]
198
235
 
199
236
  ### 其他杂项
200
237
 
201
- * 发布 0.1.4 版本 ([4122cf5](https://github.com/AIGNE-io/aigne-doc-smith/commit/4122cf5cc0285bef2b96803f393e744121d22acf))
238
+ * 发布 0.1.4 ([4122cf5](https://github.com/AIGNE-io/aigne-doc-smith/commit/4122cf5cc0285bef2b96803f393e744121d22acf))
202
239
 
203
240
  ## [0.1.3](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.1.2...v0.1.3) (2025-08-04)
204
241
 
205
242
 
206
243
  ### 错误修复
207
244
 
208
- * 从 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))
245
+ * 从 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))
209
246
 
210
247
  ## [0.1.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.1.1...v0.1.2) (2025-08-01)
211
248
 
@@ -219,7 +256,7 @@ labels: ["Reference"]
219
256
 
220
257
  ### 错误修复
221
258
 
222
- * agent 添加别名 ([7e25014](https://github.com/AIGNE-io/aigne-doc-smith/commit/7e250147309849fe0f4cc554077134d2e443d344))
259
+ * Agent 添加别名 ([7e25014](https://github.com/AIGNE-io/aigne-doc-smith/commit/7e250147309849fe0f4cc554077134d2e443d344))
223
260
  * docs mcp 添加文档搜索 ([de96e0e](https://github.com/AIGNE-io/aigne-doc-smith/commit/de96e0e08455831dc6918d5fbc59d38b6a921373))
224
261
  * 优化代码 ([8cb0a5c](https://github.com/AIGNE-io/aigne-doc-smith/commit/8cb0a5ce67cf009c672b2fb1aa9b89ef6d965a86))
225
262
 
@@ -228,33 +265,33 @@ labels: ["Reference"]
228
265
 
229
266
  ### 功能
230
267
 
231
- * 为 mcp 服务器和 cli 添加入口 agents ([fa85d65](https://github.com/AIGNE-io/aigne-doc-smith/commit/fa85d651e8dc723e2b97150fc2258b115c6c5bb0))
268
+ * 为 mcp 服务器和 CLI 添加入口 Agent ([fa85d65](https://github.com/AIGNE-io/aigne-doc-smith/commit/fa85d651e8dc723e2b97150fc2258b115c6c5bb0))
232
269
 
233
270
 
234
271
  ### 错误修复
235
272
 
236
273
  * 优化命令参数 ([#3](https://github.com/AIGNE-io/aigne-doc-smith/issues/3)) ([003f6b8](https://github.com/AIGNE-io/aigne-doc-smith/commit/003f6b8ae2c9e1af55ba1841458fa8567a0eb2f0))
237
- * 优化 docs mcp agent ([8654cd4](https://github.com/AIGNE-io/aigne-doc-smith/commit/8654cd4ea38034f3af0244f56b27acf66ba704e1))
274
+ * 优化 docs mcp Agent ([8654cd4](https://github.com/AIGNE-io/aigne-doc-smith/commit/8654cd4ea38034f3af0244f56b27acf66ba704e1))
238
275
 
239
276
  ## 0.0.2 (2025-07-30)
240
277
 
241
278
 
242
279
  ### 功能
243
280
 
244
- * 新增自动创建看板 ([3ff06ad](https://github.com/AIGNE-io/aigne-doc-smith/commit/3ff06ad0241e208b09bcf828c52c2c5051c67ef8))
245
- * 新增 docs-mcp ([a7508a1](https://github.com/AIGNE-io/aigne-doc-smith/commit/a7508a13abb2222968b1bc9c14948427af509f97))
246
- * 新增 input generator agent ([20c01bb](https://github.com/AIGNE-io/aigne-doc-smith/commit/20c01bbca6d6f9414695071fc907bd7cf43d7f62))
247
- * 新增发布文档功能 ([41bb126](https://github.com/AIGNE-io/aigne-doc-smith/commit/41bb126caeb1c3c242c7a2be27abb114aeab9953))
248
- * 新增对文档标签的支持 ([4522c07](https://github.com/AIGNE-io/aigne-doc-smith/commit/4522c07b1ceb05664a1f5b5fb4df06feee536eba))
249
- * 详情添加审查功能 ([8f1aa4f](https://github.com/AIGNE-io/aigne-doc-smith/commit/8f1aa4f22e2d2e590d7aa37288c2e1ee7ea48f07))
281
+ * 添加自动创建看板 ([3ff06ad](https://github.com/AIGNE-io/aigne-doc-smith/commit/3ff06ad0241e208b09bcf828c52c2c5051c67ef8))
282
+ * 添加 docs-mcp ([a7508a1](https://github.com/AIGNE-io/aigne-doc-smith/commit/a7508a13abb2222968b1bc9c14948427af509f97))
283
+ * 添加输入生成器 Agent ([20c01bb](https://github.com/AIGNE-io/aigne-doc-smith/commit/20c01bbca6d6f9414695071fc907bd7cf43d7f62))
284
+ * 添加发布文档功能 ([41bb126](https://github.com/AIGNE-io/aigne-doc-smith/commit/41bb126caeb1c3c242c7a2be27abb114aeab9953))
285
+ * 添加对文档标签的支持 ([4522c07](https://github.com/AIGNE-io/aigne-doc-smith/commit/4522c07b1ceb05664a1f5b5fb4df06feee536eba))
286
+ * 详情添加审查 ([8f1aa4f](https://github.com/AIGNE-io/aigne-doc-smith/commit/8f1aa4f22e2d2e590d7aa37288c2e1ee7ea48f07))
250
287
  * 初始提交 ([dafc40e](https://github.com/AIGNE-io/aigne-doc-smith/commit/dafc40e94f3c407e50b2c46ecb46237f23a15cf7))
251
- * 结构规划添加审查功能 ([b56e83e](https://github.com/AIGNE-io/aigne-doc-smith/commit/b56e83e558f509302b422205f30e9b2adb42d452))
288
+ * 结构规划添加审查 ([b56e83e](https://github.com/AIGNE-io/aigne-doc-smith/commit/b56e83e558f509302b422205f30e9b2adb42d452))
252
289
 
253
290
 
254
291
  ### 错误修复
255
292
 
256
- * 优化 agent 名称 ([25875a0](https://github.com/AIGNE-io/aigne-doc-smith/commit/25875a0688ebbca71f6c25bf4bd5246361f3dd2d))
257
- * 优化 agent 参数和描述 ([290eb24](https://github.com/AIGNE-io/aigne-doc-smith/commit/290eb240ce986b0f1f406bf42824ce1235df11e5))
293
+ * 优化 Agent 名称 ([25875a0](https://github.com/AIGNE-io/aigne-doc-smith/commit/25875a0688ebbca71f6c25bf4bd5246361f3dd2d))
294
+ * 优化 Agent 参数和描述 ([290eb24](https://github.com/AIGNE-io/aigne-doc-smith/commit/290eb240ce986b0f1f406bf42824ce1235df11e5))
258
295
  * 优化代码 ([34f9a24](https://github.com/AIGNE-io/aigne-doc-smith/commit/34f9a24fc3748b4177cad2b5330fe6b3ccd99175))
259
296
  * 优化代码 ([0343486](https://github.com/AIGNE-io/aigne-doc-smith/commit/0343486aa086bbe2ced8de849de6a4a42567719c))
260
297
  * 优化代码 ([7b7dfb9](https://github.com/AIGNE-io/aigne-doc-smith/commit/7b7dfb925b3aa55956ef7a99ededc749fb6a42d7))
@@ -262,11 +299,11 @@ labels: ["Reference"]
262
299
  * 优化代码 ([74fee51](https://github.com/AIGNE-io/aigne-doc-smith/commit/74fee51ad6337af8811a35f2a4334b67ec109439))
263
300
  * 优化代码 ([7fa1675](https://github.com/AIGNE-io/aigne-doc-smith/commit/7fa1675b2cab6144d1fb9d4388130209c6cfa0bc))
264
301
  * 优化文档审查 ([70374ab](https://github.com/AIGNE-io/aigne-doc-smith/commit/70374abed74946eafa7b0f87331c2e496fa61592))
265
- * 优化 input generator agent ([ae908bb](https://github.com/AIGNE-io/aigne-doc-smith/commit/ae908bbc0cb98b9b196e8b08f23149e5693e0abe))
302
+ * 优化输入生成器 Agent ([ae908bb](https://github.com/AIGNE-io/aigne-doc-smith/commit/ae908bbc0cb98b9b196e8b08f23149e5693e0abe))
266
303
  * 优化结构规划 ([3a0a196](https://github.com/AIGNE-io/aigne-doc-smith/commit/3a0a196a97196ba445c4709d3466ff355917ac53))
267
304
  * 保存文档时移除无用文档 ([bec5ba3](https://github.com/AIGNE-io/aigne-doc-smith/commit/bec5ba3afd462c990a0aa813bbe38ce9a61363ee))
268
305
 
269
306
 
270
307
  ### 其他杂项
271
308
 
272
- * 发布 0.0.2 版本 ([73bf26a](https://github.com/AIGNE-io/aigne-doc-smith/commit/73bf26a5c55fa4726d866cff64bd48d1ca37a3b3))
309
+ * 发布 0.0.2 ([73bf26a](https://github.com/AIGNE-io/aigne-doc-smith/commit/73bf26a5c55fa4726d866cff64bd48d1ca37a3b3))