@aigne/doc-smith 0.8.12-beta.3 → 0.8.12-beta.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 (169) hide show
  1. package/.aigne/doc-smith/config.yaml +9 -6
  2. package/.aigne/doc-smith/output/structure-plan.json +123 -109
  3. package/.aigne/doc-smith/upload-cache.yaml +48 -0
  4. package/.github/workflows/publish-docs.yml +4 -7
  5. package/.release-please-manifest.json +1 -1
  6. package/CHANGELOG.md +13 -0
  7. package/agents/clear/choose-contents.mjs +22 -5
  8. package/agents/clear/clear-auth-tokens.mjs +2 -4
  9. package/agents/clear/clear-deployment-config.mjs +49 -0
  10. package/agents/clear/clear-document-config.mjs +2 -5
  11. package/agents/clear/clear-document-structure.mjs +2 -6
  12. package/agents/clear/clear-generated-docs.mjs +0 -1
  13. package/agents/generate/check-need-generate-structure.mjs +15 -60
  14. package/agents/generate/document-structure-tools/generate-sub-structure.mjs +131 -0
  15. package/agents/generate/generate-structure-without-tools.yaml +65 -0
  16. package/agents/generate/generate-structure.yaml +7 -1
  17. package/agents/generate/index.yaml +0 -3
  18. package/agents/generate/update-document-structure.yaml +3 -0
  19. package/agents/generate/user-review-document-structure.mjs +7 -5
  20. package/agents/init/index.mjs +15 -15
  21. package/agents/publish/publish-docs.mjs +130 -111
  22. package/agents/translate/index.yaml +1 -1
  23. package/agents/update/batch-generate-document.yaml +1 -1
  24. package/agents/update/batch-update-document.yaml +1 -1
  25. package/agents/update/check-document.mjs +3 -19
  26. package/agents/update/user-review-document.mjs +4 -3
  27. package/agents/utils/load-sources.mjs +54 -151
  28. package/agents/utils/transform-detail-datasources.mjs +14 -18
  29. package/aigne.yaml +2 -0
  30. package/biome.json +1 -1
  31. package/docs/_sidebar.md +13 -15
  32. package/docs/configuration-initial-setup.ja.md +179 -0
  33. package/docs/configuration-initial-setup.md +179 -0
  34. package/docs/configuration-initial-setup.zh-TW.md +179 -0
  35. package/docs/configuration-initial-setup.zh.md +179 -0
  36. package/docs/configuration-managing-preferences.ja.md +100 -0
  37. package/docs/configuration-managing-preferences.md +100 -0
  38. package/docs/configuration-managing-preferences.zh-TW.md +100 -0
  39. package/docs/configuration-managing-preferences.zh.md +100 -0
  40. package/docs/configuration.ja.md +68 -184
  41. package/docs/configuration.md +62 -178
  42. package/docs/configuration.zh-TW.md +70 -186
  43. package/docs/configuration.zh.md +67 -183
  44. package/docs/getting-started.ja.md +46 -78
  45. package/docs/getting-started.md +46 -78
  46. package/docs/getting-started.zh-TW.md +47 -79
  47. package/docs/getting-started.zh.md +47 -79
  48. package/docs/guides-cleaning-up.ja.md +50 -0
  49. package/docs/guides-cleaning-up.md +50 -0
  50. package/docs/guides-cleaning-up.zh-TW.md +50 -0
  51. package/docs/guides-cleaning-up.zh.md +50 -0
  52. package/docs/guides-evaluating-documents.ja.md +66 -0
  53. package/docs/guides-evaluating-documents.md +66 -0
  54. package/docs/guides-evaluating-documents.zh-TW.md +66 -0
  55. package/docs/guides-evaluating-documents.zh.md +66 -0
  56. package/docs/guides-generating-documentation.ja.md +149 -0
  57. package/docs/guides-generating-documentation.md +149 -0
  58. package/docs/guides-generating-documentation.zh-TW.md +149 -0
  59. package/docs/guides-generating-documentation.zh.md +149 -0
  60. package/docs/guides-interactive-chat.ja.md +85 -0
  61. package/docs/guides-interactive-chat.md +85 -0
  62. package/docs/guides-interactive-chat.zh-TW.md +85 -0
  63. package/docs/guides-interactive-chat.zh.md +85 -0
  64. package/docs/guides-managing-history.ja.md +51 -0
  65. package/docs/guides-managing-history.md +51 -0
  66. package/docs/guides-managing-history.zh-TW.md +51 -0
  67. package/docs/guides-managing-history.zh.md +51 -0
  68. package/docs/guides-publishing-your-docs.ja.md +78 -0
  69. package/docs/guides-publishing-your-docs.md +78 -0
  70. package/docs/guides-publishing-your-docs.zh-TW.md +78 -0
  71. package/docs/guides-publishing-your-docs.zh.md +78 -0
  72. package/docs/guides-translating-documentation.ja.md +95 -0
  73. package/docs/guides-translating-documentation.md +95 -0
  74. package/docs/guides-translating-documentation.zh-TW.md +95 -0
  75. package/docs/guides-translating-documentation.zh.md +95 -0
  76. package/docs/guides-updating-documentation.ja.md +77 -0
  77. package/docs/guides-updating-documentation.md +77 -0
  78. package/docs/guides-updating-documentation.zh-TW.md +77 -0
  79. package/docs/guides-updating-documentation.zh.md +77 -0
  80. package/docs/guides.ja.md +32 -0
  81. package/docs/guides.md +32 -0
  82. package/docs/guides.zh-TW.md +32 -0
  83. package/docs/guides.zh.md +32 -0
  84. package/docs/overview.ja.md +39 -60
  85. package/docs/overview.md +39 -60
  86. package/docs/overview.zh-TW.md +39 -60
  87. package/docs/overview.zh.md +39 -60
  88. package/docs/release-notes.ja.md +255 -0
  89. package/docs/release-notes.md +255 -0
  90. package/docs/release-notes.zh-TW.md +255 -0
  91. package/docs/release-notes.zh.md +255 -0
  92. package/package.json +4 -2
  93. package/prompts/common/document/content-rules-core.md +1 -0
  94. package/prompts/common/document-structure/document-structure-rules.md +8 -9
  95. package/prompts/common/document-structure/output-constraints.md +1 -1
  96. package/prompts/structure/document-rules.md +8 -2
  97. package/prompts/structure/generate/system-prompt.md +27 -2
  98. package/prompts/structure/generate/user-prompt.md +18 -0
  99. package/prompts/structure/update/system-prompt.md +12 -0
  100. package/prompts/structure/update/user-prompt.md +3 -0
  101. package/tests/agents/clear/choose-contents.test.mjs +8 -4
  102. package/tests/agents/generate/check-need-generate-structure.test.mjs +53 -63
  103. package/tests/agents/generate/document-structure-tools/generate-sub-structure.test.mjs +277 -0
  104. package/tests/agents/init/init.test.mjs +18 -18
  105. package/tests/agents/publish/publish-docs.test.mjs +79 -0
  106. package/tests/agents/update/check-document.test.mjs +7 -67
  107. package/tests/agents/utils/load-sources.test.mjs +90 -90
  108. package/tests/agents/utils/transform-detail-datasources.test.mjs +153 -196
  109. package/tests/utils/file-utils.test.mjs +309 -1
  110. package/utils/auth-utils.mjs +9 -3
  111. package/utils/constants/index.mjs +3 -1
  112. package/utils/file-utils.mjs +315 -0
  113. package/utils/utils.mjs +89 -50
  114. package/docs/advanced-how-it-works.ja.md +0 -101
  115. package/docs/advanced-how-it-works.md +0 -101
  116. package/docs/advanced-how-it-works.zh-TW.md +0 -101
  117. package/docs/advanced-how-it-works.zh.md +0 -101
  118. package/docs/advanced-quality-assurance.ja.md +0 -92
  119. package/docs/advanced-quality-assurance.md +0 -92
  120. package/docs/advanced-quality-assurance.zh-TW.md +0 -92
  121. package/docs/advanced-quality-assurance.zh.md +0 -92
  122. package/docs/advanced.ja.md +0 -20
  123. package/docs/advanced.md +0 -20
  124. package/docs/advanced.zh-TW.md +0 -20
  125. package/docs/advanced.zh.md +0 -20
  126. package/docs/changelog.ja.md +0 -486
  127. package/docs/changelog.md +0 -486
  128. package/docs/changelog.zh-TW.md +0 -486
  129. package/docs/changelog.zh.md +0 -486
  130. package/docs/cli-reference.ja.md +0 -311
  131. package/docs/cli-reference.md +0 -311
  132. package/docs/cli-reference.zh-TW.md +0 -311
  133. package/docs/cli-reference.zh.md +0 -311
  134. package/docs/configuration-interactive-setup.ja.md +0 -138
  135. package/docs/configuration-interactive-setup.md +0 -138
  136. package/docs/configuration-interactive-setup.zh-TW.md +0 -138
  137. package/docs/configuration-interactive-setup.zh.md +0 -138
  138. package/docs/configuration-language-support.ja.md +0 -64
  139. package/docs/configuration-language-support.md +0 -64
  140. package/docs/configuration-language-support.zh-TW.md +0 -64
  141. package/docs/configuration-language-support.zh.md +0 -64
  142. package/docs/configuration-llm-setup.ja.md +0 -56
  143. package/docs/configuration-llm-setup.md +0 -56
  144. package/docs/configuration-llm-setup.zh-TW.md +0 -56
  145. package/docs/configuration-llm-setup.zh.md +0 -56
  146. package/docs/configuration-preferences.ja.md +0 -144
  147. package/docs/configuration-preferences.md +0 -144
  148. package/docs/configuration-preferences.zh-TW.md +0 -144
  149. package/docs/configuration-preferences.zh.md +0 -144
  150. package/docs/features-generate-documentation.ja.md +0 -95
  151. package/docs/features-generate-documentation.md +0 -95
  152. package/docs/features-generate-documentation.zh-TW.md +0 -95
  153. package/docs/features-generate-documentation.zh.md +0 -95
  154. package/docs/features-publish-your-docs.ja.md +0 -130
  155. package/docs/features-publish-your-docs.md +0 -130
  156. package/docs/features-publish-your-docs.zh-TW.md +0 -130
  157. package/docs/features-publish-your-docs.zh.md +0 -130
  158. package/docs/features-translate-documentation.ja.md +0 -90
  159. package/docs/features-translate-documentation.md +0 -90
  160. package/docs/features-translate-documentation.zh-TW.md +0 -90
  161. package/docs/features-translate-documentation.zh.md +0 -90
  162. package/docs/features-update-and-refine.ja.md +0 -142
  163. package/docs/features-update-and-refine.md +0 -142
  164. package/docs/features-update-and-refine.zh-TW.md +0 -143
  165. package/docs/features-update-and-refine.zh.md +0 -142
  166. package/docs/features.ja.md +0 -62
  167. package/docs/features.md +0 -62
  168. package/docs/features.zh-TW.md +0 -62
  169. package/docs/features.zh.md +0 -62
