@aigne/doc-smith 0.8.11-beta.5 → 0.8.11-beta.7

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 (159) hide show
  1. package/.aigne/doc-smith/config.yaml +3 -1
  2. package/.aigne/doc-smith/output/structure-plan.json +2 -2
  3. package/.aigne/doc-smith/preferences.yml +28 -20
  4. package/.aigne/doc-smith/upload-cache.yaml +702 -0
  5. package/.release-please-manifest.json +1 -1
  6. package/CHANGELOG.md +22 -2
  7. package/README.md +2 -2
  8. package/agents/clear/choose-contents.mjs +2 -2
  9. package/agents/clear/clear-document-structure.mjs +8 -8
  10. package/agents/clear/index.yaml +1 -1
  11. package/agents/evaluate/document-structure.yaml +1 -1
  12. package/agents/generate/check-document-structure.yaml +3 -3
  13. package/agents/generate/check-need-generate-structure.mjs +8 -8
  14. package/agents/generate/document-structure-tools/add-document.mjs +38 -13
  15. package/agents/generate/document-structure-tools/delete-document.mjs +37 -14
  16. package/agents/generate/document-structure-tools/move-document.mjs +46 -19
  17. package/agents/generate/document-structure-tools/update-document.mjs +39 -12
  18. package/agents/generate/generate-structure.yaml +1 -1
  19. package/agents/generate/update-document-structure.yaml +3 -9
  20. package/agents/generate/user-review-document-structure.mjs +15 -14
  21. package/agents/translate/translate-document.yaml +1 -9
  22. package/agents/update/batch-generate-document.yaml +1 -1
  23. package/agents/update/check-document.mjs +2 -2
  24. package/agents/update/check-update-is-single.mjs +2 -1
  25. package/agents/update/document-tools/update-document-content.mjs +24 -14
  26. package/agents/update/fs-tools/glob.mjs +184 -0
  27. package/agents/update/fs-tools/grep.mjs +317 -0
  28. package/agents/update/fs-tools/read-file.mjs +307 -0
  29. package/agents/update/generate-document.yaml +4 -7
  30. package/agents/update/update-document-detail.yaml +6 -10
  31. package/agents/update/user-review-document.mjs +13 -13
  32. package/agents/utils/check-feedback-refiner.mjs +1 -1
  33. package/agents/utils/choose-docs.mjs +1 -1
  34. package/agents/utils/load-document-all-content.mjs +3 -3
  35. package/agents/utils/load-sources.mjs +1 -1
  36. package/agents/utils/save-docs.mjs +7 -28
  37. package/aigne.yaml +2 -2
  38. package/assets/screenshots/doc-complete-setup.png +0 -0
  39. package/assets/screenshots/doc-generate-docs.png +0 -0
  40. package/assets/screenshots/doc-generate.png +0 -0
  41. package/assets/screenshots/doc-generated-successfully.png +0 -0
  42. package/assets/screenshots/doc-publish.png +0 -0
  43. package/assets/screenshots/doc-regenerate.png +0 -0
  44. package/assets/screenshots/doc-translate-langs.png +0 -0
  45. package/assets/screenshots/doc-translate.png +0 -0
  46. package/assets/screenshots/doc-update.png +0 -0
  47. package/docs/_sidebar.md +1 -1
  48. package/docs/advanced-how-it-works.ja.md +31 -31
  49. package/docs/advanced-how-it-works.md +10 -10
  50. package/docs/advanced-how-it-works.zh-TW.md +24 -24
  51. package/docs/advanced-how-it-works.zh.md +20 -20
  52. package/docs/advanced-quality-assurance.ja.md +57 -61
  53. package/docs/advanced-quality-assurance.md +57 -61
  54. package/docs/advanced-quality-assurance.zh-TW.md +57 -61
  55. package/docs/advanced-quality-assurance.zh.md +57 -61
  56. package/docs/advanced.ja.md +8 -4
  57. package/docs/advanced.md +7 -3
  58. package/docs/advanced.zh-TW.md +9 -5
  59. package/docs/advanced.zh.md +9 -5
  60. package/docs/changelog.ja.md +206 -29
  61. package/docs/changelog.md +177 -0
  62. package/docs/changelog.zh-TW.md +229 -52
  63. package/docs/changelog.zh.md +204 -27
  64. package/docs/cli-reference.ja.md +181 -80
  65. package/docs/cli-reference.md +168 -67
  66. package/docs/cli-reference.zh-TW.md +177 -76
  67. package/docs/cli-reference.zh.md +172 -71
  68. package/docs/configuration-interactive-setup.ja.md +45 -42
  69. package/docs/configuration-interactive-setup.md +9 -6
  70. package/docs/configuration-interactive-setup.zh-TW.md +26 -23
  71. package/docs/configuration-interactive-setup.zh.md +25 -22
  72. package/docs/configuration-language-support.ja.md +33 -63
  73. package/docs/configuration-language-support.md +32 -62
  74. package/docs/configuration-language-support.zh-TW.md +35 -65
  75. package/docs/configuration-language-support.zh.md +32 -62
  76. package/docs/configuration-llm-setup.ja.md +25 -23
  77. package/docs/configuration-llm-setup.md +20 -18
  78. package/docs/configuration-llm-setup.zh-TW.md +21 -19
  79. package/docs/configuration-llm-setup.zh.md +20 -18
  80. package/docs/configuration-preferences.ja.md +67 -52
  81. package/docs/configuration-preferences.md +55 -40
  82. package/docs/configuration-preferences.zh-TW.md +69 -54
  83. package/docs/configuration-preferences.zh.md +68 -53
  84. package/docs/configuration.ja.md +98 -58
  85. package/docs/configuration.md +42 -2
  86. package/docs/configuration.zh-TW.md +86 -46
  87. package/docs/configuration.zh.md +76 -36
  88. package/docs/features-generate-documentation.ja.md +49 -55
  89. package/docs/features-generate-documentation.md +49 -55
  90. package/docs/features-generate-documentation.zh-TW.md +54 -60
  91. package/docs/features-generate-documentation.zh.md +48 -54
  92. package/docs/features-publish-your-docs.ja.md +68 -45
  93. package/docs/features-publish-your-docs.md +65 -42
  94. package/docs/features-publish-your-docs.zh-TW.md +74 -51
  95. package/docs/features-publish-your-docs.zh.md +67 -44
  96. package/docs/features-translate-documentation.ja.md +46 -35
  97. package/docs/features-translate-documentation.md +39 -28
  98. package/docs/features-translate-documentation.zh-TW.md +45 -34
  99. package/docs/features-translate-documentation.zh.md +39 -28
  100. package/docs/features-update-and-refine.ja.md +75 -71
  101. package/docs/features-update-and-refine.md +67 -63
  102. package/docs/features-update-and-refine.zh-TW.md +72 -67
  103. package/docs/features-update-and-refine.zh.md +71 -67
  104. package/docs/features.ja.md +29 -19
  105. package/docs/features.md +25 -15
  106. package/docs/features.zh-TW.md +28 -18
  107. package/docs/features.zh.md +31 -21
  108. package/docs/getting-started.ja.md +43 -46
  109. package/docs/getting-started.md +36 -39
  110. package/docs/getting-started.zh-TW.md +41 -44
  111. package/docs/getting-started.zh.md +39 -42
  112. package/docs/overview.ja.md +63 -11
  113. package/docs/overview.md +62 -10
  114. package/docs/overview.zh-TW.md +67 -15
  115. package/docs/overview.zh.md +62 -10
  116. package/docs-mcp/analyze-docs-relevance.yaml +6 -6
  117. package/docs-mcp/docs-search.yaml +1 -1
  118. package/media.md +9 -9
  119. package/package.json +2 -2
  120. package/prompts/common/document-structure/conflict-resolution-guidance.md +3 -3
  121. package/prompts/common/document-structure/document-structure-rules.md +2 -2
  122. package/prompts/detail/custom/custom-components.md +304 -188
  123. package/prompts/detail/document-rules.md +5 -5
  124. package/prompts/detail/generate-document.md +21 -8
  125. package/prompts/detail/update-document.md +8 -12
  126. package/prompts/evaluate/document-structure.md +6 -6
  127. package/prompts/structure/check-document-structure.md +10 -10
  128. package/prompts/structure/document-rules.md +2 -2
  129. package/prompts/structure/generate-structure-system.md +3 -3
  130. package/prompts/structure/structure-example.md +1 -1
  131. package/prompts/structure/structure-getting-started.md +1 -1
  132. package/prompts/structure/update-document-structure.md +18 -14
  133. package/prompts/utils/feedback-refiner.md +3 -3
  134. package/tests/agents/clear/choose-contents.test.mjs +1 -1
  135. package/tests/agents/clear/clear-document-structure.test.mjs +36 -30
  136. package/tests/agents/evaluate/generate-report.test.mjs +1 -1
  137. package/tests/agents/generate/check-need-generate-structure.test.mjs +1 -1
  138. package/tests/agents/generate/document-structure-tools/add-document.test.mjs +2 -2
  139. package/tests/agents/generate/document-structure-tools/delete-document.test.mjs +4 -4
  140. package/tests/agents/generate/document-structure-tools/move-document.test.mjs +12 -12
  141. package/tests/agents/generate/document-structure-tools/update-document.test.mjs +3 -3
  142. package/tests/agents/generate/user-review-document-structure.test.mjs +36 -13
  143. package/tests/agents/update/check-document.test.mjs +1 -1
  144. package/tests/agents/update/document-tools/update-document-content.test.mjs +115 -112
  145. package/tests/agents/update/fs-tools/glob.test.mjs +438 -0
  146. package/tests/agents/update/fs-tools/grep.test.mjs +279 -0
  147. package/tests/agents/update/fs-tools/read-file.test.mjs +553 -0
  148. package/tests/agents/update/user-review-document.test.mjs +48 -27
  149. package/tests/agents/utils/format-document-structure.test.mjs +5 -5
  150. package/tests/agents/utils/load-sources.test.mjs +4 -4
  151. package/tests/agents/utils/save-docs.test.mjs +1 -1
  152. package/tests/utils/conflict-detector.test.mjs +1 -1
  153. package/tests/utils/docs-finder-utils.test.mjs +8 -8
  154. package/types/document-schema.mjs +5 -6
  155. package/types/document-structure-schema.mjs +25 -13
  156. package/utils/conflict-detector.mjs +1 -1
  157. package/utils/constants/index.mjs +4 -4
  158. package/utils/docs-finder-utils.mjs +11 -11
  159. package/utils/markdown-checker.mjs +1 -1
