@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,101 +1,95 @@
1
1
  # 產生文件
2
2
 
3
- `aigne doc generate` 命令是從您的原始碼建立完整文件集的核心功能。此過程會分析您的程式碼庫、規劃邏輯性的文件結構,然後為每個部分產生內容。這是從零開始建立文件的主要方式。
3
+ `aigne doc generate` 指令是從原始程式碼建立完整文件集的主要功能。此指令會啟動一個流程,分析您的程式碼庫、規劃邏輯性的文件結構,然後為每個部分產生內容。這是從初始狀態建立文件的標準方法。
4
4
 
5
- ## 您的首次產生
5
+ ## 首次產生
6
6
 
7
- 首先,請導覽至您專案的根目錄並執行以下命令:
7
+ 首先,請導覽至您專案的根目錄並執行以下指令:
8
8
 
9
- ```bash
9
+ ```bash aigne doc generate icon=lucide:play-circle
10
10
  aigne doc generate
11
11
  ```
12
12
 
13
13
  ### 自動設定
14
14
 
15
- 當您首次在專案中執行此命令時,DocSmith 會偵測到尚無設定。接著,它會啟動一個互動式設定精靈,引導您完成初始設定。這能確保在開始產生文件前,您擁有一個正確配置的環境。
15
+ 如果您是首次在專案中執行此指令,DocSmith 將偵測到沒有任何設定存在。然後,它會自動啟動一個互動式設定精靈,引導您完成所需的設定步驟。此過程可確保在開始產生文件之前,有一個有效的設定。
16
16
 
17
- ![首次執行 generate 命令會觸發設定精靈](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
17
+ ![執行 generate 指令,智慧執行初始化](../assets/screenshots/doc-generate.png)
18
18
 
19
- 系統會詢問您一系列問題以定義:
19
+ 系統會提示您回答一系列問題,以定義文件的關鍵面向,包括:
20
20
 
21
- - 文件產生規則與風格
22
- - 目標讀者
23
- - 主要語言與翻譯語言
24
- - 原始碼與輸出路徑
21
+ * 文件產生規則與風格
22
+ * 目標受眾
23
+ * 主要語言及任何其他翻譯語言
24
+ * 原始程式碼輸入與文件輸出路徑
25
25
 
26
- ![回答問題以設定您的文件風格、語言和來源路徑](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
26
+ ![回答問題以完成專案設定](../assets/screenshots/doc-complete-setup.png)
27
27
 
28
- 設定完成後,DocSmith 將繼續進行文件產生。
28
+ 設定完成後,DocSmith 會繼續進行文件產生。
29
29
 
30
- ![DocSmith 會分析您的程式碼、規劃結構並產生每個文件](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
30
+ ![執行結構規劃並產生文件](../assets/screenshots/doc-generate-docs.png)
31
31
 
32
- 成功完成後,您新建立的文件將會出現在您指定的輸出目錄中。
32
+ 成功完成後,新建立的文件將可在設定時指定的輸出目錄中找到。
33
33
 
34
- ![完成後,您將在指定的輸出目錄中找到新文件](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
34
+ ![文件成功產生](../assets/screenshots/doc-generated-successfully.png)
35
35
 
36
- ## 產生過程
36
+ ## 產生流程
37
37
 
38
- `generate` 命令遵循一個自動化的工作流程。其過程可視覺化如下:
38
+ `generate` 指令會執行一個自動化的多步驟工作流程。流程概述如下:
39
39
 
40
40
  ```d2
41
41
  direction: down
42
42
 