@@ -1,101 +0,0 @@
1
- # 運作方式
2
-
3
- AIGNE DocSmith 運作於一個多 Agent 系統之上。它並非單一的巨型流程,而是協調一個由專業化 AI Agent 組成的流程,其中每個 Agent 負責一項特定任務。這種方法實現了一個結構化和模組化的流程,能將原始程式碼轉換為完整的文件。
4
-
5
- 此工具是更廣泛的 AIGNE 生態系統中不可或缺的一部分,該生態系統為開發和部署 AI 應用程式提供了一個平台。
6
-
7
- ![AIGNE 生態系統架構](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
8
-
9
- ## 文件產生流程
10
-
11
- DocSmith 的核心是一個將您的原始程式碼經過數個不同階段處理的流程。每個階段都由一個或多個專門的 Agent 管理。主要的工作流程,通常由 `aigne doc generate` 指令啟動,可視覺化如下:
12
-
13
- ```d2
14
- direction: down
15
-
16
- Input: {
17
- label: "原始程式碼與設定"
18
- shape: rectangle
19
- }
20
-
21
- Pipeline: {
22
- label: "核心產生流程"
23
- shape: rectangle
24
- grid-columns: 1
25
- grid-gap: 40
26
-
27
- Structure-Planning: {
28
- label: "1. 結構規劃"
29
- shape: rectangle
30
- }
31
-
32
- Content-Generation: {
33
- label: "2. 內容產生"
34
- shape: rectangle
35
- }
36
-
37
- Saving: {
38
- label: "3. 儲存文件"
39
- shape: rectangle
40
- }
41
- }
42
-
43
- User-Feedback: {
44
- label: "使用者回饋循環\n(透過 --feedback 旗標)"
45
- shape: rectangle
46
- }
47
-
48
- Optional-Steps: {
49
- label: "選用的後產生步驟"
50
- shape: rectangle
51
- grid-columns: 2
52
- grid-gap: 40
53
-
54
- Translation: {
55
- label: "翻譯\n(aigne doc translate)"
56
- shape: rectangle
57
- }
58
-
59
- Publishing: {
60
- label: "發布\n(aigne doc publish)"
61
- shape: rectangle
62
- }
63
- }
64
-
65
- Input -> Pipeline.Structure-Planning
66
- Pipeline.Structure-Planning -> Pipeline.Content-Generation
67
- Pipeline.Content-Generation -> Pipeline.Saving
68
- Pipeline.Saving -> Optional-Steps
69
-
70
- User-Feedback -> Pipeline.Structure-Planning: "優化結構"
71
- User-Feedback -> Pipeline.Content-Generation: "重新產生內容"
72
- ```
73
-
74
- 1. **輸入分析**:當 Agent 載入您的原始程式碼和專案設定(`aigne.yaml`)時,流程便開始了。
75
-
76
- 2. **結構規劃**:一個 Agent 會分析程式庫以提出一個合乎邏輯的文件結構。它會根據專案的組成和任何指定的規則來建立大綱。
77
-
78
- 3. **內容產生**:結構就緒後,內容產生 Agent 會在文件計畫的每個部分填入詳細的文字、程式碼範例和說明。
79
-
80
- 4. **優化與更新**:當您透過 `aigne doc update` 或 `aigne doc generate --feedback` 提供輸入時,特定的 Agent 會被啟動以更新個別文件或調整整體結構。
81
-
82
- 5. **翻譯與發布**:主要內容產生後,選用的 Agent 會處理多語言翻譯和將最終文件發布到網路平台等任務。
83
-
84
- ## 關鍵 AI Agent
85
-
86
- DocSmith 的功能由專案設定中定義的一系列 Agent 提供。每個 Agent 都有特定的角色。下表列出了一些關鍵 Agent 及其功能。
87
-
88
- | 功能角色 | 關鍵 Agent 檔案 | 說明 |
89
- | :--- | :--- | :--- |
90
- | **結構規劃** | `generate/generate-structure.yaml` | 分析原始程式碼以提出初始的文件大綱。 |
91
- | **結構優化** | `generate/refine-document-structure.yaml` | 根據使用者回饋修改文件結構。 |
92
- | **內容產生** | `update/batch-generate-document.yaml`, `update/generate-document.yaml` | 為文件結構的每個部分填入詳細內容。 |
93
- | **翻譯** | `translate/translate-document.yaml`, `translate/translate-multilingual.yaml` | 將產生的文件翻譯成多個目標語言。 |
94
- | **發布** | `publish/publish-docs.mjs` | 管理將文件發布到 Discuss Kit 實例的流程。 |
95
- | **資料 I/O** | `utils/load-sources.mjs`, `utils/save-docs.mjs` | 負責讀取來源檔案並將最終的 markdown 文件寫入磁碟。 |
96
-
97
- 這種基於 Agent 的架構讓文件流程的每一步都由專門的工具處理,確保了工作流程的結構化和可維護性。
98
-
99
- ---
100
-
101
- 要了解 DocSmith 為確保輸出準確性和格式所採取的措施,請前往 [品質保證](./advanced-quality-assurance.md) 部分。
@@ -1,101 +0,0 @@
1
- # 工作原理
2
-
3
- AIGNE DocSmith 在一个多 Agent 系统上运行。它不是一个单一的整体流程,而是协调一个由专门的 AI Agent 组成的管道,其中每个 Agent 负责一项特定任务。这种方法允许通过一个结构化和模块化的流程将源代码转换为完整的文档。
4
-
5
- 该工具是更广泛的 AIGNE 生态系统的一个组成部分,该生态系统为开发和部署 AI 应用程序提供了一个平台。
6
-
7
- ![AIGNE 生态系统架构](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
8
-
9
- ## 文档生成管道
10
-
11
- DocSmith 的核心是一个通过几个不同阶段处理您的源代码的管道。每个阶段都由一个或多个专用 Agent 管理。主要工作流程通常由 `aigne doc generate` 命令启动,可以可视化如下:
12
-
13
- ```d2
14
- direction: down
15
-
16
- Input: {
17
- label: "源代码和配置"
18
- shape: rectangle
19
- }
20
-
21
- Pipeline: {
22
- label: "核心生成管道"
23
- shape: rectangle
24
- grid-columns: 1
25
- grid-gap: 40
26
-
27
- Structure-Planning: {
28
- label: "1. 结构规划"
29
- shape: rectangle
30
- }
31
-
32
- Content-Generation: {
33
- label: "2. 内容生成"
34
- shape: rectangle
35
- }
36
-
37
- Saving: {
38
- label: "3. 保存文档"
39
- shape: rectangle
40
- }
41
- }
42
-
43
- User-Feedback: {
44
- label: "用户反馈循环\n(通过 --feedback 标志)"
45
- shape: rectangle
46
- }
47
-
48
- Optional-Steps: {
49
- label: "可选的生成后步骤"
50
- shape: rectangle
51
- grid-columns: 2
52
- grid-gap: 40
53
-
54
- Translation: {
55
- label: "翻译\n(aigne doc translate)"
56
- shape: rectangle
57
- }
58
-
59
- Publishing: {
60
- label: "发布\n(aigne doc publish)"
61
- shape: rectangle
62
- }
63
- }
64
-
65
- Input -> Pipeline.Structure-Planning
66
- Pipeline.Structure-Planning -> Pipeline.Content-Generation
67
- Pipeline.Content-Generation -> Pipeline.Saving
68
- Pipeline.Saving -> Optional-Steps
69
-
70
- User-Feedback -> Pipeline.Structure-Planning: "优化结构"
71
- User-Feedback -> Pipeline.Content-Generation: "重新生成内容"
72
- ```
73
-
74
- 1. **输入分析**:当 Agent 加载您的源代码和项目配置(`aigne.yaml`)时,该过程开始。
75
-
76
- 2. **结构规划**:一个 Agent 分析代码库以提出一个逻辑化的文档结构。它会根据项目的构成和任何指定的规则创建一个大纲。
77
-
78
- 3. **内容生成**:结构确定后,内容生成 Agent 会为文档计划的每个部分填充详细的文本、代码示例和解释。
79
-
80
- 4. **优化和更新**:当您通过 `aigne doc update` 或 `aigne doc generate --feedback` 提供输入时,特定的 Agent 会被激活以更新单个文档或调整整体结构。
81
-
82
- 5. **翻译和发布**:在主要内容生成后,可选的 Agent 会处理多语言翻译和将最终文档发布到 Web 平台等任务。
83
-
84
- ## 关键 AI Agent
85
-
86
- DocSmith 的功能由项目配置中定义的一系列 Agent 提供。每个 Agent 都有特定的角色。下表列出了一些关键 Agent 及其功能。
87
-
88
- | 功能角色 | 关键 Agent 文件 | 描述 |
89
- | :--- | :--- | :--- |
90
- | **结构规划** | `generate/generate-structure.yaml` | 分析源代码以提出初始文档大纲。 |
91
- | **结构优化** | `generate/refine-document-structure.yaml` | 根据用户反馈修改文档结构。 |
92
- | **内容生成** | `update/batch-generate-document.yaml`, `update/generate-document.yaml` | 为文档结构的每个部分填充详细内容。 |
93
- | **翻译** | `translate/translate-document.yaml`, `translate/translate-multilingual.yaml` | 将生成的文档翻译成多种目标语言。 |
94
- | **发布** | `publish/publish-docs.mjs` | 管理将文档发布到 Discuss Kit 实例的过程。 |
95
- | **数据 I/O** | `utils/load-sources.mjs`, `utils/save-docs.mjs` | 负责读取源文件并将最终的 Markdown 文档写入磁盘。 |
96
-
97
- 这种基于 Agent 的架构允许文档流程的每一步都由专门的工具处理,从而确保一个结构化且可维护的工作流程。
98
-
99
- ---
100
-
101
- 要了解 DocSmith 为确保输出的准确性和格式而采取的措施,请继续阅读[质量保证](./advanced-quality-assurance.md)部分。
@@ -1,92 +0,0 @@
1
- # 品質保証
2
-
3
- 生成されるすべてのドキュメントが高い品質、一貫性、正確性の基準を満たすように、DocSmithには包括的で自動化された品質保証パイプラインが含まれています。これらの組み込みチェックは自動的に実行され、公開前に一般的なフォーマットエラー、リンク切れ、構造的な問題を特定してフラグを立てます。このプロセスにより、最終的な出力がプロフェッショナルで信頼性が高く、ユーザーがナビゲートしやすいものになることが保証されます。
4
-
5
- ```d2 品質保証パイプライン icon=lucide:shield-check
6
- direction: down
7
-
8
- Documentation-Content: {
9
- label: "ドキュメントコンテンツ"
10
- shape: rectangle
11
- }
12
-
13
- Quality-Assurance-Pipeline: {
14
- label: "品質保証パイプライン"
15
- shape: rectangle
16
- grid-columns: 3
17
- grid-gap: 50
18
-
19
- Markdown-Validation: {
20
- label: "1. Markdownとコンテンツの検証\n(remark-lintベース)"
21
- shape: rectangle
22
-
23
- Check-1: "有効なMarkdown構文"
24
- Check-2: "見出しの整合性"
25
- Check-3: "テーブルのフォーマット"
26
- Check-4: "コードブロックの整合性"
27
- Check-5: "コンテンツの完全性"
28
- }
29
-
30
- Link-Asset-Validation: {
31
- label: "2. リンクとアセットの整合性"
32
- shape: rectangle
33
-
34
- Check-6: "リンク切れの検出"
35
- Check-7: "ローカル画像の検証"
36
- }
37
-
38
- D2-Diagram-Validation: {
39
- label: "3. D2ダイアグラムの検証"
40
- shape: rectangle
41
-
42
- Check-8: "D2構文チェック"
43
- }
44
- }
45
-
46
- Validation-Result: {
47
- label: "すべてのチェックに合格?"
48
- shape: diamond
49
- }
50
-
51
- Published-Documentation: {
52
- label: "公開済みドキュメント"
53
- shape: rectangle
54
- style.fill: "#d4edda"
55
- }
56
-
57
- Error-Report: {
58
- label: "エラーレポート"
59
- shape: rectangle
60
- style.fill: "#f8d7da"
61
- }
62
-
63
- Documentation-Content -> Quality-Assurance-Pipeline: "入力"
64
- Quality-Assurance-Pipeline -> Validation-Result: "検証"
65
- Validation-Result -> Published-Documentation: "はい"
66
- Validation-Result -> Error-Report: "いいえ"
67
- ```
68
-
69
- ## Markdownとコンテンツ構造の検証
70
-
71
- 品質保証の基盤は、コアとなるMarkdownが整形され、構造的に健全であることを保証することです。DocSmithは`remark-lint`をベースにした高度なリンターを採用しており、一般的な構造上の問題を検出するためのカスタムチェックで補完されています。
72
-
73
- 主な構造およびフォーマットのチェックには、次のものが含まれます。
74
-
75
- * **有効なMarkdown構文**:標準のMarkdownおよびGFM(GitHub Flavored Markdown)仕様への準拠。
76
- * **見出しの整合性**:同一ドキュメント内の重複した見出し、不適切な見出しのインデント、複数のトップレベル見出し(H1)の使用などの問題を検出します。
77
- * **テーブルのフォーマット**:テーブル構造が正しいことを検証します。特に、ヘッダー、区切り線、およびデータ行の列数の不一致をチェックします。
78
- * **コードブロックの整合性**:すべてのコードブロックが ``` で適切に開始および終了していることを保証します。また、レンダリングに影響を与える可能性のある、コードブロック内の一貫性のないインデントもチェックします。
79
- * **コンテンツの完全性**:生成されたコンテンツが適切な句読点で終わっていることを確認し、コンテンツが切り捨てられていないことを保証する検証ステップです。
80
-
81
- ## リンクとアセットの整合性
82
-
83
- リンク切れや画像が見つからないことは、ユーザーエクスペリエンスを低下させます。DocSmithは、すべてのローカルリソースを検証するためのチェックを実行します。
84
-
85
- * **リンク切れの検出**:システムはすべての相対Markdownリンクをスキャンし、ターゲットパスがプロジェクトのドキュメント構造で定義された有効なドキュメントに対応していることを検証します。このチェックにより、ユーザーがドキュメントをナビゲートする際に「404 Not Found」エラーに遭遇するのを防ぎます。`http://`または`https://`で始まる外部リンクはチェックされません。
86
- * **ローカル画像の検証**:`![]()`を介して含まれるすべてのローカル画像について、バリデーターは参照されている画像ファイルが指定されたパスに存在することを確認します。これにより、最終的な出力に壊れた画像が表示されないようにします。
87
-
88
- ## D2ダイアグラムの検証
89
-
90
- すべてのダイアグラムが正しくレンダリングされることを保証するため、DocSmithはすべてのD2ダイアグラムの構文を検証します。
91
-
92
- `d2`とマークされた各コードブロックは、厳密な構文チェッカーによって処理されます。構文エラーが見つかった場合、生成プロセスは説明的なエラーメッセージとともに停止されます。これにより、壊れた、または不適切にレンダリングされた視覚的なダイアグラムを含むドキュメントの公開を防ぎます。
@@ -1,92 +0,0 @@
1
- # Quality Assurance
2
-
3
- To ensure that all generated documentation meets a high standard of quality, consistency, and accuracy, DocSmith includes a comprehensive, automated quality assurance pipeline. These built-in checks run automatically to identify and flag common formatting errors, broken links, and structural issues before publication. This process guarantees that the final output is professional, reliable, and easy for users to navigate.
4
-
5
- ```d2 Quality Assurance Pipeline icon=lucide:shield-check
6
- direction: down
7
-
8
- Documentation-Content: {
9
- label: "Documentation Content"
10
- shape: rectangle
11
- }
12
-
13
- Quality-Assurance-Pipeline: {
14
- label: "Quality Assurance Pipeline"
15
- shape: rectangle
16
- grid-columns: 3
17
- grid-gap: 50
18
-
19
- Markdown-Validation: {
20
- label: "1. Markdown & Content Validation\n(remark-lint based)"
21
- shape: rectangle
22
-
23
- Check-1: "Valid Markdown Syntax"
24
- Check-2: "Heading Integrity"
25
- Check-3: "Table Formatting"
26
- Check-4: "Code Block Integrity"
27
- Check-5: "Content Completeness"
28
- }
29
-
30
- Link-Asset-Validation: {
31
- label: "2. Link & Asset Integrity"
32
- shape: rectangle
33
-
34
- Check-6: "Dead Link Detection"
35
- Check-7: "Local Image Validation"
36
- }
37
-
38
- D2-Diagram-Validation: {
39
- label: "3. D2 Diagram Validation"
40
- shape: rectangle
41
-
42
- Check-8: "D2 Syntax Check"
43
- }
44
- }
45
-
46
- Validation-Result: {
47
- label: "All Checks Pass?"
48
- shape: diamond
49
- }
50
-
51
- Published-Documentation: {
52
- label: "Published Documentation"
53
- shape: rectangle
54
- style.fill: "#d4edda"
55
- }
56
-
57
- Error-Report: {
58
- label: "Error Report"
59
- shape: rectangle
60
- style.fill: "#f8d7da"
61
- }
62
-
63
- Documentation-Content -> Quality-Assurance-Pipeline: "Input"
64
- Quality-Assurance-Pipeline -> Validation-Result: "Validation"
65
- Validation-Result -> Published-Documentation: "Yes"
66
- Validation-Result -> Error-Report: "No"
67
- ```
68
-
69
- ## Markdown and Content Structure Validation
70
-
71
- The foundation of quality assurance is ensuring the core Markdown is well-formed and structurally sound. DocSmith employs a sophisticated linter based on `remark-lint`, supplemented with custom checks to catch common structural problems.
72
-
73
- Key structural and formatting checks include:
74
-
75
- * **Valid Markdown Syntax**: Adherence to standard Markdown and GFM (GitHub Flavored Markdown) specifications.
76
- * **Heading Integrity**: Detects issues such as duplicate headings within the same document, incorrect heading indentation, and the use of more than one top-level heading (H1).
77
- * **Table Formatting**: Verifies that table structures are correct, specifically checking for mismatches between the number of columns in the header, the separator line, and the data rows.
78
- * **Code Block Integrity**: Ensures that all code blocks are properly opened and closed with ```. It also checks for inconsistent indentation within a code block, which can affect rendering.
79
- * **Content Completeness**: A verification step to ensure that generated content does not appear truncated by checking that it ends with appropriate punctuation.
80
-
81
- ## Link and Asset Integrity
82
-
83
- Broken links and missing images degrade the user experience. DocSmith performs checks to validate all local resources.
84
-
85
- * **Dead Link Detection**: The system scans all relative Markdown links and verifies that the target path corresponds to a valid document defined in the project's documentation structure. This check prevents users from encountering "404 Not Found" errors when navigating the documentation. External links beginning with `http://` or `https://` are not checked.
86
- * **Local Image Validation**: For all local images included via `![]()`, the validator confirms that the referenced image file exists at the specified path. This ensures that no broken images appear in the final output.
87
-
88
- ## D2 Diagram Validation
89
-
90
- To guarantee that all diagrams are rendered correctly, DocSmith validates the syntax of every D2 diagram.
91
-
92
- Each code block marked with `d2` is processed through a strict syntax checker. If any syntax errors are found, the generation process is halted with a descriptive error message. This prevents the publication of documents containing broken or improperly rendered visual diagrams.
@@ -1,92 +0,0 @@
1
- # 品質保證
2
-
3
- 為確保所有產生的文件都符合高品質、一致性和準確性的標準,DocSmith 內建了一個全面、自動化的品質保證流程。這些內建的檢查會在發布前自動運行,以識別並標記常見的格式錯誤、失效連結和結構性問題。此過程確保最終的輸出成品具備專業性、可靠性,並讓使用者易於瀏覽。
4
-
5
- ```d2 品質保證流程 icon=lucide:shield-check
6
- direction: down
7
-
8
- Documentation-Content: {
9
- label: "文件內容"
10
- shape: rectangle
11
- }
12
-
13
- Quality-Assurance-Pipeline: {
14
- label: "品質保證流程"
15
- shape: rectangle
16
- grid-columns: 3
17
- grid-gap: 50
18
-
19
- Markdown-Validation: {
20
- label: "1. Markdown 與內容驗證\n(基於 remark-lint)"
21
- shape: rectangle
22
-
23
- Check-1: "有效的 Markdown 語法"
24
- Check-2: "標題完整性"
25
- Check-3: "表格格式"
26
- Check-4: "程式碼區塊完整性"
27
- Check-5: "內容完整性"
28
- }
29
-
30
- Link-Asset-Validation: {
31
- label: "2. 連結與資源完整性"
32
- shape: rectangle
33
-
34
- Check-6: "失效連結偵測"
35
- Check-7: "本地圖片驗證"
36
- }
37
-
38
- D2-Diagram-Validation: {
39
- label: "3. D2 圖表驗證"
40
- shape: rectangle
41
-
42
- Check-8: "D2 語法檢查"
43
- }
44
- }
45
-
46
- Validation-Result: {
47
- label: "所有檢查是否通過?"
48
- shape: diamond
49
- }
50
-
51
- Published-Documentation: {
52
- label: "已發布的文件"
53
- shape: rectangle
54
- style.fill: "#d4edda"
55
- }
56
-
57
- Error-Report: {
58
- label: "錯誤報告"
59
- shape: rectangle
60
- style.fill: "#f8d7da"
61
- }
62
-
63
- Documentation-Content -> Quality-Assurance-Pipeline: "輸入"
64
- Quality-Assurance-Pipeline -> Validation-Result: "驗證"
65
- Validation-Result -> Published-Documentation: "是"
66
- Validation-Result -> Error-Report: "否"
67
- ```
68
-
69
- ## Markdown 與內容結構驗證
70
-
71
- 品質保證的基礎是確保核心 Markdown 格式正確且結構健全。DocSmith 採用一個基於 `remark-lint` 的精密 linter,並輔以自訂檢查來捕捉常見的結構性問題。
72
-
73
- 主要的結構和格式檢查包括:
74
-
75
- * **有效的 Markdown 語法**:遵循標準 Markdown 和 GFM (GitHub Flavored Markdown) 規範。
76
- * **標題完整性**:偵測同一文件內的重複標題、不正確的標題縮排,以及使用超過一個頂層標題 (H1) 等問題。
77
- * **表格格式**:驗證表格結構是否正確,特別是檢查標頭、分隔線和資料列之間的欄位數量是否不匹配。
78
- * **程式碼區塊完整性**:確保所有程式碼區塊都以 ``` 正確地開啟和關閉。它還會檢查程式碼區塊內可能影響渲染結果的不一致縮排。
79
- * **內容完整性**:一個驗證步驟,透過檢查產生的內容是否以適當的標點符號結尾,來確保內容不會看似被截斷。
80
-
81
- ## 連結與資源完整性
82
-
83
- 失效連結和遺失的圖片會降低使用者體驗。DocSmith 會執行檢查以驗證所有本地資源。
84
-
85
- * **失效連結偵測**:系統會掃描所有相對 Markdown 連結,並驗證目標路徑是否對應到專案文件結構中定義的有效文件。此檢查可防止使用者在瀏覽文件時遇到「404 Not Found」錯誤。以 `http://` 或 `https://` 開頭的外部連結則不會被檢查。
86
- * **本地圖片驗證**:對於所有透過 `![]()` 包含的本地圖片,驗證器會確認所引用的圖片檔案是否存在於指定路徑。這能確保最終的輸出成品中不會出現破損的圖片。
87
-
88
- ## D2 圖表驗證
89
-
90
- 為保證所有圖表都能正確渲染,DocSmith 會驗證每個 D2 圖表的語法。
91
-
92
- 每個標記為 `d2` 的程式碼區塊都會經過嚴格的語法檢查器處理。若發現任何語法錯誤,產生過程將會被中止,並顯示一則描述性的錯誤訊息。這可以防止發布含有破損或渲染不當的視覺圖表的文件。
@@ -1,92 +0,0 @@
1
- # 质量保证
2
-
3
- 为确保所有生成的文档都符合高质量、一致性和准确性的标准,DocSmith 包含一个全面的自动化质量保证流程。这些内置检查会自动运行,以在发布前识别并标记常见的格式错误、断开的链接和结构性问题。此过程保证最终输出专业、可靠且易于用户浏览。
4
-
5
- ```d2 质量保证流程 icon=lucide:shield-check
6
- direction: down
7
-
8
- Documentation-Content: {
9
- label: "文档内容"
10
- shape: rectangle
11
- }
12
-
13
- Quality-Assurance-Pipeline: {
14
- label: "质量保证流程"
15
- shape: rectangle
16
- grid-columns: 3
17
- grid-gap: 50
18
-
19
- Markdown-Validation: {
20
- label: "1. Markdown 和内容验证\n(基于 remark-lint)"
21
- shape: rectangle
22
-
23
- Check-1: "有效的 Markdown 语法"
24
- Check-2: "标题完整性"
25
- Check-3: "表格格式"
26
- Check-4: "代码块完整性"
27
- Check-5: "内容完整性"
28
- }
29
-
30
- Link-Asset-Validation: {
31
- label: "2. 链接和资产完整性"
32
- shape: rectangle
33
-
34
- Check-6: "死链检测"
35
- Check-7: "本地图片验证"
36
- }
37
-
38
- D2-Diagram-Validation: {
39
- label: "3. D2 图表验证"
40
- shape: rectangle
41
-
42
- Check-8: "D2 语法检查"
43
- }
44
- }
45
-
46
- Validation-Result: {
47
- label: "所有检查是否通过?"
48
- shape: diamond
49
- }
50
-
51
- Published-Documentation: {
52
- label: "已发布的文档"
53
- shape: rectangle
54
- style.fill: "#d4edda"
55
- }
56
-
57
- Error-Report: {
58
- label: "错误报告"
59
- shape: rectangle
60
- style.fill: "#f8d7da"
61
- }
62
-
63
- Documentation-Content -> Quality-Assurance-Pipeline: "输入"
64
- Quality-Assurance-Pipeline -> Validation-Result: "验证"
65
- Validation-Result -> Published-Documentation: "是"
66
- Validation-Result -> Error-Report: "否"
67
- ```
68
-
69
- ## Markdown 和内容结构验证
70
-
71
- 质量保证的基础是确保核心 Markdown 格式良好且结构合理。DocSmith 采用基于 `remark-lint` 的精密 linter,并辅以自定义检查来捕获常见的结构性问题。
72
-
73
- 关键的结构和格式检查包括:
74
-
75
- * **有效的 Markdown 语法**:遵循标准 Markdown 和 GFM(GitHub Flavored Markdown)规范。
76
- * **标题完整性**:检测同一文档中重复的标题、不正确的标题缩进以及使用多个顶级标题(H1)等问题。
77
- * **表格格式**:验证表格结构是否正确,特别是检查表头、分隔行和数据行之间的列数是否不匹配。
78
- * **代码块完整性**:确保所有代码块都使用 ``` 正确地开始和结束。它还会检查代码块内不一致的缩进,这可能会影响渲染。
79
- * **内容完整性**:一个验证步骤,通过检查生成的内容是否以适当的标点符号结尾,来确保内容没有被截断。
80
-
81
- ## 链接和资产完整性
82
-
83
- 断开的链接和缺失的图片会降低用户体验。DocSmith 会执行检查以验证所有本地资源。
84
-
85
- * **死链检测**:系统会扫描所有相对 Markdown 链接,并验证目标路径是否对应于项目文档结构中定义的有效文档。此检查可防止用户在浏览文档时遇到“404 Not Found”错误。以 `http://` 或 `https://` 开头的外部链接不会被检查。
86
- * **本地图片验证**:对于所有通过 `![]()` 包含的本地图片,验证器会确认引用的图片文件是否存在于指定路径。这可以确保最终输出中不会出现损坏的图片。
87
-
88
- ## D2 图表验证
89
-
90
- 为保证所有图表都能正确渲染,DocSmith 会验证每个 D2 图表的语法。
91
-
92
- 每个标记为 `d2` 的代码块都会经过严格的语法检查器处理。如果发现任何语法错误,生成过程将停止并显示描述性错误消息。这可以防止发布包含损坏或渲染不当的可视图表的文档。
@@ -1,20 +0,0 @@
1
- # 高度なトピック
2
-
3
- このセクションでは、AIGNE DocSmithの内部アーキテクチャと動作メカニズムについて詳しく説明します。このセクションは、ツールの機能についてより深く理解したいユーザーを対象としており、高度なカスタマイズやプロジェクトへの貢献に役立ちます。この情報は、標準的な使用には必要ありません。
4
-
5
- DocSmithは、AIアプリケーション開発のプラットフォームを提供するAIGNEエコシステムのコンポーネントです。次の図は、全体のアーキテクチャを示しています。
6
-
7
- ![AIGNEエコシステムのアーキテクチャ](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
8
-
9
- DocSmith内の特定のプロセスと品質管理手段については、以下の詳細なセクションを参照してください。
10
-
11
- <x-cards data-columns="2">
12
- <x-card data-title="仕組み" data-href="/advanced/how-it-works" data-icon="lucide:cpu">
13
- DocSmithのアーキテクチャ概要。ドキュメント生成パイプラインにおけるAI Agentの役割を説明します。
14
- </x-card>
15
- <x-card data-title="品質保証" data-href="/advanced/quality-assurance" data-icon="lucide:shield-check">
16
- リンクチェックやダイアグラム検証など、適切にフォーマットされエラーのないドキュメントを保証するためにDocSmithが実行する組み込みチェックについて理解します。
17
- </x-card>
18
- </x-cards>
19
-
20
- これらのトピックを確認することで、DocSmithの機能を包括的に理解することができます。利用可能なすべてのコマンドとそのパラメータの完全なリファレンスについては、[CLIコマンドリファレンス](./cli-reference.md)を参照してください。
package/docs/advanced.md DELETED
@@ -1,20 +0,0 @@
1
- # Advanced Topics
2
-
3
- This section provides a detailed examination of the internal architecture and operational mechanics of AIGNE DocSmith. It is intended for users who wish to gain a deeper understanding of how the tool functions, which can be beneficial for advanced customization or contributing to the project. This information is not required for standard use.
4
-
5
- DocSmith is a component of the AIGNE ecosystem, which provides a platform for AI application development. The following diagram illustrates the overall architecture.
6
-
7
- ![AIGNE Ecosystem Architecture](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
8
-
9
- To explore the specific processes and quality control measures within DocSmith, refer to the following detailed sections.
10
-
11
- <x-cards data-columns="2">
12
- <x-card data-title="How It Works" data-href="/advanced/how-it-works" data-icon="lucide:cpu">
13
- An architectural overview of DocSmith, explaining the role of AI agents in the documentation generation pipeline.
14
- </x-card>
15
- <x-card data-title="Quality Assurance" data-href="/advanced/quality-assurance" data-icon="lucide:shield-check">
16
- Understand the built-in checks DocSmith performs to ensure well-formatted and error-free documentation, including link checking and diagram validation.
17
- </x-card>
18
- </x-cards>
19
-
20
- By reviewing these topics, you can develop a comprehensive understanding of DocSmith's functionality. For a complete reference of all available commands and their parameters, please see the [CLI Command Reference](./cli-reference.md).
@@ -1,20 +0,0 @@
1
- # 進階主題
2
-
3
- 本節詳細介紹 AIGNE DocSmith 的內部架構和運作機制。它專為希望深入了解該工具如何運作的使用者而設計,這對於進階自訂或為專案做出貢獻非常有益。標準使用不需要這些資訊。
4
-
5
- DocSmith 是 AIGNE 生態系的一個元件,該生態系為 AI 應用程式開發提供了一個平台。下圖說明了整體架構。
6
-
7
- ![AIGNE 生態系架構](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
8
-
9
- 若要探索 DocSmith 內的具體流程和品質控制措施,請參閱以下詳細章節。
10
-
11
- <x-cards data-columns="2">
12
- <x-card data-title="運作方式" data-href="/advanced/how-it-works" data-icon="lucide:cpu">
13
- DocSmith 的架構概覽,解釋 AI agent 在文件生成流程中的角色。
14
- </x-card>
15
- <x-card data-title="品質保證" data-href="/advanced/quality-assurance" data-icon="lucide:shield-check">
16
- 了解 DocSmith 執行的內建檢查,以確保文件格式正確且無錯誤,包括連結檢查和圖表驗證。
17
- </x-card>
18
- </x-cards>
19
-
20
- 透過回顧這些主題,您可以全面了解 DocSmith 的功能。有關所有可用指令及其參數的完整參考,請參閱 [CLI 指令參考](./cli-reference.md)。
@@ -1,20 +0,0 @@
1
- # 高级主题
2
-
3
- 本节详细阐述了 AIGNE DocSmith 的内部架构和运行机制。本节面向希望深入了解该工具工作原理的用户,这对于高级定制或为项目做出贡献大有裨益。标准使用无需了解这些信息。
4
-
5
- DocSmith 是 AIGNE 生态系统的一个组件,该生态系统为 AI 应用开发提供了一个平台。下图展示了其整体架构。
6
-
7
- ![AIGNE 生态系统架构](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
8
-
9
- 要了解 DocSmith 内部的具体流程和质量控制措施,请参阅以下详细章节。
10
-
11
- <x-cards data-columns="2">
12
- <x-card data-title="工作原理" data-href="/advanced/how-it-works" data-icon="lucide:cpu">
13
- DocSmith 的架构概述,解释了 AI Agent 在文档生成流程中的作用。
14
- </x-card>
15
- <x-card data-title="质量保证" data-href="/advanced/quality-assurance" data-icon="lucide:shield-check">
16
- 了解 DocSmith 为确保文档格式正确、无错误而执行的内置检查,包括链接检查和图表验证。
17
- </x-card>
18
- </x-cards>
19
-
20
- 通过阅读这些主题,您可以全面了解 DocSmith 的功能。有关所有可用命令及其参数的完整参考,请参阅 [CLI 命令参考](./cli-reference.md)。