@@ -1,6 +1,6 @@
1
1
  # 互動式設定
2
2
 
3
- AIGNE DocSmith 包含一個互動式設定精靈,可透過 `aigne doc init` 指令啟動,以簡化專案設定。此引導式流程會詢問一系列關於您文件目標的問題,並根據您的回答產生一個 `config.yaml` 檔案。這是開始新文件專案的建議方法,因為它有助於防止設定錯誤,並根據您的輸入提供具體建議。
3
+ AIGNE DocSmith 包含一個互動式設定精靈,可透過 `aigne doc init` 指令啟動,用以簡化專案設定。此引導式流程會詢問一系列關於您文件目標的問題,並根據您的回答產生一個 `config.yaml` 檔案。這是開始新文件專案的建議方法,因為它有助於防止設定錯誤,並根據您的輸入提供具體建議。
4
4
 
5
5
  ## 執行精靈
6
6
 
@@ -10,14 +10,14 @@ AIGNE DocSmith 包含一個互動式設定精靈,可透過 `aigne doc init`
10
10
  npx aigne doc init
11
11
  ```
12
12
 
13
- 精靈接著會引導您完成一個 8 步驟的流程來設定您的文件。
13
+ 接著,此精靈將引導您完成一個 8 步驟的流程來設定您的文件。
14
14
 
15
15
  ## 引導式流程
16
16
 
17
- 精靈會提示您輸入以下關鍵設定詳細資訊:
17
+ 此精靈會提示您輸入以下關鍵設定細節:
18
18
 
19
- 1. **主要目標**:定義讀者的主要目的(例如,開始使用、尋找答案)。
20
- 2. **目標受眾**:指明文件的主要讀者(例如,非技術性終端使用者、開發人員)。
19
+ 1. **主要目標**:定義讀者的主要目的(例如:快速入門、尋找答案)。
20
+ 2. **目標受眾**:指明文件的主要讀者(例如:非技術背景的終端使用者、開發人員)。
21
21
  3. **讀者知識水平**:評估您受眾的典型起始知識水平。
22
22
  4. **文件深度**:決定內容的詳細程度和範圍。
23
23
  5. **主要語言**:設定文件的主要語言。
@@ -27,7 +27,7 @@ npx aigne doc init
27
27
 
28
28
  ## 輔助設定
29
29
 
30
- 精靈使用一組預定義的規則來幫助您建立一個一致且有效的設定。
30
+ 此精靈使用一組預定義的規則來幫助您建立一個一致且有效的設定。
31
31
 
32
32
  ```d2
