@aigne/doc-smith 0.8.12-beta.3 → 0.8.12-beta.5

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 +20 -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 +4 -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
@@ -0,0 +1,85 @@
1
+ # Interactive Chat
2
+
3
+ The interactive chat assistant provides a conversational interface for generating, modifying, and managing your documentation. Instead of running individual commands, you can describe what you need to do, and the assistant will guide you through the process, calling on the appropriate tools to complete the task.
4
+
5
+ This approach simplifies the documentation workflow by handling the underlying commands for you. It is the recommended method for most interactions with the tool.
6
+
7
+ ## Starting the Chat Assistant
8
+
9
+ To begin an interactive session, run the `chat` command from your terminal:
10
+
11
+ ```bash
12
+ aigndoc chat
13
+ ```
14
+
15
+ This will launch the assistant, and you can begin typing your requests.
16
+
17
+ ## Core Capabilities
18
+
19
+ The chat assistant is designed to handle the entire documentation lifecycle. Its primary functions include:
20
+
21
+ <x-cards data-columns="2">
22
+ <x-card data-title="Generate Documentation" data-icon="lucide:file-plus-2">
23
+ Create a complete documentation structure and initial content by analyzing your project's source files.
24
+ </x-card>
25
+ <x-card data-title="Refine and Update" data-icon="lucide:edit">
26
+ Regenerate specific sections or entire documents based on your feedback or changes in the source code.
27
+ </x-card>
28
+ <x-card data-title="Translate Content" data-icon="lucide:languages">
29
+ Translate existing documentation into multiple languages to reach a broader audience.
30
+ </x-card>
31
+ <x-card data-title="Publish and Manage" data-icon="lucide:upload-cloud">
32
+ Assist with publishing your documentation and managing team-based workflows.
33
+ </x-card>
34
+ </x-cards>
35
+
36
+ ## Available Commands
37
+
38
+ Within the chat, you can state your goal in plain language (e.g., "update the getting started guide") or invoke specific commands. The assistant understands the following core commands, which correspond to its specialized skills:
39
+
40
+ | Command | Description |
41
+ | :--- | :--- |
42
+ | `generate` | Starts the process of creating a new documentation structure from source files. |
43
+ | `update` | Modifies existing documents based on code changes or user feedback. |
44
+ | `translate` | Translates documents into one or more supported languages. |
45
+ | `publish` | Publishes your documentation to make it accessible online. |
46
+ | `init` | Guides you through creating an initial configuration file for the project. |
47
+ | `clear` | Removes generated files, configurations, and cached data. |
48
+ | `prefs` | Manages your saved preferences for document generation. |
49
+ | `evaluate` | Assesses the quality and completeness of your generated documentation. |
50
+ | `history` | Shows the history of updates made to your documentation. |
51
+ | `exit` | Ends the interactive chat session. |
52
+
53
+ ## Example Interaction
54
+
55
+ Here is a sample conversation to illustrate how the interactive assistant works.
56
+
57
+ ```text
58
+ You:
59
+ > Hello, I need to create documentation for a new project.
60
+
61
+ AI Assistant:
62
+ Of course. To get started, I need to analyze your project structure. Could you please provide the path to your source code directory?
63
+
64
+ You:
65
+ > ./src
66
+
67
+ AI Assistant:
68
+ Thank you. I will now analyze the files in ./src to propose a documentation structure. This may take a few moments...
69
+ ...
70
+ I have analyzed your project and created a proposed structure. Would you like to review it before I proceed with generating the content? (yes/no)
71
+
72
+ You:
73
+ > yes
74
+
75
+ AI Assistant:
76
+ (Displays the proposed documentation structure for review)
77
+ ...
78
+ Please review the structure above. You can ask me to add, remove, or modify any part of it.
79
+ ```
80
+
81
+ ## Summary
82
+
83
+ The interactive chat assistant is a powerful tool for managing your documentation in a guided, conversational manner. It streamlines complex tasks by handling the necessary steps and commands for you.
84
+
85
+ For a more detailed walkthrough of a specific workflow, see the [Generating Documentation](./guides-generating-documentation.md) guide.
@@ -0,0 +1,85 @@
1
+ # 互動式聊天
2
+
3
+ 互動式聊天助理提供了一個對話式介面,用於產生、修改和管理您的文件。您無需執行單獨的指令,只需描述您需要做什麼,助理便會引導您完成整個流程,並呼叫適當的工具來完成任務。
4
+
5
+ 這種方法透過為您處理底層指令,簡化了文件工作流程。這是與此工具進行大多數互動時的建議方法。
6
+
7
+ ## 啟動聊天助理
8
+
9
+ 若要開始互動式對話,請在您的終端機中執行 `chat` 指令:
10
+
11
+ ```bash
12
+ aigndoc chat
13
+ ```
14
+
15
+ 這將會啟動助理,您就可以開始輸入您的請求。
16
+
17
+ ## 核心功能
18
+
19
+ 聊天助理的設計旨在處理整個文件生命週期。其主要功能包括:
20
+
21
+ <x-cards data-columns="2">
22
+ <x-card data-title="產生文件" data-icon="lucide:file-plus-2">
23
+ 透過分析您專案的原始檔案,建立完整的文件結構和初始內容。
24
+ </x-card>
25
+ <x-card data-title="優化與更新" data-icon="lucide:edit">
26
+ 根據您的回饋或原始碼的變更,重新產生特定章節或整份文件。
27
+ </x-card>
28
+ <x-card data-title="翻譯內容" data-icon="lucide:languages">
29
+ 將現有文件翻譯成多種語言,以觸及更廣泛的受眾。
30
+ </x-card>
31
+ <x-card data-title="發布與管理" data-icon="lucide:upload-cloud">
32
+ 協助發布您的文件並管理團隊協作流程。
33
+ </x-card>
34
+ </x-cards>
35
+
36
+ ## 可用指令
37
+
38
+ 在聊天中,您可以用自然語言陳述您的目標(例如,「更新入門指南」),或呼叫特定指令。助理能理解以下核心指令,這些指令對應其專業技能:
39
+
40
+ | Command | Description |
41
+ | :--- | :--- |
42
+ | `generate` | 從原始檔案開始建立新文件結構的流程。 |
43
+ | `update` | 根據程式碼變更或使用者回饋修改現有文件。 |
44
+ | `translate` | 將文件翻譯成一種或多種支援的語言。 |
45
+ | `publish` | 發布您的文件,使其可在線上存取。 |
46
+ | `init` | 引導您為專案建立初始設定檔。 |
47
+ | `clear` | 移除產生的檔案、設定和快取資料。 |
48
+ | `prefs` | 管理您儲存的文件產生偏好設定。 |
49
+ | `evaluate` | 評估您產生的文件的品質和完整性。 |
50
+ | `history` | 顯示您文件的更新歷史記錄。 |
51
+ | `exit` | 結束互動式聊天對話。 |
52
+
53
+ ## 互動範例
54
+
55
+ 以下是一段範例對話,用來說明互動式助理如何運作。
56
+
57
+ ```text
58
+ 您:
59
+ > 你好,我需要為一個新專案建立文件。
60
+
61
+ AI 助理:
62
+ 當然。在開始之前,我需要分析您的專案結構。可以請您提供原始碼目錄的路徑嗎?
63
+
64
+ 您:
65
+ > ./src
66
+
67
+ AI 助理:
68
+ 謝謝您。我現在將分析 ./src 中的檔案,以提出一個文件結構建議。這可能需要一些時間...
69
+ ...
70
+ 我已經分析了您的專案並建立了一個建議的結構。在繼續產生內容之前,您想先檢視它嗎? (yes/no)
71
+
72
+ 您:
73
+ > yes
74
+
75
+ AI 助理:
76
+ (顯示建議的文件結構供檢視)
77
+ ...
78
+ 請檢視上方的結構。您可以要求我新增、移除或修改其中的任何部分。
79
+ ```
80
+
81
+ ## 總結
82
+
83
+ 互動式聊天助理是一個強大的工具,能以引導式、對話式的方式管理您的文件。它透過為您處理必要的步驟和指令,簡化了複雜的任務。
84
+
85
+ 若需特定工作流程的更詳細演練,請參閱 [產生文件](./guides-generating-documentation.md) 指南。
@@ -0,0 +1,85 @@
1
+ # 交互式聊天
2
+
3
+ 交互式聊天助手提供了一个对话式界面,用于生成、修改和管理您的文档。您无需运行单个命令,只需描述您需要做什么,助手就会引导您完成整个过程,并调用适当的工具来完成任务。
4
+
5
+ 这种方法通过为您处理底层命令来简化文档工作流。对于与该工具的大多数交互,这是推荐的方法。
6
+
7
+ ## 启动聊天助手
8
+
9
+ 要开始交互式会话,请在您的终端中运行 `chat` 命令:
10
+
11
+ ```bash
12
+ aigndoc chat
13
+ ```
14
+
15
+ 这将启动助手,您可以开始输入您的请求。
16
+
17
+ ## 核心功能
18
+
19
+ 聊天助手旨在处理整个文档生命周期。其主要功能包括:
20
+
21
+ <x-cards data-columns="2">
22
+ <x-card data-title="生成文档" data-icon="lucide:file-plus-2">
23
+ 通过分析您项目的源文件,创建完整的文档结构和初始内容。
24
+ </x-card>
25
+ <x-card data-title="优化和更新" data-icon="lucide:edit">
26
+ 根据您的反馈或源代码中的更改,重新生成特定部分或整个文档。
27
+ </x-card>
28
+ <x-card data-title="翻译内容" data-icon="lucide:languages">
29
+ 将现有文档翻译成多种语言,以覆盖更广泛的受众。
30
+ </x-card>
31
+ <x-card data-title="发布和管理" data-icon="lucide:upload-cloud">
32
+ 协助发布您的文档并管理基于团队的工作流。
33
+ </x-card>
34
+ </x-cards>
35
+
36
+ ## 可用命令
37
+
38
+ 在聊天中,您可以用自然语言陈述您的目标(例如,“更新入门指南”),或调用特定命令。助手能理解以下核心命令,这些命令与其专业技能相对应:
39
+
40
+ | Command | Description |
41
+ | :--- | :--- |
42
+ | `generate` | 从源文件开始创建新文档结构的过程。 |
43
+ | `update` | 根据代码更改或用户反馈修改现有文档。 |
44
+ | `translate` | 将文档翻译成一种或多种支持的语言。 |
45
+ | `publish` | 发布您的文档,使其可以在线访问。 |
46
+ | `init` | 指导您为项目创建初始配置文件。 |
47
+ | `clear` | 删除生成的文件、配置和缓存数据。 |
48
+ | `prefs` | 管理您保存的文档生成偏好设置。 |
49
+ | `evaluate` | 评估您生成的文档的质量和完整性。 |
50
+ | `history` | 显示您文档的更新历史。 |
51
+ | `exit` | 结束交互式聊天会话。 |
52
+
53
+ ## 交互示例
54
+
55
+ 以下是一个示例对话,用以说明交互式助手的工作方式。
56
+
57
+ ```text
58
+ You:
59
+ > 你好,我需要为一个新项目创建文档。
60
+
61
+ AI Assistant:
62
+ 当然。首先,我需要分析您的项目结构。您能提供源代码目录的路径吗?
63
+
64
+ You:
65
+ > ./src
66
+
67
+ AI Assistant:
68
+ 谢谢。我现在将分析 ./src 中的文件,以提出一个文档结构。这可能需要一些时间...
69
+ ...
70
+ 我已经分析了您的项目并创建了一个建议的结构。在继续生成内容之前,您想先预览一下吗? (yes/no)
71
+
72
+ You:
73
+ > yes
74
+
75
+ AI Assistant:
76
+ (显示建议的文档结构以供预览)
77
+ ...
78
+ 请预览上面的结构。您可以要求我添加、删除或修改其中的任何部分。
79
+ ```
80
+
81
+ ## 总结
82
+
83
+ 交互式聊天助手是一个强大的工具,能以引导式的对话方式管理您的文档。它通过为您处理必要的步骤和命令来简化复杂任务。
84
+
85
+ 关于特定工作流的更详细演练,请参阅 [生成文档](./guides-generating-documentation.md) 指南。
@@ -0,0 +1,51 @@
1
+ # 履歴の管理
2
+
3
+ AIGNE DocSmithは、ドキュメントに加えられたすべての更新の時系列ログを保持します。この機能により、変更を追跡し、更新時に提供されたフィードバックを確認し、時間とともにドキュメントがどのように進化してきたかを理解できます。このガイドでは、この履歴にアクセスして解釈する方法について説明します。
4
+
5
+ ## 更新履歴の表示
6
+
7
+ すべてのドキュメント更新のログを表示するには、`history view` コマンドを使用します。このコマンドは、バージョン管理ログのように、各エントリの簡潔な1行の概要を表示します。
8
+
9
+ ターミナルで次のコマンドを実行してください。
10
+
11
+ ```bash 履歴の表示 icon=material-symbols:history
12
+ aigne history view
13
+ ```
14
+
15
+ `history` コマンドは、`view` サブコマンドの2つのエイリアス、`log` と `list` もサポートしています。以下のコマンドは同等であり、同じ出力を生成します。
16
+
17
+ ```bash
18
+ aigne history log
19
+ ```
20
+
21
+ ```bash
22
+ aigne history list
23
+ ```
24
+
25
+ ### 履歴出力の理解
26
+
27
+ `history view` コマンドの出力は、各更新に関する主要な情報を一目でわかるようにフォーマットされています。各行は単一の更新エントリを表します。
28
+
29
+ 以下にそのフォーマットの内訳を示します。
30
+
31
+ | コンポーネント | 説明 |
32
+ | :--- | :--- |
33
+ | **短いハッシュ** | 更新のタイムスタンプから生成される7文字の一意の識別子。 |
34
+ | **日付** | 更新が発生した時期を示す相対的なタイムスタンプ(例:「5分前」、「2日前」)。古いエントリについては、特定の日付が表示されます。 |
35
+ | **操作** | 実行されたアクションの種類。例:`generate-document` や `update-document-detail`。 |
36
+ | **ドキュメントパス** | 操作が単一のファイルを対象とした場合に、変更された特定のドキュメントのパス。これは括弧で囲まれています。 |
37
+ | **フィードバック** | 更新が行われたときに提供されたフィードバックまたは概要メッセージ。 |
38
+
39
+ ### 例
40
+
41
+ 以下は、`aigne history view` コマンドを実行した際のサンプル出力です。
42
+
43
+ ```bash
44
+ 📜 更新履歴
45
+
46
+ e5a4f8b 2 hours ago update-document-detail (/guides/generating-documentation): Added a new section on advanced configuration options.
47
+ a3b1c9d 1 day ago update-document-detail (/overview): Refined the introduction to be more concise.
48
+ f8d2e0c 3 days ago generate-document (/guides/managing-history): Initial generation of the history management guide.
49
+ ```
50
+
51
+ このログは、ドキュメントの変更履歴を明確かつ整然と記録するもので、進捗の追跡や過去の変更の確認に役立ちます。
@@ -0,0 +1,51 @@
1
+ # Managing History
2
+
3
+ AIGNE DocSmith maintains a chronological log of all updates made to your documentation. This feature allows you to track changes, review feedback provided during updates, and understand the evolution of your documents over time. This guide provides instructions on how to access and interpret this history.
4
+
5
+ ## Viewing Update History
6
+
7
+ To view the log of all documentation updates, you can use the `history view` command. This command displays a compact, one-line summary for each entry, similar to a version control log.
8
+
9
+ Execute the following command in your terminal:
10
+
11
+ ```bash Viewing History icon=material-symbols:history
12
+ aigne history view
13
+ ```
14
+
15
+ The `history` command also supports two aliases for the `view` subcommand: `log` and `list`. The following commands are equivalent and will produce the same output:
16
+
17
+ ```bash
18
+ aigne history log
19
+ ```
20
+
21
+ ```bash
22
+ aigne history list
23
+ ```
24
+
25
+ ### Understanding the History Output
26
+
27
+ The output of the `history view` command is formatted to provide key information about each update at a glance. Each line represents a single update entry.
28
+
29
+ Here is a breakdown of the format:
30
+
31
+ | Component | Description |
32
+ | :--- | :--- |
33
+ | **Short Hash** | A 7-character unique identifier generated from the timestamp of the update. |
34
+ | **Date** | A relative timestamp indicating when the update occurred (e.g., "5 minutes ago", "2 days ago"). For older entries, a specific date is shown. |
35
+ | **Operation** | The type of action performed, such as `generate-document` or `update-document-detail`. |
36
+ | **Document Path** | The path of the specific document that was modified, if the operation targeted a single file. This is enclosed in parentheses. |
37
+ | **Feedback** | The feedback or summary message that was provided when the update was made. |
38
+
39
+ ### Example
40
+
41
+ Below is a sample output from running the `aigne history view` command.
42
+
43
+ ```bash
44
+ 📜 Update History
45
+
46
+ e5a4f8b 2 hours ago update-document-detail (/guides/generating-documentation): Added a new section on advanced configuration options.
47
+ a3b1c9d 1 day ago update-document-detail (/overview): Refined the introduction to be more concise.
48
+ f8d2e0c 3 days ago generate-document (/guides/managing-history): Initial generation of the history management guide.
49
+ ```
50
+
51
+ This log provides a clear and orderly record of your documentation's modification history, which is useful for tracking progress and reviewing past changes.
@@ -0,0 +1,51 @@
1
+ # 管理歷史記錄
2
+
3
+ AIGNE DocSmith 會按時間順序記錄您對文件所做的所有更新。此功能可讓您追蹤變更、檢視更新期間提供的回饋,並了解文件隨時間的演變。本指南將說明如何存取和解讀此歷史記錄。
4
+
5
+ ## 檢視更新歷史記錄
6
+
7
+ 若要檢視所有文件更新的日誌,您可以使用 `history view` 指令。此指令會為每個條目顯示一個精簡的單行摘要,類似於版本控制日誌。
8
+
9
+ 在您的終端機中執行以下指令:
10
+
11
+ ```bash 檢視歷史記錄 icon=material-symbols:history
12
+ aigne history view
13
+ ```
14
+
15
+ `history` 指令也支援 `view` 子指令的兩個別名:`log` 和 `list`。以下指令是等效的,並會產生相同的輸出:
16
+
17
+ ```bash
18
+ aigne history log
19
+ ```
20
+
21
+ ```bash
22
+ aigne history list
23
+ ```
24
+
25
+ ### 了解歷史記錄輸出
26
+
27
+ `history view` 指令的輸出格式旨在讓您能一目了然地獲取每次更新的關鍵資訊。每一行代表一個單獨的更新條目。
28
+
29
+ 以下是格式的詳細說明:
30
+
31
+ | 元件 | 說明 |
32
+ | :--- | :--- |
33
+ | **短雜湊值** | 從更新時間戳記產生的 7 個字元唯一識別碼。 |
34
+ | **日期** | 一個相對時間戳記,表示更新發生的時間(例如,「5 minutes ago」、「2 days ago」)。對於較舊的條目,則會顯示具體日期。 |
35
+ | **操作** | 執行的操作類型,例如 `generate-document` 或 `update-document-detail`。 |
36
+ | **文件路徑** | 如果操作針對單一檔案,則為被修改的特定文件路徑。此路徑會用括號括起來。 |
37
+ | **回饋** | 進行更新時所提供的回饋或摘要訊息。 |
38
+
39
+ ### 範例
40
+
41
+ 以下是執行 `aigne history view` 指令的範例輸出。
42
+
43
+ ```bash
44
+ 📜 Update History
45
+
46
+ e5a4f8b 2 hours ago update-document-detail (/guides/generating-documentation): Added a new section on advanced configuration options.
47
+ a3b1c9d 1 day ago update-document-detail (/overview): Refined the introduction to be more concise.
48
+ f8d2e0c 3 days ago generate-document (/guides/managing-history): Initial generation of the history management guide.
49
+ ```
50
+
51
+ 此日誌提供了您文件修改歷史的清晰有序記錄,對於追蹤進度和檢視過去的變更非常有用。
@@ -0,0 +1,51 @@
1
+ # 管理历史记录
2
+
3
+ AIGNE DocSmith 会按时间顺序记录对您文档所做的所有更新。此功能让您可以跟踪变更,审查更新期间提供的反馈,并了解文档随时间的演变过程。本指南将说明如何访问和解读此历史记录。
4
+
5
+ ## 查看更新历史记录
6
+
7
+ 要查看所有文档更新的日志,您可以使用 `history view` 命令。该命令会为每个条目显示一个紧凑的单行摘要,类似于版本控制日志。
8
+
9
+ 在您的终端中执行以下命令:
10
+
11
+ ```bash 查看历史记录 icon=material-symbols:history
12
+ aigne history view
13
+ ```
14
+
15
+ `history` 命令还支持 `view` 子命令的两个别名:`log` 和 `list`。以下命令是等效的,将产生相同的输出:
16
+
17
+ ```bash
18
+ aigne history log
19
+ ```
20
+
21
+ ```bash
22
+ aigne history list
23
+ ```
24
+
25
+ ### 理解历史记录输出
26
+
27
+ `history view` 命令的输出格式旨在让您能一目了然地获取每次更新的关键信息。每一行代表一个单独的更新条目。
28
+
29
+ 以下是格式的详细说明:
30
+
31
+ | 组件 | 描述 |
32
+ | :--- | :--- |
33
+ | **短哈希** | 一个根据更新时间戳生成的 7 个字符的唯一标识符。 |
34
+ | **日期** | 一个相对时间戳,指示更新发生的时间(例如,“5 minutes ago”、“2 days ago”)。对于较旧的条目,会显示具体日期。 |
35
+ | **操作** | 执行的操作类型,例如 `generate-document` 或 `update-document-detail`。 |
36
+ | **文档路径** | 被修改的具体文档的路径,如果操作针对单个文件。该路径包含在括号中。 |
37
+ | **反馈** | 进行更新时提供的反馈或摘要信息。 |
38
+
39
+ ### 示例
40
+
41
+ 以下是运行 `aigne history view` 命令的示例输出。
42
+
43
+ ```bash
44
+ 📜 更新历史记录
45
+
46
+ e5a4f8b 2 小时前 update-document-detail (/guides/generating-documentation): 添加了关于高级配置选项的新章节。
47
+ a3b1c9d 1 天前 update-document-detail (/overview): 优化了引言,使其更加简洁。
48
+ f8d2e0c 3 天前 generate-document (/guides/managing-history): 初次生成历史记录管理指南。
49
+ ```
50
+
51
+ 此日志为您的文档修改历史提供了清晰有序的记录,有助于跟踪进度和回顾过去的变更。
@@ -0,0 +1,78 @@
1
+ # ドキュメントの公開
2
+
3
+ ドキュメントを生成したら、次のステップはそれをオンラインで公開し、読者がアクセスできるようにすることです。このガイドでは、`aigne doc publish` コマンドを使用した公開プロセスの体系的な概要を説明します。
4
+
5
+ ## 公開コマンド
6
+
7
+ ドキュメントを公開するための主要なコマンドは `aigne doc publish` です。このコマンドは、生成されたファイルをウェブサービスにアップロードし、ブラウザで表示できるようにします。
8
+
9
+ このコマンドは、フルネームまたは短いエイリアスで実行できます:
10
+
11
+ ```bash
12
+ # フルコマンド
13
+ aigne doc publish
14
+
15
+ # エイリアス
16
+ aigne doc pub
17
+ aigne doc p
18
+ ```
19
+
20
+ publish コマンドを初めて実行すると、希望する公開プラットフォームを選択するための対話型プロンプトが表示されます。
21
+
22
+ ## 公開オプション
23
+
24
+ ドキュメントをホストする場所にはいくつかのオプションがあります。対話型プロンプトが選択をガイドします。
25
+
26
+ ### 1. DocSmith Cloud(無料ホスティング)
27
+
28
+ このオプションは、AIGNE が提供する無料のホスティングサービスである `docsmith.aigne.io` にドキュメントを公開します。
29
+
30
+ - **ユースケース:** オープンソースプロジェクト、個人ブログなど、カスタムインフラを必要とせず公開アクセスが必要なあらゆるシナリオに最適です。
31
+ - **コスト:** 無料。
32
+ - **結果:** 公開が成功すると、提供された URL でドキュメントが公開されます。
33
+
34
+ ### 2. 既存のウェブサイト
35
+
36
+ このオプションを使用すると、すでに所有および管理しているウェブサイトにドキュメントを公開できます。
37
+
38
+ - **ユースケース:** 既存の会社のウェブサイト、製品サイト、または個人ドメインにドキュメントを直接統合する場合に最適です。この方法では、Discuss Kit の独自のインスタンスを実行する必要があります。
39
+ - **コスト:** 独自のホスティングインフラが必要です。
40
+ - **セットアップ:**
41
+ 1. プロンプトでこのオプションを選択します。
42
+ 2. ウェブサイトの URL を入力するよう求められます(例:`https://docs.your-company.com`)。
43
+ 3. 独自のドキュメントウェブサイトをセットアップするには、公式ストアから Discuss Kit インスタンスを入手できます:[https://www.web3kit.rocks/discuss-kit](https://www.web3kit.rocks/discuss-kit)。
44
+
45
+ ### 3. 新規ウェブサイト(有料サービス)
46
+
47
+ 既存のウェブサイトがない場合、このサービスはドキュメント専用の新しいサイトをセットアップするのに役立ちます。
48
+
49
+ - **ユースケース:** カスタムドメインと管理されたホスティングを備えた、プロフェッショナルでスタンドアロンのドキュメントポータルを作成するのに適しています。
50
+ - **コスト:** これは有料サービスです。
51
+ - **プロセス:** コマンドは、新しい Discuss Kit インスタンスのデプロイと設定に必要な手順をガイドします。このプロセスを以前に開始したことがある場合は、以前のセットアップを再開するオプションも表示されます。
52
+
53
+ ## 直接公開
54
+
55
+ CI/CD パイプラインなどの自動化されたワークフローの場合、または初期設定が完了した後は、アプリケーションの URL を直接指定することで対話型プロンプトをバイパスできます。
56
+
57
+ `--appUrl` フラグに続けてウェブサイトの URL を指定します。
58
+
59
+ ```bash
60
+ # カスタムドキュメントサイトの例
61
+ aigne doc publish --appUrl https://docs.your-company.com
62
+ ```
63
+
64
+ 特定の URL への公開に成功すると(プロンプトでオプションを選択するか、`--appUrl` フラグを使用するかのいずれか)、DocSmith はこの URL をローカル設定に保存します。次回以降の実行時には、再度尋ねることなく、保存された URL に自動的に公開します。
65
+
66
+ ## トラブルシューティング
67
+
68
+ ### 認証エラー
69
+
70
+ 「401」または「403」を含むエラーメッセージが表示された場合、認証トークンが無効であるか、期限切れであることを示します。これは、権限が変更された場合や、トークンが古い場合に発生する可能性があります。
71
+
72
+ これを解決するには、`clear` コマンドを実行して、保存されているすべての設定と認証情報をクリアします:
73
+
74
+ ```bash
75
+ aigne doc clear
76
+ ```
77
+
78
+ 設定をクリアした後、再度 `aigne doc publish` を実行してください。初めて実行したときのように、認証とセットアップのプロセスがガイドされます。
@@ -0,0 +1,78 @@
1
+ # Publishing Your Docs
2
+
3
+ Once you have generated your documentation, the next step is to publish it online, making it accessible to your audience. This guide provides a systematic overview of the publishing process using the `aigne doc publish` command.
4
+
5
+ ## The Publish Command
6
+
7
+ The primary command for making your documentation live is `aigne doc publish`. This command uploads your generated files to a web service, where they can be viewed in a browser.
8
+
9
+ You can execute the command using its full name or its shorter aliases:
10
+
11
+ ```bash
12
+ # Full command
13
+ aigne doc publish
14
+
15
+ # Aliases
16
+ aigne doc pub
17
+ aigne doc p
18
+ ```
19
+
20
+ When you run the publish command for the first time, you will be presented with an interactive prompt to select your preferred publishing platform.
21
+
22
+ ## Publishing Options
23
+
24
+ You have several options for where to host your documentation. The interactive prompt will guide you through the selection.
25
+
26
+ ### 1. DocSmith Cloud (Free Hosting)
27
+
28
+ This option publishes your documentation to `docsmith.aigne.io`, a free hosting service provided by AIGNE.
29
+
30
+ - **Use Case:** Ideal for open-source projects, personal blogs, or any scenario where public accessibility is desired without the need for custom infrastructure.
31
+ - **Cost:** Free.
32
+ - **Outcome:** Your documents will be publicly available at a URL provided upon successful publication.
33
+
34
+ ### 2. Your Existing Website
35
+
36
+ This option allows you to publish the documentation to a website that you already own and manage.
37
+
38
+ - **Use Case:** Best for integrating documentation directly into an existing company website, product site, or personal domain. This method requires you to run your own instance of Discuss Kit.
39
+ - **Cost:** Requires your own hosting infrastructure.
40
+ - **Setup:**
41
+ 1. Select this option in the prompt.
42
+ 2. You will be asked to enter the URL of your website (e.g., `https://docs.your-company.com`).
43
+ 3. To set up your own documentation website, you can get a Discuss Kit instance from the official store: [https://www.web3kit.rocks/discuss-kit](https://www.web3kit.rocks/discuss-kit).
44
+
45
+ ### 3. New Website (Paid Service)
46
+
47
+ If you do not have an existing website, this service helps you set up a new, dedicated site for your documentation.
48
+
49
+ - **Use Case:** Suitable for creating a professional, standalone documentation portal with a custom domain and hosting managed for you.
50
+ - **Cost:** This is a paid service.
51
+ - **Process:** The command will guide you through the necessary steps to deploy and configure a new Discuss Kit instance. If you have started this process before, you will also see an option to resume your previous setup.
52
+
53
+ ## Direct Publishing
54
+
55
+ For automated workflows, such as CI/CD pipelines, or after you have completed the initial setup, you can bypass the interactive prompt by specifying the application URL directly.
56
+
57
+ Use the `--appUrl` flag followed by your website's URL.
58
+
59
+ ```bash
60
+ # Example for a custom documentation site
61
+ aigne doc publish --appUrl https://docs.your-company.com
62
+ ```
63
+
64
+ Once you successfully publish to a specific URL (either by selecting an option in the prompt or by using the `--appUrl` flag), DocSmith saves this URL in your local configuration. On subsequent runs, it will automatically publish to the saved URL without asking again.
65
+
66
+ ## Troubleshooting
67
+
68
+ ### Authorization Errors
69
+
70
+ If you encounter an error message containing "401" or "403," it indicates that your authentication token is invalid or has expired. This can happen if permissions have changed or if the token is old.
71
+
72
+ To resolve this, you can clear all stored configuration and credentials by running the `clear` command:
73
+
74
+ ```bash
75
+ aigne doc clear
76
+ ```
77
+
78
+ After clearing the configuration, run `aigne doc publish` again. You will be guided through the authentication and setup process as if it were the first time.