43
- start: "開始" {
44
- shape: oval
43
+ User: {
44
+ shape: c4-person
45
45
  }
46
46
 
47
- run_cmd: "執行 `aigne doc generate`" {
48
- shape: rectangle
49
- }
47
+ AIGNE-CLI: {
48
+ label: "AIGNE CLI"
50
49
 
51
- check_config: "找到設定檔?" {
52
- shape: diamond
53
- }
50
+ config-check: {
51
+ label: "設定檔是否存在?"
52
+ shape: diamond
53
+ }
54
54
 
55
- interactive_setup: "啟動互動式設定精靈" {
56
- shape: rectangle
57
- }
55
+ interactive-setup: {
56
+ label: "互動式設定精靈"
57
+ }
58
58
 
59
- plan_structure: "1. 分析程式碼並規劃結構" {
60
- shape: rectangle
61
- }
59
+ generation-process: {
60
+ label: "3. 產生流程"
62
61
 
63
- gen_content: "2. 產生文件內容" {
64
- shape: rectangle
65
- }
62
+ analyze-code: "分析程式碼"
63
+ plan-structure: "規劃結構"
64
+ generate-content: "產生內容"
66
65
 
67
- save_docs: "3. 儲存文件" {
68
- shape: rectangle
69
- }
66
+ analyze-code -> plan-structure -> generate-content
67
+ }
70
68
 
71
- end: "結束" {
72
- shape: oval
69
+ output: {
70
+ label: "輸出目錄"
71
+ }
73
72
  }
74
73
 
75
- start -> run_cmd
76
- run_cmd -> check_config
77
- check_config -> interactive_setup: ""
78
- interactive_setup -> plan_structure
79
- check_config -> plan_structure: ""
80
- plan_structure -> gen_content
81
- gen_content -> save_docs
82
- save_docs -> end
74
+ User -> AIGNE-CLI.config-check: "'aigne doc generate'"
75
+ AIGNE-CLI.config-check -> AIGNE-CLI.interactive-setup: "[否] 2. 啟動設定"
76
+ AIGNE-CLI.interactive-setup -> AIGNE-CLI.generation-process: "建立設定檔"
77
+ AIGNE-CLI.config-check -> AIGNE-CLI.generation-process: "[是]"
78
+ AIGNE-CLI.generation-process -> AIGNE-CLI.output: "4. 寫入文件"
83
79
  ```
84
80
 
85
- ## 命令選項
81
+ ## 指令選項
86
82
 
87
- 雖然預設的 `generate` 命令已足夠應付大多數使用情境,但您仍可使用數個選項來控制產生過程。這些選項對於重新產生內容或優化文件結構很有幫助。
83
+ 預設的 `generate` 指令足以應付大多數使用情境。然而,有幾個選項可用於修改其行為,這對於強制完整重新產生或完善文件結構非常有用。
88
84
 
89
- | Option | Description | Example |
90
- |---------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
91
- | `--forceRegenerate` | 刪除所有現有文件並從頭開始重新產生。當您的原始碼或設定有重大變更時,請使用此選項。 | `aigne doc generate --forceRegenerate` |
92
- | `--feedback` | 提供高層次的回饋以優化整體文件結構,例如新增、移除或重組章節。 | `aigne doc generate --feedback "Add an API Reference section"` |
93
- | `--model` | 指定一個來自 AIGNE Hub 的特定大型語言模型用於內容產生,讓您可以在不同模型之間切換。 | `aigne doc generate --model claude:claude-3-5-sonnet` |
85
+ | 選項 | 描述 | 範例 |
86
+ | :------------------ | :----------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------- |
87
+ | `--forceRegenerate` | 刪除所有現有文件並從頭開始重新產生。在對原始程式碼或設定進行重大變更後使用此選項。 | `aigne doc generate --forceRegenerate` |
88
+ | `--feedback` | 提供高層次的回饋以完善整體文件結構,例如新增、移除或重組章節。 | `aigne doc generate --feedback "Add an API Reference"` |
89
+ | `--model` | 指定從 AIGNE Hub 使用特定的大型語言模型來產生內容,讓您可以在不同模型之間切換。 | `aigne doc generate --model openai:gpt-4o` |
94
90
 
95
- ## 接下來呢?
91
+ ## 下一步是什麼?
96
92
 
97
- 既然您已經產生了初始文件,您的專案將會持續發展。為了讓文件與程式碼保持同步,您需要更新它們。請前往下一節,學習如何進行針對性修改並重新產生特定檔案。
93
+ 產生初始文件後,您的專案將會持續演進。為了讓您的文件與程式碼保持同步,您需要執行更新。下一節將說明如何根據新的需求或程式碼修改進行針對性變更並重新產生特定檔案。
98
94
 
99
- <x-card data-title="更新與優化" data-icon="lucide:file-edit" data-href="/features/update-and-refine">
100
- 了解當程式碼變更時如何更新文件,或利用回饋進行特定改進。
101
- </x-card>
95
+ <x-card data-title="更新與完善" data-icon="lucide:file-edit" data-href="/features/update-and-refine">學習如何在程式碼變更時更新文件,或使用回饋進行特定改進。</x-card>
@@ -1,101 +1,95 @@
1
1
  # 生成文档
2
2
 
3
- `aigne doc generate` 命令是用于从源代码创建完整文档集的核心功能。此过程会分析您的代码库,规划逻辑文档结构,然后为每个部分生成内容。这是从头开始创建文档的主要方式。
3
+ `aigne doc generate` 命令是用于从源代码创建完整文档集的主要功能。该命令会启动一个流程,分析您的代码库,规划逻辑化的文档结构,然后为每个部分生成内容。这是从初始状态创建文档的标准方法。
4
4
 
5
5
  ## 首次生成
6
6
 
7
7
  首先,请导航到您项目的根目录并运行以下命令:
8
8
 
9
- ```bash
9
+ ```bash aigne doc generate icon=lucide:play-circle
10
10
  aigne doc generate
11
11
  ```
12
12
 
13
13
  ### 自动配置
14
14
 
15
- 如果您在项目中首次运行此命令,DocSmith 会检测到不存在任何配置。然后,它将启动一个交互式设置向导来指导您完成初始设置。这能确保在生成开始前,您拥有一个正确配置的环境。
15
+ 如果您是首次在项目中运行此命令,DocSmith 将检测到尚不存在任何配置。随后,它将自动启动一个交互式设置向导,引导您完成所需的设置步骤。此过程可确保在生成开始前已准备好有效的配置。
16
16
 
17
- ![首次运行 generate 命令会触发设置向导](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
17
+ ![运行 generate 命令,智能执行初始化](../assets/screenshots/doc-generate.png)
18
18
 
19
- 系统将询问您一系列问题以定义:
19
+ 系统将提示您回答一系列问题,以定义文档的关键方面,包括:
20
20
 
21
- - 文档生成规则和风格
22
- - 目标受众
23
- - 主要语言和翻译语言
24
- - 源代码和输出路径
21
+ * 文档生成规则和风格
22
+ * 目标受众
23
+ * 主要语言及任何其他翻译语言
24
+ * 源代码输入和文档输出路径
25
25
 
26
- ![回答问题以配置您的文档风格、语言和源路径](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
26
+ ![回答问题以完成项目设置](../assets/screenshots/doc-complete-setup.png)
27
27
 
28
28
  配置完成后,DocSmith 将继续进行文档生成。
29
29
 
30
- ![DocSmith 分析您的代码,规划结构,并生成每个文档](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
30
+ ![执行结构规划并生成文档](../assets/screenshots/doc-generate-docs.png)
31
31
 
32
- 成功完成后,您新创建的文档将在您指定的输出目录中可用。
32
+ 成功完成后,新创建的文档将位于设置期间指定的输出目录中。
33
33
 
34
- ![完成后,您将在指定的输出目录中找到新文档](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
34
+ ![文档生成成功](../assets/screenshots/doc-generated-successfully.png)
35
35
 
36
36
  ## 生成过程
37
37
 
38
- `generate` 命令遵循自动化工作流程。该过程可按如下方式可视化:
38
+ `generate` 命令执行一个自动化的多步骤工作流。该过程概述如下:
39
39
 
40
40
  ```d2
41
41
  direction: down
42
42
 
43
- start: "开始" {
44
- shape: oval
43
+ User: {
44
+ shape: c4-person
45
45
  }
46
46
 
47
- run_cmd: "运行 `aigne doc generate`" {
48
- shape: rectangle
49
- }
47
+ AIGNE-CLI: {
48
+ label: "AIGNE CLI"
50
49
 
51
- check_config: "找到配置?" {
52
- shape: diamond
53
- }
50
+ config-check: {
51
+ label: "配置文件是否存在?"
52
+ shape: diamond
53
+ }
54
54
 
55
- interactive_setup: "启动交互式设置向导" {
56
- shape: rectangle
57
- }
55
+ interactive-setup: {
56
+ label: "交互式设置向导"
57
+ }
58
58
 
59
- plan_structure: "1. 分析代码并规划结构" {
60
- shape: rectangle
61
- }
59
+ generation-process: {
60
+ label: "3. 生成过程"
62
61
 
63
- gen_content: "2. 生成文档内容" {
64
- shape: rectangle
65
- }
62
+ analyze-code: "分析代码"
63
+ plan-structure: "规划结构"
64
+ generate-content: "生成内容"
66
65
 
67
- save_docs: "3. 保存文档" {
68
- shape: rectangle
69
- }
66
+ analyze-code -> plan-structure -> generate-content
67
+ }
70
68
 
71
- end: "结束" {
72
- shape: oval
69
+ output: {
70
+ label: "输出目录"
71
+ }
73
72
  }
74
73
 
75
- start -> run_cmd
76
- run_cmd -> check_config
77
- check_config -> interactive_setup: ""
78
- interactive_setup -> plan_structure
79
- check_config -> plan_structure: ""
80
- plan_structure -> gen_content
81
- gen_content -> save_docs
82
- save_docs -> end
74
+ User -> AIGNE-CLI.config-check: "'aigne doc generate'"
75
+ AIGNE-CLI.config-check -> AIGNE-CLI.interactive-setup: "[否] 2. 启动设置"
76
+ AIGNE-CLI.interactive-setup -> AIGNE-CLI.generation-process: "创建配置文件"
77
+ AIGNE-CLI.config-check -> AIGNE-CLI.generation-process: "[是]"
78
+ AIGNE-CLI.generation-process -> AIGNE-CLI.output: "4. 编写文档"
83
79
  ```
84
80
 
85
81
  ## 命令选项
86
82
 
87
- 虽然默认的 `generate` 命令足以满足大多数用例,但您可以使用几个选项来控制生成过程。这些选项对于重新生成内容或优化文档结构非常有用。
83
+ 默认的 `generate` 命令足以满足大多数使用场景。但是,有几个选项可用于修改其行为,这对于强制完全重新生成或优化文档结构非常有用。
88
84
 
89
- | 选项 | 描述 | 示例 |
90
- |---------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
91
- | `--forceRegenerate` | 删除所有现有文档并从头开始重新生成。在对源代码或配置进行重大更改后使用此选项。 | `aigne doc generate --forceRegenerate` |
92
- | `--feedback` | 提供高层反馈以优化整体文档结构,例如添加、删除或重组部分。 | `aigne doc generate --feedback "添加一个 API 参考部分"` |
93
- | `--model` | 指定一个来自 AIGNE Hub 的特定大型语言模型用于内容生成,允许您在不同模型之间切换。 | `aigne doc generate --model claude:claude-3-5-sonnet` |
85
+ | 选项 | 描述 | 示例 |
86
+ | :------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------- |
87
+ | `--forceRegenerate` | 删除所有现有文档并从头开始重新生成。在对源代码或配置进行重大更改后使用此选项。 | `aigne doc generate --forceRegenerate` |
88
+ | `--feedback` | 提供高层反馈以优化整体文档结构,例如添加、删除或重组部分。 | `aigne doc generate --feedback "添加 API 参考"` |
89
+ | `--model` | 指定 AIGNE Hub 中的特定大型语言模型用于内容生成,允许您在不同模型之间切换。 | `aigne doc generate --model openai:gpt-4o` |
94
90
 
95
91
  ## 接下来做什么?
96
92
 
97
- 既然您已经生成了初始文档,您的项目将继续发展。为了使文档与代码保持同步,您需要更新它们。请继续下一部分,学习如何进行有针对性的更改并重新生成特定文件。
93
+ 生成初始文档后,您的项目将继续发展。为了使您的文档与代码保持同步,您需要执行更新。下一节将解释如何根据新需求或代码修改进行有针对性的更改并重新生成特定文件。
98
94
 
99
- <x-card data-title="更新和优化" data-icon="lucide:file-edit" data-href="/features/update-and-refine">
100
- 学习当您的代码发生变化时如何更新文档,或使用反馈进行特定改进。
101
- </x-card>
95
+ <x-card data-title="更新和优化" data-icon="lucide:file-edit" data-href="/features/update-and-refine">了解如何在代码更改时更新文档,或使用反馈进行特定改进。</x-card>
@@ -1,58 +1,81 @@
1
1
  # ドキュメントを公開する
2
2
 
3
- ドキュメントを生成した後、`aigne doc publish`コマンドはコンテンツをDiscuss Kitプラットフォームにアップロードし、オンラインでアクセスできるようにします。このガイドでは、公式プラットフォームまたは自己ホスト型のウェブサイトにドキュメントを公開する方法について説明します。
3
+ ドキュメントを生成した後、`aigne doc publish` コマンドはファイルをアップロードし、共有可能なリンクを通じてアクセス可能にします。このガイドでは、公式の AIGNE プラットフォームまたは自己ホスト型のインスタンスにドキュメントを公開するためのステップバイステップのプロセスを提供します。
4
4
 
5
5
  ## 公開プロセス
6
6
 
7
- `aigne doc publish`コマンドは対話的なプロセスを開始します。新しい宛先に初めて公開する場合、認証プロセスが案内されます。その後の公開では、保存された認証情報が使用されます。
7
+ `aigne doc publish` コマンドは対話型のワークフローを開始します。特定の宛先に初めて公開する場合、CLI はブラウザを開き、一度限りの認証プロセスを案内します。その後の公開では、`~/.aigne/doc-smith-connected.yaml` に保存されている認証情報が使用されます。
8
8
 
9
- ```d2 公開フロー icon=lucide:upload-cloud
10
- direction: down
9
+ ```d2 公開ワークフロー icon=lucide:upload-cloud
11
10
  shape: sequence_diagram
12
11
 
13
- ユーザー: { shape: c4-person }
14
- CLI: { label: "AIGNE CLI" }
15
- ブラウザ: { label: "ブラウザ" }
16
- プラットフォーム: { label: "Discuss Kit プラットフォーム" }
17
-
18
- ユーザー -> CLI: "aigne doc publish"
19
-
20
- alt: "初回公開または設定がない場合" {
21
- CLI -> ユーザー: "プラットフォームを選択\n(公式 / 自己ホスト型)"
22
- ユーザー -> CLI: "選択を提供"
23
- CLI -> ブラウザ: "認証URLを開く"
24
- ユーザー -> ブラウザ: "ログインして承認"
25
- ブラウザ -> プラットフォーム: "認証情報を送信"
26
- プラットフォーム -> CLI: "アクセストークンを返す"
27
- CLI -> CLI: "今後の使用のためにトークンを保存"
12
+ User: {
13
+ label: "開発者 / CI-CD"
14
+ shape: c4-person
28
15
  }
29
16
 
30
- CLI -> プラットフォーム: "ドキュメントとメディアファイルをアップロード"
31
- プラットフォーム -> CLI: "成功応答"
32
- CLI -> ユーザー: "✅ 公開成功!"
17
+ CLI: {
18
+ label: "CLI\n(aigne doc publish)"
19
+ }
20
+
21
+ Local-Config: {
22
+ label: "ローカル設定\n(~/.aigne/...)"
23
+ shape: cylinder
24
+ }
33
25
 
26
+ Browser
27
+
28
+ Platform: {
29
+ label: "プラットフォーム\n(公式または自己ホスト型)"
30
+ }
31
+
32
+ User -> CLI: "コマンドを実行"
33
+
34
+ alt "対話モード" {
35
+ CLI -> Local-Config: "認証情報を確認"
36
+ opt "認証情報が見つからない (初回)" {
37
+ CLI -> User: "プラットフォームの選択を促す"
38
+ User -> CLI: "プラットフォームを選択"
39
+ CLI -> Browser: "認証 URL を開く"
40
+ User -> Browser: "ログイン & 承認"
41
+ Browser -> Platform: "トークンを要求"
42
+ Platform -> Browser: "トークンを返す"
43
+ Browser -> CLI: "トークンを CLI に送信"
44
+ CLI -> Local-Config: "認証情報を保存"
45
+ }
46
+ CLI -> Platform: "ドキュメントをアップロード"
47
+ Platform -> CLI: "成功を確認"
48
+ CLI -> User: "成功メッセージを表示"
49
+ }
50
+
51
+ alt "CI/CD モード" {
52
+ note over CLI: "ENV VAR からトークンを読み取る"
53
+ CLI -> Platform: "ドキュメントをアップロード"
54
+ Platform -> CLI: "成功を確認"
55
+ CLI -> User: "成功ステータスを返す"
56
+ }
34
57
  ```
35
58
 
36
59
  ## 公開オプション
37
60
 
38
- ドキュメントをホストするための主なオプションは2つあります:
61
+ ドキュメントをホストするために、2つの主要な宛先から選択できます。
39
62
 
40
63
  <x-cards data-columns="2">
41
64
  <x-card data-title="公式プラットフォーム" data-icon="lucide:globe">
42
- AIGNEが提供する無料の公開ホスティングプラットフォームである[docsmith.aigne.io](https://docsmith.aigne.io/app/)に公開します。これはオープンソースプロジェクトやドキュメントを迅速に共有するのに良い選択肢です。
65
+ AIGNE が運営するサービスである docsmith.aigne.io に公開します。これは、オープンソースプロジェクトやドキュメントを迅速に公開共有するための簡単なオプションです。
43
66
  </x-card>
44
- <x-card data-title="独自のウェブサイト" data-icon="lucide:server">
45
- アクセスとブランディングを完全に制御するために、独自のDiscuss Kitインスタンスに公開します。これは内部またはプライベートなドキュメントに適しています。[Blocklet Store](https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu)からDiscuss Kitインスタンスを入手できます。
67
+ <x-card data-title="自己ホスト型インスタンス" data-icon="lucide:server">
68
+ ブランディング、アクセス、データプライバシーを完全に制御するために、独自の Discuss Kit インスタンスに公開します。これは、内部またはプライベートなドキュメントに推奨されるオプションです。公式ドキュメントにある指示に従って、独自の Discuss Kit インスタンスを実行できます。
46
69
  </x-card>
47
70
  </x-cards>
48
71
 
49
72
  ## ステップバイステップガイド
50
73
 
51
- 初めてドキュメントを公開するには、以下の手順に従ってください。
74
+ 以下の手順に従ってドキュメントを公開してください。
52
75
 
53
76
  ### 1. 公開コマンドを実行する
54
77
 
55
- プロジェクトのルートディレクトリで、次のコマンドを実行します:
78
+ プロジェクトのルートディレクトリに移動し、次のコマンドを実行します。
56
79
 
57
80
  ```bash Terminal icon=lucide:terminal
58
81
  aigne doc publish
@@ -60,48 +83,48 @@ aigne doc publish
60
83
 
61
84
  ### 2. プラットフォームを選択する
62
85
 
63
- 初めて公開する場合、宛先を選択するように求められます。ニーズに合ったオプションを選択してください。
86
+ 初めて公開する場合、宛先を選択するよう求められます。要件に合ったオプションを選択してください。
64
87
 
65
- ![公式プラットフォームまたは自己ホスト型インスタンスから選択](https://docsmith.aigne.io/image-bin/uploads/9fd929060b5abe13d03cf5eb7aea85aa.png)
88
+ ![公式プラットフォームまたは自己ホスト型プラットフォームにドキュメントを公開する](../assets/screenshots/doc-publish.png)
66
89
 
67
- 独自のウェブサイトを選択した場合、そのURLを入力するように求められます。
90
+ 自己ホスト型のインスタンスを選択した場合、その URL を入力するよう求められます。
68
91
 
69
92
  ### 3. アカウントを認証する
70
93
 
71
- 新しいプラットフォームへの最初の接続では、ブラウザウィンドウが開き、ログインしてCLIを承認します。これはプラットフォームごとに一度だけのステップです。アクセストークンは将来の使用のためにローカルの`~/.aigne/doc-smith-connected.yaml`に保存されます。
94
+ 最初の接続では、ブラウザウィンドウが自動的に開き、ログインして CLI を承認します。このステップはプラットフォームごとに一度だけ必要です。アクセストークンは将来の使用のためにローカルに保存されます。
72
95
 
73
96
  ### 4. 確認
74
97
 
75
- アップロードが完了すると、ターミナルに成功メッセージが表示されます。
98
+ アップロードが完了すると、ターミナルに成功メッセージが表示され、ドキュメントが公開されたことを確認します。
76
99
 
77
100
  ```
78
- ドキュメントが正常に公開されました!
101
+ Documentation Published Successfully!
79
102
  ```
80
103
 
81
- ## CI/CD環境での公開
104
+ ## CI/CD 環境での公開
82
105
 
83
- 自動化されたワークフローの場合、引数と環境変数を提供して対話型プロンプトをバイパスできます。
106
+ CI/CD パイプラインのような自動化されたワークフローで公開コマンドを使用するには、引数と環境変数を通じて必要な情報を提供することで、対話型のプロンプトをバイパスできます。
84
107
 
85
108
  | 方法 | 名前 | 説明 |
86
109
  |---|---|---|
87
- | **引数** | `--appUrl` | Discuss KitインスタンスのURLを直接指定します。 |
88
- | **環境変数** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | アクセストークンを提供し、対話型ログインをスキップします。 |
110
+ | **引数** | `--appUrl` | Discuss Kit インスタンスの URL を指定します。 |
111
+ | **環境変数** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | 対話型のログインプロセスをスキップするためのアクセストークンを提供します。 |
89
112
 
90
- 以下は、CI/CDパイプラインに適した非対話型の公開コマンドの例です:
113
+ 以下は、CI/CD スクリプトに適した非対話型の公開コマンドの例です。
91
114
 
92
- ```bash CI/CD Example icon=lucide:workflow
115
+ ```bash CI/CD の例 icon=lucide:workflow
93
116
  export DOC_DISCUSS_KIT_ACCESS_TOKEN="your_access_token_here"
94
117
  aigne doc publish --appUrl https://docs.mycompany.com
95
118
  ```
96
119
 
97
120
  ## トラブルシューティング
98
121
 
99
- 公開中に問題が発生した場合は、これらの一般的な問題を確認してください:
122
+ 公開プロセス中に問題が発生した場合、それは以下の一般的な問題のいずれかが原因である可能性があります。
100
123
 
101
- - **接続エラー**: 自己ホスト型インスタンスに提供されたURLが正しくないか、サーバーに到達できない可能性があります。URLとネットワーク接続を確認してください。
124
+ - **接続エラー**: CLI は `Unable to connect to: <URL>` のようなエラーメッセージを返すことがあります。これは、ネットワークの問題、サーバーが一時的に利用できない、または URL が間違っていることが原因である可能性があります。URL が正しく、サーバーに到達可能であることを確認してください。
102
125
 
103
- - **無効なウェブサイトURL**: URLはArcBlockプラットフォーム上に構築された有効なウェブサイトを指している必要があります。CLIは`The provided URL is not a valid website on ArcBlock platform`のようなエラーを表示します。ドキュメントをホストするには、まず[ストアからDiscuss Kitインスタンスを取得](https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu)することから始めることができます。
126
+ - **無効なウェブサイト URL**: コマンドは `The provided URL is not a valid website on ArcBlock platform` というメッセージで失敗することがあります。宛先 URL は ArcBlock プラットフォーム上に構築されたウェブサイトでなければなりません。ドキュメントをホストするには、独自の Discuss Kit インスタンスを実行できます。
104
127
 
105
- - **必須コンポーネントの欠落**: 宛先のウェブサイトにはDiscuss Kitコンポーネントがインストールされている必要があります。欠落している場合、CLIは`This website does not have required components for publishing`のようなエラーを返します。[Discuss Kitのドキュメント](https://www.arcblock.io/docs/web3-kit/en/discuss-kit)を参照して、必要なコンポーネントを追加してください。
128
+ - **必要なコンポーネントの欠落**: `This website does not have required components for publishing` というエラーは、宛先のウェブサイトに Discuss Kit コンポーネントがインストールされていないことを示します。サイトに必要なコンポーネントを追加するには、Discuss Kit のドキュメントを参照してください。
106
129
 
107
- コマンドとオプションの完全なリストについては、[CLIコマンドリファレンス](./cli-reference.md)を参照してください。
130
+ コマンドとオプションの完全なリストについては、[CLI コマンドリファレンス](./cli-reference.md) を参照してください。