33
33
  direction: down
@@ -54,12 +54,12 @@ Wizard-Engine: {
54
54
  Guided-Experience: {
55
55
  label: "3. 引導式體驗"
56
56
  shape: rectangle
57
- content: "使用者看到簡化且相關的選項"
57
+ content: "使用者看到簡化、相關的選項"
58
58
  }
59
59
 
60
60
  Final-Config: {
61
61
  label: "4. 最終設定"
62
- content: "config.yaml 產生時帶有\n衝突解決策略"
62
+ content: "config.yaml 根據\n衝突解決策略產生"
63
63
  }
64
64
 
65
65
  User-Selections -> Wizard-Engine
@@ -68,34 +68,33 @@ Wizard-Engine.Conflict-Detection -> Final-Config
68
68
  Guided-Experience -> User-Selections: "優化"
69
69
  ```
70
70
 
71
- ### 預設建議與選項篩選
71
+ ### 選項篩選
72
72
 
73
- 當您進行選擇時,精靈會提供預設值並篩選後續選項,以引導您進行邏輯性的設定。這是基於一組跨問題的衝突規則。
73
+ 當您進行選擇時,精靈會篩選後續選項,引導您達成一個合乎邏輯的設定。這是基於一組跨問題的衝突規則,用以防止不相容的選擇。
74
74
 
75
- - **預設建議**:如果您選擇「快速入門」作為主要目標,精靈會建議將讀者的知識水平設定為「完全是初學者」。
76
- - **即時篩選**:如果您的目標受眾是「終端使用者(非技術人員)」,精靈將會隱藏「是專家」的知識水平選項。此規則的理由是非技術使用者通常不是經驗豐富的技術使用者,從而防止不相容的選擇。
75
+ 例如,如果您選擇「終端使用者(非技術背景)」作為您的目標受眾,精靈將會隱藏「是專家」這個知識水平選項。該規則的理由是「非技術背景的使用者通常不是經驗豐富的技術使用者」,從而防止不合邏輯的選擇。
77
76
 
78
77
  ### 衝突偵測與解決
79
78
 
80
- 在某些情況下,您可能有多個目標或受眾,需要特定的文件結構才能有效,例如為非技術性的**終端使用者**和專家級的**開發人員**建立文件。精靈會將這些情況識別為「可解決的衝突」。
79
+ 在某些情況下,您可能有多個目標或受眾,需要特定的文件結構才能有效,例如為非技術背景的**終端使用者**和專業的**開發人員**建立文件。精靈將這些情況識別為「可解決的衝突」。
81
80
 
82
- 然後,它會制定一個策略,在文件結構中解決這些需求。對於終端使用者與開發人員的例子,解決策略是建立獨立的使用者路徑:
81
+ 然後,它會制定一個策略,在文件結構內解決這些需求。以終端使用者與開發人員的例子來說,解決策略是建立獨立的使用者路徑:
83
82
 
84
- - **使用者指南路徑**:使用淺顯的語言,專注於 UI 互動,並以業務成果為導向。
85
- - **開發人員指南路徑**:以程式碼為優先,技術上精確,並包含 SDK 範例和設定片段。
83
+ - **使用者指南路徑**:使用淺顯的語言,專注於使用者介面互動,並以業務成果為導向。
84
+ - **開發人員指南路徑**:以程式碼優先,技術上精確,並包含 SDK 範例和設定片段。
86
85
 
87
- 這種方法確保最終的文件結構能夠有效地服務多個受眾,而不是建立單一、混亂的內容組合。
86
+ 這種方法確保最終的文件結構能有效地服務多個受眾,而不是創造一個單一、混亂的內容組合。
88
87
 
89
88
  ## 產生的輸出
90
89
 
91
- 完成精靈後,它會在您的專案中儲存一個 `config.yaml` 檔案。此檔案有完整的註解,解釋了每個選項並列出了所有可用的選擇,使其易於稍後手動檢閱和修改。
90
+ 完成精靈後,它會在您的專案中儲存一個 `config.yaml` 檔案。這個檔案有完整的註解,解釋了每個選項並列出了所有可用選擇,使其易於日後手動檢視和修改。
92
91
 
93
92
  以下是產生的檔案片段:
94
93
 
95
94
  ```yaml config.yaml icon=logos:yaml
96
95
  # 用於文件發布的專案資訊
97
96
  projectName: your-project-name
98
- projectDesc: 您的專案描述。
97
+ projectDesc: Your project description.
99
98
  projectLogo: ""
100
99
 
101
100
  # =============================================================================
@@ -110,10 +109,10 @@ documentPurpose:
110
109
  - completeTasks
111
110
  - findAnswers
112
111
 
113
- # 目標受眾:誰會最常閱讀此文件?
112
+ # 目標受眾:誰會最常閱讀這份文件?
114
113
  # 可用選項(取消註解並視需要修改):
115
- # endUsers - 終端使用者(非技術人員):使用產品但不編寫程式碼的人
116
- # developers - 開發人員整合您的產品/API:將此產品/API 加入其專案的工程師
114
+ # endUsers - 終端使用者(非技術背景):使用產品但不寫程式的人
115
+ # developers - 開發人員整合您的產品/API:將此加入其專案的工程師
117
116
  targetAudienceTypes:
118
117
  - endUsers
119
118
  - developers
@@ -121,6 +120,10 @@ targetAudienceTypes:
121
120
  # ... 其他設定
122
121
  ```
123
122
 
123
+ 完成後,您將在終端機中看到一條確認訊息。
124
+
125
+ ![一個終端機視窗,顯示互動式設定精靈已成功完成。](../assets/screenshots/doc-complete-setup.png)
126
+
124
127
  ## 後續步驟
125
128
 
126
129
  設定檔案就緒後,您就可以產生、翻譯或發布您的文件了。
@@ -130,6 +133,6 @@ targetAudienceTypes:
130
133
  了解如何使用單一指令從您的原始碼自動建立一套完整的文件。
131
134
  </x-card>
132
135
  <x-card data-title="設定指南" data-icon="lucide:settings" data-href="/configuration">
133
- 深入了解所有可用的設定,並學習如何手動微調 config.yaml 檔案。
136
+ 深入了解所有可用設定,並學習如何手動微調 config.yaml 檔案。
134
137
  </x-card>
135
138
  </x-cards>
@@ -1,33 +1,33 @@
1
1
  # 交互式设置
2
2
 
3
- AIGNE DocSmith 包含一个交互式设置向导,通过 `aigne doc init` 命令启动,用于简化项目配置。这个引导式过程会询问一系列关于您的文档目标的问题,并根据您的回答生成一个 `config.yaml` 文件。这是启动新文档项目的推荐方法,因为它有助于防止配置错误,并根据您的输入提供具体建议。
3
+ AIGNE DocSmith 包含一个交互式设置向导,通过 `aigne doc init` 命令启动,用于简化项目配置。这个引导式过程会询问一系列关于您文档目标的问题,并根据您的回答生成一个 `config.yaml` 文件。这是启动新文档项目的推荐方法,因为它有助于防止配置错误,并根据您的输入提供具体建议。
4
4
 
5
5
  ## 运行向导
6
6
 
7
- 要开始此过程,请在项目的根目录中运行以下命令:
7
+ 要开始此过程,请在您的项目根目录中运行以下命令:
8
8
 
9
9
  ```bash aigne doc init icon=lucide:sparkles
10
10
  npx aigne doc init
11
11
  ```
12
12
 
13
- 然后,向导将引导您完成一个 8 步过程来配置您的文档。
13
+ 然后,向导将引导您完成一个 8 步流程来配置您的文档。
14
14
 
15
- ## 引导式过程
15
+ ## 引导式流程
16
16
 
17
- 向导会提示您输入以下关键配置细节:
17
+ 向导会提示您输入以下关键配置详情:
18
18
 
19
19
  1. **主要目标**:定义读者的主要目的(例如,快速入门、寻找答案)。
20
- 2. **目标受众**:指定文档的主要读者(例如,非技术最终用户、开发者)。
20
+ 2. **目标受众**:明确文档的主要读者(例如,非技术最终用户、开发者)。
21
21
  3. **读者知识水平**:评估受众的典型初始知识水平。
22
22
  4. **文档深度**:确定内容的详细程度和范围。
23
23
  5. **主要语言**:设置文档的主要语言。
24
24
  6. **翻译语言**:选择用于翻译的其他语言。
25
- 7. **输出目录**:指定生成的文档文件的位置。
25
+ 7. **输出目录**:指定生成文档文件的位置。
26
26
  8. **源代码路径**:定义要分析的文件和目录,支持 glob 模式。
27
27
 
28
28
  ## 辅助配置
29
29
 
30
- 向导使用一套预定义的规则来帮助您创建连贯且有效的配置。
30
+ 向导使用一套预定义规则来帮助您创建连贯有效的配置。
31
31
 
32
32
  ```d2
33
33
  direction: down
@@ -59,7 +59,7 @@ Guided-Experience: {
59
59
 
60
60
  Final-Config: {
61
61
  label: "4. 最终配置"
62
- content: "生成 config.yaml 并包含\n冲突解决策略"
62
+ content: "config.yaml 生成时\n包含冲突解决策略"
63
63
  }
64
64
 
65
65
  User-Selections -> Wizard-Engine
@@ -68,43 +68,42 @@ Wizard-Engine.Conflict-Detection -> Final-Config
68
68
  Guided-Experience -> User-Selections: "优化"
69
69
  ```
70
70
 
71
- ### 默认建议和选项过滤
71
+ ### 选项过滤
72
72
 
73
- 当您进行选择时,向导会提供默认值并过滤后续选项,以引导您进行逻辑配置。这是基于一套跨问题冲突规则。
73
+ 在您做出选择时,向导会过滤后续选项,以引导您进行逻辑配置。这是基于一套跨问题冲突规则,可防止不兼容的选择。
74
74
 
75
- - **默认建议**:如果您选择“快速入门”作为主要目标,向导将推荐“完全是初学者”作为读者的知识水平。
76
- - **实时过滤**:如果您的目标受众是“最终用户(非技术人员)”,向导将隐藏“是专家”这个知识水平选项。该规则的理由是,非技术用户通常不是经验丰富的技术用户,从而防止了不兼容的选择。
75
+ 例如,如果您选择“最终用户(非技术)”作为目标受众,向导将隐藏“是专家”这一知识水平选项。该规则的理由是“非技术用户通常不是经验丰富的技术用户”,从而防止不合逻辑的选择。
77
76
 
78
77
  ### 冲突检测与解决
79
78
 
80
79
  在某些情况下,您可能有多个目标或受众,需要特定的文档结构才能有效,例如为非技术的**最终用户**和专业的**开发者**创建文档。向导将这些情况识别为“可解决的冲突”。
81
80
 
82
- 然后,它会制定一个策略来在文档结构中满足这些需求。对于最终用户与开发者的例子,解决策略是创建独立的用户路径:
81
+ 然后,它会制定一个策略,在文档结构中满足这些需求。对于最终用户与开发者的例子,解决方法是创建独立的用户路径:
83
82
 
84
- - **用户指南路径**:使用通俗易懂的语言,侧重于 UI 交互,并面向业务成果。
83
+ - **用户指南路径**:使用通俗易懂的语言,侧重于 UI 交互,并以业务成果为导向。
85
84
  - **开发者指南路径**:代码优先,技术上精确,并包含 SDK 示例和配置片段。
86
85
 
87
86
  这种方法确保最终的文档结构能够有效地服务于多个受众,而不是创建一个单一、混乱的内容混合体。
88
87
 
89
88
  ## 生成的输出
90
89
 
91
- 完成向导后,它会在您的项目中保存一个 `config.yaml` 文件。该文件带有完整的注释,解释了每个选项并列出了所有可用选择,这使得以后手动审查和修改变得容易。
90
+ 完成向导后,它会在您的项目中保存一个 `config.yaml` 文件。该文件有完整的注释,解释了每个选项并列出了所有可用选项,便于以后手动审查和修改。
92
91
 
93
92
  以下是生成文件的片段:
94
93
 
95
94
  ```yaml config.yaml icon=logos:yaml
96
95
  # 用于文档发布的项目信息
97
96
  projectName: your-project-name
98
- projectDesc: 您的项目描述。
97
+ projectDesc: Your project description.
99
98
  projectLogo: ""
100
99
 
101
100
  # =============================================================================
102
101
  # 文档配置
103
102
  # =============================================================================
104
103
 
105
- # 目的:您希望读者达到的主要结果是什么?
104
+ # 目的:您希望读者达成的最主要成果是什么?
106
105
  # 可用选项(根据需要取消注释并修改):
107
- # getStarted - 快速入门:帮助新用户在 <30 分钟内从零到上手
106
+ # getStarted - 快速入门:帮助新用户在 30 分钟内从零开始上手
108
107
  # completeTasks - 完成特定任务:引导用户完成常见工作流程和用例
109
108
  documentPurpose:
110
109
  - completeTasks
@@ -112,8 +111,8 @@ documentPurpose:
112
111
 
113
112
  # 目标受众:谁会最常阅读这份文档?
114
113
  # 可用选项(根据需要取消注释并修改):
115
- # endUsers - 最终用户(非技术人员):使用产品但不编码的人
116
- # developers - 开发者(集成您的产品/API):将此添加到其项目中的工程师
114
+ # endUsers - 最终用户(非技术):使用产品但不编写代码的人
115
+ # developers - 集成您的产品/API 的开发者:将此产品添加到其项目中的工程师
117
116
  targetAudienceTypes:
118
117
  - endUsers
119
118
  - developers
@@ -121,9 +120,13 @@ targetAudienceTypes:
121
120
  # ... 其他设置
122
121
  ```
123
122
 
123
+ 完成后,您将在终端中看到一条确认消息。
124
+
125
+ ![一个终端窗口,显示交互式设置向导成功完成。](../assets/screenshots/doc-complete-setup.png)
126
+
124
127
  ## 后续步骤
125
128
 
126
- 配置文件就位后,您就可以生成、翻译或发布您的文档了。
129
+ 配置文件就绪后,您就可以生成、翻译或发布您的文档了。
127
130
 
128
131
  <x-cards>
129
132
  <x-card data-title="生成文档" data-icon="lucide:play-circle" data-href="/features/generate-documentation">
@@ -1,94 +1,64 @@
1
1
  # 言語サポート
2
2
 
3
- AIGNE DocSmithはAIを使用して、12言語への自動ドキュメント翻訳を提供します。これにより、`aigne doc translate`コマンドを使用して、世界中の読者向けのドキュメントを生成および維持できます。
4
-
5
- 翻訳ワークフローは、ソースドキュメントをAIエンジンで処理し、選択したターゲット言語でローカライズされたバージョンを生成します。
6
-
7
- ```d2
8
- direction: down
9
-
10
- Source-Doc: {
11
- label: "ソースドキュメント\n(例:英語)"
12
- shape: rectangle
13
- }
14
-
15
- AI-Engine: {
16
- label: "AIGNE DocSmith\nAI翻訳エンジン"
17
- shape: rectangle
18
- }
19
-
20
- Translated-Docs: {
21
- label: "翻訳済みドキュメント"
22
- shape: rectangle
23
- grid-columns: 3
24
-
25
- zh: "简体中文"
26
- ja: "日本語"
27
- es: "Español"
28
- fr: "Français"
29
- de: "Deutsch"
30
- more: "..."
31
- }
32
-
33
- Source-Doc -> AI-Engine: "`aigne doc translate`"
34
- AI-Engine -> Translated-Docs: "生成"
35
- ```
3
+ AIGNE DocSmithは、12言語へのドキュメントの自動翻訳を提供し、グローバルな読者向けのローカライズされたコンテンツの生成と維持を可能にします。この機能は主に `aigne doc translate` コマンドを通じて管理されます。
4
+
5
+ 翻訳ワークフローは、AIエンジンを使用してソースドキュメントを処理し、選択したターゲット言語でバージョンを生成します。`aigne doc translate` コマンドは、翻訳するドキュメントと言語を選択するためのインタラクティブなインターフェースを提供します。
6
+
7
+ ![インタラクティブなドキュメント翻訳フロー](../assets/screenshots/doc-translate.png)
36
8
 
37
9
  ## サポートされている言語
38
10
 
39
- DocSmithは、以下の言語に対してAIによる翻訳を提供します。プロジェクトの初期設定時に主要言語を定義し、翻訳対象として任意の数のターゲット言語を選択できます。
40
-
41
- | 言語 | 言語コード | サンプルテキスト |
42
- |---|---|---|
43
- | English | `en` | こんにちは |
44
- | 简体中文 | `zh` | 你好 |
45
- | 繁體中文 | `zh-TW` | 你好 |
46
- | 日本語 | `ja` | こんにちは |
47
- | 한국어 | `ko` | 안녕하세요 |
48
- | Español | `es` | Hola |
49
- | Français | `fr` | Bonjour |
50
- | Deutsch | `de` | Hallo |
51
- | Português | `pt` | Olá |
52
- | Русский | `ru` | Привет |
53
- | Italiano | `it` | Ciao |
54
- | العربية | `ar` | مرحبا |
11
+ DocSmithは、以下の言語に対するAIによる翻訳をサポートしています。プロジェクトの主要言語は `aigne doc init` による初期設定時に定義でき、以下の言語からいくつでも翻訳対象として選択できます。
12
+
13
+ | Language | Language Code |
14
+ |---|---|
15
+ | English | `en` |
16
+ | 简体中文 | `zh` |
17
+ | 繁體中文 | `zh-TW` |
18
+ | 日本語 | `ja` |
19
+ | 한국어 | `ko` |
20
+ | Español | `es` |
21
+ | Français | `fr` |
22
+ | Deutsch | `de` |
23
+ | Português | `pt` |
24
+ | Русский | `ru` |
25
+ | Italiano | `it` |
26
+ | العربية | `ar` |
55
27
 
56
28
  ## 翻訳の設定と使用方法
57
29
 
58
- 翻訳言語は、`aigne doc init`でプロジェクトを初期化する際に設定されます。`aigne doc translate`コマンドを使用すれば、いつでも新しい言語を追加したり、ドキュメントを翻訳したりできます。このコマンドには2つの操作モードがあります。
30
+ 言語設定は、プロジェクトを初期化する際に設定します。`aigne doc translate` コマンドを使用して、いつでも新しい言語を追加したり、既存のドキュメントを翻訳したりできます。このコマンドは2つの操作モードをサポートしています。
59
31
 
60
32
  ### ガイド付き翻訳のためのインタラクティブモード
61
33
 
62
- ステップバイステップのガイド付きエクスペリエンスを利用するには、引数なしでコマンドを実行します。これはほとんどのユーザーに推奨されるアプローチです。
34
+ ステップバイステップのガイド付きプロセスについては、引数なしでコマンドを実行してください。この方法はほとんどのユーザーに推奨されます。
63
35
 
64
36
  ```bash Interactive Translation icon=lucide:wand
65
37
  aigne doc translate
66
38
  ```
67
39
 
68
- インタラクティブモードでは、一連のプロンプトが表示され、以下の操作が可能です:
40
+ インタラクティブモードでは、一連のプロンプトが表示され、翻訳するドキュメントを選択し、リストからターゲット言語を選ぶことができます。このモードでは、プロジェクトの設定にまだ含まれていない新しい翻訳言語を追加することもできます。
69
41
 
70
- 1. 既存のドキュメントのリストから翻訳するものを選択する。
71
- 2. サポートされているリストから1つ以上のターゲット言語を選択する。
72
- 3. プロジェクトの設定にまだ含まれていない新しい翻訳言語を追加する。
42
+ ![翻訳対象言語の選択](../assets/screenshots/doc-translate-langs.png)
73
43
 
74
44
  ### 自動化のためのコマンドライン引数
75
45
 
76
- 直接的な制御や自動化スクリプトで使用するために、ドキュメントと言語をコマンドライン引数として直接指定できます。これは開発者やCI/CDパイプラインに最適です。
46
+ 直接制御したり、自動化スクリプトで使用したりする場合は、ドキュメントと言語をコマンドライン引数として指定できます。この方法は、CI/CDパイプラインへの統合に適しています。
77
47
 
78
48
  ```bash Command Example icon=lucide:terminal
79
- # overview.mdとexamples.mdを中国語と日本語に翻訳
49
+ # overview.mdとexamples.mdを中国語と日本語に翻訳する
80
50
  aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
81
51
  ```
82
52
 
83
- このコマンドの主要なパラメータは次のとおりです:
53
+ 以下の表は、`translate` コマンドの主要なパラメータを詳述しています。
84
54
 
85
- | パラメータ | 説明 |
55
+ | Parameter | Description |
86
56
  |---|---|
87
- | `--langs` | ターゲット言語の言語コードを指定します。このフラグは複数回使用して、いくつかの言語を選択できます。 |
88
- | `--docs` | 翻訳するドキュメントへのパスを指定します(例:`overview.md`)。これも複数回使用できます。 |
89
- | `--feedback` | 翻訳モデルをガイドするための具体的な指示を提供します(例:`"フォーマルなトーンを使用する"`)。 |
57
+ | `--langs` | ターゲット言語の言語コードを指定します。このフラグを複数回使用して、複数の言語を選択できます。 |
58
+ | `--docs` | 翻訳するドキュメントへのパス(例:`overview.md`)を指定します。このフラグも複数回使用できます。 |
59
+ | `--feedback` | 翻訳モデルをガイドするための特定の指示を提供します(例:`"Use a formal tone"`)。 |
90
60
  | `--glossary` | カスタム用語集ファイル(例:`@path/to/glossary.md`)を使用して、プロジェクト固有の用語の一貫した翻訳を保証します。 |
91
61
 
92
62
  ---
93
63
 
94
- このセクションでは、利用可能な言語とその有効化方法について説明しました。翻訳ワークフローに関する完全なガイドについては、[ドキュメントの翻訳](./features-translate-documentation.md)ガイドを参照してください。
64
+ このセクションでは、利用可能な言語とその有効化方法の概要を説明しました。翻訳ワークフローに関する完全なガイドについては、[ドキュメントの翻訳](./features-translate-documentation.md)ガイドを参照してください。
@@ -1,94 +1,64 @@
1
1
  # Language Support
2
2
 
3
- AIGNE DocSmith uses AI to provide automated documentation translation into 12 languages. This allows you to generate and maintain documentation for a global audience using the `aigne doc translate` command.
4
-
5
- The translation workflow processes your source documents through an AI engine to generate localized versions in your selected target languages.
6
-
7
- ```d2
8
- direction: down
9
-
10
- Source-Doc: {
11
- label: "Source Document\n(e.g., English)"
12
- shape: rectangle
13
- }
14
-
15
- AI-Engine: {
16
- label: "AIGNE DocSmith\nAI Translation Engine"
17
- shape: rectangle
18
- }
19
-
20
- Translated-Docs: {
21
- label: "Translated Documents"
22
- shape: rectangle
23
- grid-columns: 3
24
-
25
- zh: "简体中文"
26
- ja: "日本語"
27
- es: "Español"
28
- fr: "Français"
29
- de: "Deutsch"
30
- more: "..."
31
- }
32
-
33
- Source-Doc -> AI-Engine: "`aigne doc translate`"
34
- AI-Engine -> Translated-Docs: "Generates"
35
- ```
3
+ AIGNE DocSmith provides automated documentation translation into 12 languages, enabling you to generate and maintain localized content for a global audience. This functionality is primarily managed through the `aigne doc translate` command.
4
+
5
+ The translation workflow uses an AI engine to process your source documents and generate versions in your selected target languages. The `aigne doc translate` command offers an interactive interface to guide you through selecting documents and languages for translation.
6
+
7
+ ![Interactive document translation flow](../assets/screenshots/doc-translate.png)
36
8
 
37
9
  ## Supported Languages
38
10
 
39
- DocSmith offers AI-powered translations for the following languages. You can define your project's primary language during the initial setup and select any number of target languages for translation.
40
-
41
- | Language | Language Code | Sample Text |
42
- |---|---|---|
43
- | English | `en` | Hello |
44
- | 简体中文 | `zh` | 你好 |
45
- | 繁體中文 | `zh-TW` | 你好 |
46
- | 日本語 | `ja` | こんにちは |
47
- | 한국어 | `ko` | 안녕하세요 |
48
- | Español | `es` | Hola |
49
- | Français | `fr` | Bonjour |
50
- | Deutsch | `de` | Hallo |
51
- | Português | `pt` | Olá |
52
- | Русский | `ru` | Привет |
53
- | Italiano | `it` | Ciao |
54
- | العربية | `ar` | مرحبا |
11
+ DocSmith supports AI-powered translations for the following languages. Your project's primary language can be defined during the initial setup with `aigne doc init`, and you can select any number of the following languages for translation.
12
+
13
+ | Language | Language Code |
14
+ |---|---|
15
+ | English | `en` |
16
+ | 简体中文 | `zh` |
17
+ | 繁體中文 | `zh-TW` |
18
+ | 日本語 | `ja` |
19
+ | 한국어 | `ko` |
20
+ | Español | `es` |
21
+ | Français | `fr` |
22
+ | Deutsch | `de` |
23
+ | Português | `pt` |
24
+ | Русский | `ru` |
25
+ | Italiano | `it` |
26
+ | العربية | `ar` |
55
27
 
56
28
  ## How to Configure and Use Translation
57
29
 
58
- Translation languages are set when you initialize your project with `aigne doc init`. You can add new languages or translate documents at any time using the `aigne doc translate` command, which has two modes of operation.
30
+ Language settings are configured when you initialize a project. You can add new languages or translate existing documents at any time using the `aigne doc translate` command, which supports two operational modes.
59
31
 
60
32
  ### Interactive Mode for Guided Translation
61
33
 
62
- For a step-by-step guided experience, run the command without any arguments. This is the recommended approach for most users.
34
+ For a step-by-step guided process, run the command without any arguments. This method is recommended for most users.
63
35
 
64
36
  ```bash Interactive Translation icon=lucide:wand
65
37
  aigne doc translate
66
38
  ```
67
39
 
68
- The interactive mode will then present a series of prompts that allow you to:
40
+ The interactive mode presents a series of prompts, allowing you to select which documents to translate and choose your target languages from a list. This mode also allows you to add new translation languages to your project's configuration if they are not already included.
69
41
 
70
- 1. Select which of your existing documents to translate from a list.
71
- 2. Choose one or more target languages from the supported list.
72
- 3. Add new translation languages to your project's configuration if they are not already included.
42
+ ![Selecting target languages for translation](../assets/screenshots/doc-translate-langs.png)
73
43
 
74
44
  ### Command-Line Arguments for Automation
75
45
 
76
- For direct control or for use in automated scripts, you can specify documents and languages directly as command-line arguments. This is ideal for developers and CI/CD pipelines.
46
+ For direct control or for use in automated scripts, you can specify documents and languages as command-line arguments. This method is suitable for integration into CI/CD pipelines.
77
47
 
78
48
  ```bash Command Example icon=lucide:terminal
79
49
  # Translate overview.md and examples.md into Chinese and Japanese
80
50
  aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
81
51
  ```
82
52
 
83
- Key parameters for the command include:
53
+ The following table details the key parameters for the `translate` command:
84
54
 
85
55
  | Parameter | Description |
86
56
  |---|---|
87
- | `--langs` | Specify a target language code. This flag can be used multiple times to select several languages. |
88
- | `--docs` | Specify the path to a document to translate (e.g., `overview.md`). This can also be used multiple times. |
89
- | `--feedback` | Provide specific instructions to guide the translation model (e.g., `"Use a formal tone"`). |
90
- | `--glossary` | Use a custom glossary file (e.g., `@path/to/glossary.md`) to ensure consistent translation of project-specific terms. |
57
+ | `--langs` | Specifies a target language code. This flag can be used multiple times to select several languages. |
58
+ | `--docs` | Specifies the path to a document to translate (e.g., `overview.md`). This flag can also be used multiple times. |
59
+ | `--feedback` | Provides specific instructions to guide the translation model (e.g., `"Use a formal tone"`). |
60
+ | `--glossary` | Uses a custom glossary file (e.g., `@path/to/glossary.md`) to ensure consistent translation of project-specific terms. |
91
61
 
92
62
  ---
93
63
 
94
- This section covers the available languages and how to enable them. For a complete guide on the translation workflow, see the [Translate Documentation](./features-translate-documentation.md) guide.
64
+ This section provides an overview of the available languages and how to enable them. For a complete guide on the translation workflow, refer to the [Translate Documentation](./features-translate-documentation.md) guide.
@@ -1,94 +1,64 @@
1
1
  # 語言支援
2
2
 
3
- AIGNE DocSmith 使用 AI 提供 12 種語言的自動化文件翻譯。這讓您可以使用 `aigne doc translate` 命令為全球使用者產生和維護文件。
4
-
5
- 翻譯工作流程會透過 AI 引擎處理您的來源文件,以產生您所選目標語言的本地化版本。
6
-
7
- ```d2
8
- direction: down
9
-
10
- Source-Doc: {
11
- label: "來源文件\n(例如,英文)"
12
- shape: rectangle
13
- }
14
-
15
- AI-Engine: {
16
- label: "AIGNE DocSmith\nAI 翻譯引擎"
17
- shape: rectangle
18
- }
19
-
20
- Translated-Docs: {
21
- label: "翻譯後的文件"
22
- shape: rectangle
23
- grid-columns: 3
24
-
25
- zh: "简体中文"
26
- ja: "日本語"
27
- es: "Español"
28
- fr: "Français"
29
- de: "Deutsch"
30
- more: "..."
31
- }
32
-
33
- Source-Doc -> AI-Engine: "`aigne doc translate`"
34
- AI-Engine -> Translated-Docs: "產生"
35
- ```
3
+ AIGNE DocSmith 提供 12 種語言的自動化文件翻譯功能,讓您能夠為全球受眾產生並維護本地化內容。此功能主要透過 `aigne doc translate` 命令進行管理。
36
4
 
37
- ## 支援的語言
5
+ 翻譯工作流程使用 AI 引擎處理您的來源文件,並產生您所選目標語言的版本。`aigne doc translate` 命令提供一個互動式介面,引導您選擇要翻譯的文件和語言。
38
6
 
39
- DocSmith 為以下語言提供 AI 驅動的翻譯。您可以在初始設定時定義專案的主要語言,並選擇任意數量的目標語言進行翻譯。
7
+ ![互動式文件翻譯流程](../assets/screenshots/doc-translate.png)
40
8
 
41
- | 語言 | 語言代碼 | 範例文字 |
42
- |---|---|---|
43
- | English | `en` | Hello |
44
- | 简体中文 | `zh` | 你好 |
45
- | 繁體中文 | `zh-TW` | 你好 |
46
- | 日本語 | `ja` | こんにちは |
47
- | 한국어 | `ko` | 안녕하세요 |
48
- | Español | `es` | Hola |
49
- | Français | `fr` | Bonjour |
50
- | Deutsch | `de` | Hallo |
51
- | Português | `pt` | Olá |
52
- | Русский | `ru` | Привет |
53
- | Italiano | `it` | Ciao |
54
- | العربية | `ar` | مرحبا |
9
+ ## 支援的語言
55
10
 
56
- ## 如何設定與使用翻譯
11
+ DocSmith 支援以下語言的 AI 翻譯。您可以在使用 `aigne doc init` 進行初始設定時定義專案的主要語言,並可選擇以下任何數量的語言進行翻譯。
57
12
 
58
- 翻譯語言是在您使用 `aigne doc init` 初始化專案時設定的。您可以隨時使用 `aigne doc translate` 命令新增語言或翻譯文件,該命令有兩種操作模式。
13
+ | 語言 | 語言代碼 |
14
+ |---|---|
15
+ | 英語 | `en` |
16
+ | 简体中文 | `zh` |
17
+ | 繁體中文 | `zh-TW` |
18
+ | 日本語 | `ja` |
19
+ | 한국어 | `ko` |
20
+ | Español | `es` |
21
+ | Français | `fr` |
22
+ | Deutsch | `de` |
23
+ | Português | `pt` |
24
+ | Русский | `ru` |
25
+ | Italiano | `it` |
26
+ | العربية | `ar` |
27
+
28
+ ## 如何設定與使用翻譯功能
29
+
30
+ 語言設定在您初始化專案時進行配置。您可以隨時使用 `aigne doc translate` 命令新增語言或翻譯現有文件,該命令支援兩種操作模式。
59
31
 
60
32
  ### 用於引導式翻譯的互動模式
61
33
 
62
- 若要獲得逐步引導的體驗,請在不帶任何參數的情況下執行此命令。這是對大多數使用者推薦的方法。
34
+ 若要進行逐步引導的流程,請執行不含任何參數的命令。建議大多數使用者使用此方法。
63
35
 
64
- ```bash Interactive Translation icon=lucide:wand
36
+ ```bash 互動式翻譯 icon=lucide:wand
65
37
  aigne doc translate
66
38
  ```
67
39
 
68
- 互動模式將會顯示一系列提示,讓您可以:
40
+ 互動模式會顯示一系列提示,讓您能夠選擇要翻譯的文件,並從清單中選擇您的目標語言。如果專案設定中尚未包含新的翻譯語言,此模式也允許您新增。
69
41
 
70
- 1. 從清單中選擇要翻譯的現有文件。
71
- 2. 從支援的清單中選擇一種或多種目標語言。
72
- 3. 如果專案設定中尚未包含新的翻譯語言,則可以將其新增。
42
+ ![選擇目標翻譯語言](../assets/screenshots/doc-translate-langs.png)
73
43
 
74
44
  ### 用於自動化的命令列參數
75
45
 
76
- 若要直接控制或在自動化腳本中使用,您可以直接將文件和語言指定為命令列參數。這對於開發人員和 CI/CD 管線來說是理想的選擇。
46
+ 為了直接控制或在自動化腳本中使用,您可以將文件和語言指定為命令列參數。此方法適合整合到 CI/CD 管線中。
77
47
 
78
- ```bash Command Example icon=lucide:terminal
48
+ ```bash 命令範例 icon=lucide:terminal
79
49
  # 將 overview.md 和 examples.md 翻譯成中文和日文
80
50
  aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
81
51
  ```
82
52
 
83
- 該命令的主要參數包括:
53
+ 下表詳細說明了 `translate` 命令的主要參數:
84
54
 
85
55
  | 參數 | 說明 |
86
56
  |---|---|
87
- | `--langs` | 指定目標語言代碼。此旗標可以多次使用以選擇多種語言。 |
88
- | `--docs` | 指定要翻譯的文件的路徑(例如,`overview.md`)。此旗標也可以多次使用。 |
89
- | `--feedback` | 提供具體說明以指導翻譯模型(例如,`"使用正式語氣"`)。 |
90
- | `--glossary` | 使用自訂詞彙表檔案(例如,`@path/to/glossary.md`)以確保專案特定術語的翻譯一致性。 |
57
+ | `--langs` | 指定目標語言代碼。此旗標可多次使用以選擇多種語言。 |
58
+ | `--docs` | 指定要翻譯的文件的路徑(例如 `overview.md`)。此旗標也可多次使用。 |
59
+ | `--feedback` | 提供具體指令以引導翻譯模型(例如 `「使用正式語氣」`)。 |
60
+ | `--glossary` | 使用自訂詞彙表檔案(例如 `@path/to/glossary.md`)以確保專案特定術語的翻譯一致性。 |
91
61
 
92
62
  ---
93
63
 
94
- 本節介紹了可用的語言以及如何啟用它們。有關翻譯工作流程的完整指南,請參閱 [翻譯文件](./features-translate-documentation.md) 指南。
64
+ 本節概述了可用的語言以及如何啟用它們。有關翻譯工作流程的完整指南,請參閱 [翻譯文件](./features-translate-documentation.md) 指南。