@aigne/doc-smith 0.8.12-beta.6 → 0.8.12-beta.8

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 (91) hide show
  1. package/.aigne/doc-smith/config.yaml +1 -1
  2. package/.aigne/doc-smith/history.yaml +37 -0
  3. package/.aigne/doc-smith/media-description.yaml +91 -0
  4. package/.aigne/doc-smith/preferences.yml +12 -0
  5. package/.aigne/doc-smith/upload-cache.yaml +36 -69
  6. package/.release-please-manifest.json +1 -1
  7. package/CHANGELOG.md +24 -0
  8. package/agents/clear/choose-contents.mjs +14 -1
  9. package/agents/clear/clear-media-description.mjs +129 -0
  10. package/agents/clear/index.yaml +3 -1
  11. package/agents/evaluate/code-snippet.mjs +28 -24
  12. package/agents/evaluate/document-structure.yaml +0 -4
  13. package/agents/evaluate/document.yaml +1 -5
  14. package/agents/generate/index.yaml +1 -0
  15. package/agents/generate/update-document-structure.yaml +9 -3
  16. package/agents/history/view.mjs +5 -2
  17. package/agents/init/index.mjs +10 -0
  18. package/agents/media/batch-generate-media-description.yaml +44 -0
  19. package/agents/media/generate-media-description.yaml +47 -0
  20. package/agents/media/load-media-description.mjs +238 -0
  21. package/agents/update/generate-document.yaml +10 -4
  22. package/agents/update/index.yaml +1 -0
  23. package/agents/update/update-document-detail.yaml +9 -3
  24. package/agents/update/user-review-document.mjs +2 -1
  25. package/agents/utils/load-sources.mjs +103 -53
  26. package/aigne.yaml +6 -0
  27. package/assets/report-template/report.html +34 -34
  28. package/docs/configuration-initial-setup.md +74 -55
  29. package/docs/configuration.ja.md +59 -86
  30. package/docs/configuration.md +59 -86
  31. package/docs/configuration.zh-TW.md +59 -86
  32. package/docs/configuration.zh.md +59 -86
  33. package/docs/getting-started.ja.md +43 -24
  34. package/docs/getting-started.md +29 -10
  35. package/docs/getting-started.zh-TW.md +42 -23
  36. package/docs/getting-started.zh.md +39 -20
  37. package/docs/guides-cleaning-up.ja.md +16 -15
  38. package/docs/guides-cleaning-up.md +19 -17
  39. package/docs/guides-cleaning-up.zh-TW.md +16 -15
  40. package/docs/guides-cleaning-up.zh.md +12 -11
  41. package/docs/guides-evaluating-documents.md +70 -29
  42. package/docs/guides-generating-documentation.ja.md +34 -32
  43. package/docs/guides-generating-documentation.md +59 -119
  44. package/docs/guides-generating-documentation.zh-TW.md +34 -32
  45. package/docs/guides-generating-documentation.zh.md +30 -28
  46. package/docs/guides-interactive-chat.md +34 -26
  47. package/docs/guides-managing-history.ja.md +17 -20
  48. package/docs/guides-managing-history.md +19 -17
  49. package/docs/guides-managing-history.zh-TW.md +18 -21
  50. package/docs/guides-managing-history.zh.md +13 -16
  51. package/docs/guides-publishing-your-docs.md +40 -35
  52. package/docs/guides-translating-documentation.ja.md +17 -17
  53. package/docs/guides-translating-documentation.md +39 -34
  54. package/docs/guides-translating-documentation.zh-TW.md +21 -21
  55. package/docs/guides-translating-documentation.zh.md +18 -18
  56. package/docs/guides-updating-documentation.ja.md +35 -35
  57. package/docs/guides-updating-documentation.md +11 -9
  58. package/docs/guides-updating-documentation.zh-TW.md +27 -27
  59. package/docs/guides-updating-documentation.zh.md +26 -26
  60. package/docs/overview.ja.md +13 -13
  61. package/docs/overview.md +2 -2
  62. package/docs/overview.zh-TW.md +19 -19
  63. package/docs/overview.zh.md +16 -16
  64. package/docs/release-notes.md +60 -27
  65. package/package.json +2 -1
  66. package/prompts/common/afs/afs-tools-usage.md +5 -0
  67. package/prompts/common/afs/use-afs-instruction.md +1 -0
  68. package/prompts/detail/generate/system-prompt.md +0 -13
  69. package/prompts/detail/generate/user-prompt.md +7 -0
  70. package/prompts/detail/update/system-prompt.md +1 -2
  71. package/prompts/detail/update/user-prompt.md +7 -0
  72. package/prompts/evaluate/document-structure.md +6 -7
  73. package/prompts/evaluate/document.md +16 -25
  74. package/prompts/media/media-description/system-prompt.md +35 -0
  75. package/prompts/media/media-description/user-prompt.md +8 -0
  76. package/prompts/structure/generate/system-prompt.md +0 -19
  77. package/prompts/structure/generate/user-prompt.md +22 -1
  78. package/prompts/structure/update/system-prompt.md +0 -17
  79. package/prompts/structure/update/user-prompt.md +24 -0
  80. package/tests/agents/history/view.test.mjs +97 -0
  81. package/tests/utils/history-utils.test.mjs +125 -97
  82. package/utils/constants/index.mjs +0 -107
  83. package/utils/file-utils.mjs +42 -1
  84. package/utils/history-utils.mjs +3 -3
  85. package/agents/update/fs-tools/glob.mjs +0 -184
  86. package/agents/update/fs-tools/grep.mjs +0 -317
  87. package/agents/update/fs-tools/read-file.mjs +0 -309
  88. package/media.md +0 -19
  89. package/tests/agents/update/fs-tools/glob.test.mjs +0 -438
  90. package/tests/agents/update/fs-tools/grep.test.mjs +0 -279
  91. package/tests/agents/update/fs-tools/read-file.test.mjs +0 -549
@@ -1,18 +1,18 @@
1
- # 開始使用
1
+ # 入門指南
2
2
 
3
- 本指南提供安裝 AIGNE DocSmith 並產生第一份文件的逐步流程。整個過程設計得簡單明瞭,可以快速完成。
3
+ 本指南提供安裝 AIGNE DocSmith 並產生第一份文件的逐步流程。整個過程設計得相當簡單,幾分鐘內即可完成。
4
4
 
5
- ## 前提條件
5
+ ## 先決條件
6
6
 
7
- 在進行安裝之前,請確保您的系統符合以下要求:
7
+ 在開始安裝之前,請確保您的系統符合以下要求:
8
8
 
9
- * **Node.js**:需要 20 或更新版本。DocSmith 使用 Node Package Manager (npm) 安裝,npm 包含在 Node.js 的安裝中。若要安裝 Node.js,請造訪官方 [Node.js 網站](https://nodejs.org/) 並按照您作業系統的說明進行操作。您可以透過開啟終端機並執行 `node -v` 和 `npm -v` 來驗證安裝。
9
+ * **Node.js**:需要 20 或更新版本。DocSmith 使用 Node Package Manager (npm) 安裝,npm 已包含在 Node.js 的安裝程式中。若要安裝 Node.js,請造訪官方 [Node.js 網站](https://nodejs.org/) 並依照您作業系統的說明進行操作。您可以開啟終端機並執行 `node -v` 和 `npm -v` 來驗證安裝。
10
10
 
11
- * **API 金鑰**:開始時不需要任何 API 金鑰。預設情況下,DocSmith 使用 AIGNE Hub 服務進行 AI 驅動的生成,讓您無需直接設定即可使用各種大型語言模型。
11
+ * **API 金鑰**:開始時不需要任何 API 金鑰。預設情況下,DocSmith 使用 AIGNE Hub 服務進行 AI 驅動的產生,讓您無需直接設定即可使用各種大型語言模型。
12
12
 
13
13
  ## 安裝
14
14
 
15
- 此工具作為 AIGNE 命令列介面 (CLI) 的一部分進行分發。
15
+ 此工具是 AIGNE 命令列介面 (CLI) 的一部分。安裝過程包含兩個簡單的步驟。
16
16
 
17
17
  ### 步驟 1:安裝 AIGNE CLI
18
18
 
@@ -22,17 +22,17 @@
22
22
  npm install -g @aigne/cli
23
23
  ```
24
24
 
25
- 此指令會下載並安裝套件,使 `aigne` 指令在任何目錄下都可用。
25
+ 此指令會從 npm 登錄檔下載並安裝套件,讓 `aigne` 指令可以在您終端機的任何目錄中使用。
26
26
 
27
27
  ### 步驟 2:驗證安裝
28
28
 
29
- 安裝完成後,請執行文件工具的說明指令來進行驗證:
29
+ 安裝完成後,您可以執行文件工具的說明指令來進行驗證:
30
30
 
31
31
  ```bash title="驗證安裝"
32
32
  aigne doc --help
33
33
  ```
34
34
 
35
- 此指令應會顯示可用的 DocSmith 指令與選項列表,確認安裝成功。
35
+ 此指令應會顯示可用的 DocSmith 指令及其選項列表,這表示安裝已成功。
36
36
 
37
37
  ## 產生您的第一份文件
38
38
 
@@ -40,15 +40,15 @@ aigne doc --help
40
40
 
41
41
  ### 步驟 1:導覽至您的專案目錄
42
42
 
43
- 開啟您的終端機,並使用 `cd` 指令將目前目錄切換到您想要建立文件的專案根目錄。
43
+ 開啟您的終端機,並使用 `cd` 指令將當前目錄切換到您想要建立文件的專案根目錄。
44
44
 
45
- ```bash title="切換目錄" icon=mdi:folder-open
45
+ ```bash title="變更目錄" icon=mdi:folder-open
46
46
  cd /path/to/your/project
47
47
  ```
48
48
 
49
49
  ### 步驟 2:執行產生指令
50
50
 
51
- 執行主要的 `generate` 指令。這個單一指令會處理整個文件建立過程。
51
+ 執行主要的 `generate` 指令。這個單一指令能處理從分析到內容產生的整個文件建立過程。
52
52
 
53
53
  ```bash title="執行產生指令"
54
54
  aigne doc generate
@@ -56,33 +56,52 @@ aigne doc generate
56
56
 
57
57
  ### 步驟 3:完成互動式設定
58
58
 
59
- 當您第一次在專案中執行 `generate` 指令時,DocSmith 將啟動一次性的互動式設定流程。系統會詢問您一系列問題來設定您的文件偏好,例如其主要目的、目標受眾和語言。設定完成後,將會在 `.aigne/doc-smith` 目錄中建立一個 `config.yaml` 檔案來儲存您的設定。
59
+ 當您第一次在專案中執行 `generate` 指令時,DocSmith 將啟動一次性的互動式設定流程。系統將引導您回答一系列問題,以設定您的文件偏好,例如其主要目的、目標受眾和語言。
60
+
61
+ ![互動式設定過程的螢幕截圖](../assets/screenshots/doc-complete-setup.png)
62
+
63
+ 您的回答會儲存到位於 `.aigne/doc-smith` 目錄中的 `config.yaml` 檔案。如果需要,之後可以手動編輯此檔案。
60
64
 
61
65
  ### 步驟 4:等待產生
62
66
 
63
67
  設定完成後,DocSmith 將自動執行以下操作:
64
68
 
65
- 1. **分析程式碼庫**:掃描您的原始檔案以了解專案的結構和邏輯。
66
- 2. **規劃結構**:為文件建立一個邏輯計畫,包含章節和主題。
69
+ 1. **分析程式碼庫**:掃描您的原始碼檔案,以了解專案的結構、功能和邏輯。
70
+ 2. **規劃結構**:為文件建立一個邏輯計畫,概述章節和主題。
67
71
  3. **產生內容**:根據分析和您的設定撰寫文件內容。
68
72
 
69
- 完成後,將會出現一則確認訊息,且產生的檔案將位於設定時指定的輸出目錄中(例如 `.aigne/doc-smith/docs`)。
73
+ 完成後,將會出現一則確認訊息,且產生的檔案將位於設定時指定的輸出目錄中(預設為 `.aigne/doc-smith/docs`)。
74
+
75
+ ![產生成功後顯示的成功訊息螢幕截圖](../assets/screenshots/doc-generated-successfully.png)
76
+
77
+ ## 探索所有指令
78
+
79
+ DocSmith 提供了一組指令來管理您文件的完整生命週期。下表列出了所有可用的指令及其功能。
80
+
81
+ | Command | Description |
82
+ | :---------- | :------------------------------------------------------------------------------------------------------------ |
83
+ | `generate` | 分析程式碼庫並根據設定產生一套完整的文件。 |
84
+ | `update` | 以互動方式選取並重新產生現有文件的特定部分,通常會附上新的回饋。 |
85
+ | `translate` | 將現有文件翻譯成 12 種支援語言中的一種或多種,例如 `zh` 或 `ja`。 |
86
+ | `publish` | 將產生的文件發布到一個線上平台,使其可透過 URL 存取。 |
87
+ | `init` | 啟動互動式設定精靈,以建立或覆寫 `config.yaml` 設定檔。 |
88
+ | `prefs` | 顯示 `config.yaml` 檔案中的目前設定。 |
70
89
 
71
- ## 接下來呢?
90
+ ## 下一步是什麼?
72
91
 
73
- 您已成功產生第一份文件。以下是管理和強化文件的常見後續步驟:
92
+ 您已成功產生第一份文件。以下是管理和增強文件的常見後續步驟:
74
93
 
75
94
  <x-cards data-columns="2">
76
95
  <x-card data-title="更新文件" data-icon="lucide:refresh-cw" data-href="/guides/updating-documentation">
77
96
  根據程式碼變更或新需求,修改或重新產生文件的特定部分。
78
97
  </x-card>
79
98
  <x-card data-title="翻譯文件" data-icon="lucide:languages" data-href="/guides/translating-documentation">
80
- 將您的文件翻譯成 12 種支援的語言之一,例如中文、西班牙文或德文。
99
+ 將您的文件翻譯成 12 種支援的語言中的任何一種,例如中文、西班牙文或德文。
81
100
  </x-card>
82
101
  <x-card data-title="發布您的文件" data-icon="lucide:rocket" data-href="/guides/publishing-your-docs">
83
- 將您的文件發布到網路上,供您的團隊或大眾使用。
102
+ 讓您的團隊或大眾可以在線上存取您的文件。
84
103
  </x-card>
85
104
  <x-card data-title="檢視設定" data-icon="lucide:settings" data-href="/configuration/initial-setup">
86
- 檢視並修改在初始設定期間建立的 config.yaml 檔案,以調整您的偏好設定。
105
+ 檢視並修改在初始設定期間建立的 config.yaml 檔案,以調整您的偏好。
87
106
  </x-card>
88
- </x-cards>
107
+ </x-cards>
@@ -1,18 +1,18 @@
1
1
  # 快速入门
2
2
 
3
- 本指南提供了安装 AIGNE DocSmith 并生成您的第一套文档的分步流程。该过程设计得非常简单,可以快速完成。
3
+ 本指南提供了安装 AIGNE DocSmith 并生成您的第一套文档的分步流程。该过程设计得简单明了,几分钟内即可完成。
4
4
 
5
- ## 前置要求
5
+ ## 前提条件
6
6
 
7
7
  在继续安装之前,请确保您的系统满足以下要求:
8
8
 
9
- * **Node.js**:需要 20 或更高版本。DocSmith 使用 Node.js 包管理器(npm)进行安装,该管理器包含在 Node.js 的安装包中。要安装 Node.js,请访问 [Node.js 官方网站](https://nodejs.org/) 并按照适用于您操作系统的说明进行操作。您可以通过打开终端并运行 `node -v` 和 `npm -v` 来验证安装。
9
+ * **Node.js**:需要 20 或更高版本。DocSmith 使用 Node Package Manager (npm) 进行安装,npm 已包含在 Node.js 的安装包中。要安装 Node.js,请访问官方 [Node.js 网站](https://nodejs.org/) 并按照适用于您操作系统的说明进行操作。您可以通过打开终端并运行 `node -v` 和 `npm -v` 来验证安装。
10
10
 
11
- * **API 密钥**:开始时不需要任何 API 密钥。默认情况下,DocSmith 使用 AIGNE Hub 服务进行 AI 驱动的生成,这使您无需直接配置即可使用各种大型语言模型。
11
+ * **API 密钥**:开始时无需任何 API 密钥。默认情况下,DocSmith 使用 AIGNE Hub 服务进行 AI 驱动的生成,这使您无需直接配置即可使用各种大型语言模型。
12
12
 
13
13
  ## 安装
14
14
 
15
- 该工具作为 AIGNE 命令行界面(CLI)的一部分进行分发。
15
+ 该工具作为 AIGNE 命令行界面 (CLI) 的一部分进行分发。安装过程包括两个简单的步骤。
16
16
 
17
17
  ### 第 1 步:安装 AIGNE CLI
18
18
 
@@ -22,21 +22,21 @@
22
22
  npm install -g @aigne/cli
23
23
  ```
24
24
 
25
- 该命令会下载并安装软件包,使 `aigne` 命令在任何目录下都可用。
25
+ 此命令会从 npm 注册表下载并安装该软件包,使 `aigne` 命令在您终端的任何目录中都可用。
26
26
 
27
27
  ### 第 2 步:验证安装
28
28
 
29
- 安装完成后,通过运行文档工具的帮助命令来验证安装:
29
+ 安装完成后,您可以通过运行文档工具的帮助命令来验证安装:
30
30
 
31
31
  ```bash title="验证安装"
32
32
  aigne doc --help
33
33
  ```
34
34
 
35
- 该命令应显示 DocSmith 的可用命令和选项列表,以确认安装成功。
35
+ 此命令应显示可用的 DocSmith 命令及其选项列表,这确认了安装已成功。
36
36
 
37
37
  ## 生成您的第一份文档
38
38
 
39
- 请按照以下步骤分析您的项目并生成一套完整的文档。
39
+ 请按照以下步骤分析您的项目并生成一整套文档。
40
40
 
41
41
  ### 第 1 步:导航到您的项目目录
42
42
 
@@ -48,7 +48,7 @@ cd /path/to/your/project
48
48
 
49
49
  ### 第 2 步:运行生成命令
50
50
 
51
- 执行主要的 `generate` 命令。这个单一的命令会处理整个文档创建过程。
51
+ 执行主要的 `generate` 命令。这一个命令即可处理从分析到内容生成的整个文档创建过程。
52
52
 
53
53
  ```bash title="运行生成命令"
54
54
  aigne doc generate
@@ -56,17 +56,36 @@ aigne doc generate
56
56
 
57
57
  ### 第 3 步:完成交互式设置
58
58
 
59
- 当您首次在项目中运行 `generate` 命令时,DocSmith 将启动一次性的交互式设置过程。系统会询问您一系列问题,以配置您的文档偏好,例如其主要目的、目标受众和语言。系统将在 `.aigne/doc-smith` 目录中创建一个 `config.yaml` 文件来存储您的设置。
59
+ 当您首次在项目中运行 `generate` 命令时,DocSmith 将启动一次性的交互式设置过程。系统将引导您完成一系列问题,以配置您的文档偏好,例如其主要目的、目标受众和语言。
60
+
61
+ ![交互式设置过程的屏幕截图](../assets/screenshots/doc-complete-setup.png)
62
+
63
+ 您的回答将保存到位于 `.aigne/doc-smith` 目录中的 `config.yaml` 文件。如果需要,稍后可以手动编辑此文件。
60
64
 
61
65
  ### 第 4 步:等待生成
62
66
 
63
67
  设置完成后,DocSmith 将自动执行以下操作:
64
68
 
65
- 1. **分析代码库**:它会扫描您的源文件以理解项目的结构和逻辑。
66
- 2. **规划结构**:它会为文档创建一个逻辑计划,包括章节和主题。
67
- 3. **生成内容**:它会根据分析和您的配置来编写文档内容。
69
+ 1. **分析代码库**:扫描您的源文件以了解项目的结构、功能和逻辑。
70
+ 2. **规划结构**:为文档创建一个逻辑规划,概述各个部分和主题。
71
+ 3. **生成内容**:根据分析和您的配置编写文档内容。
72
+
73
+ 完成后,将出现一条确认消息,生成的文件将位于设置期间指定的输出目录中(默认为 `.aigne/doc-smith/docs`)。
74
+
75
+ ![生成成功后显示成功消息的屏幕截图](../assets/screenshots/doc-generated-successfully.png)
76
+
77
+ ## 探索所有命令
78
+
79
+ DocSmith 提供了一组命令来管理文档的整个生命周期。下表列出了所有可用命令及其功能。
68
80
 
69
- 完成后,将显示一条确认消息,生成的文件将位于设置期间指定的输出目录中(例如 `.aigne/doc-smith/docs`)。
81
+ | 命令 | 描述 |
82
+ | :---------- | :------------------------------------------------------------------------------------------------------------ |
83
+ | `generate` | 分析代码库并根据配置生成一整套文档。 |
84
+ | `update` | 交互式地选择并重新生成现有文档的特定部分,通常会附带新的反馈。 |
85
+ | `translate` | 将现有文档翻译成 12 种支持的语言中的一种或多种,例如 `zh` 或 `ja`。 |
86
+ | `publish` | 将生成的文档发布到实时平台,使其可通过 URL 访问。 |
87
+ | `init` | 启动交互式设置向导以创建或覆盖 `config.yaml` 配置文件。 |
88
+ | `prefs` | 显示 `config.yaml` 文件中的当前配置设置。 |
70
89
 
71
90
  ## 后续步骤
72
91
 
@@ -77,12 +96,12 @@ aigne doc generate
77
96
  根据代码更改或新要求,修改或重新生成文档的特定部分。
78
97
  </x-card>
79
98
  <x-card data-title="翻译文档" data-icon="lucide:languages" data-href="/guides/translating-documentation">
80
- 将您的文档翻译成 12 种支持的语言中的任意一种,例如中文、西班牙语或德语。
99
+ 将您的文档翻译成 12 种支持的语言中的任何一种,例如中文、西班牙语或德语。
81
100
  </x-card>
82
101
  <x-card data-title="发布您的文档" data-icon="lucide:rocket" data-href="/guides/publishing-your-docs">
83
- 将您的文档在线发布,供您的团队或公众使用。
102
+ 将您的文档在线提供给您的团队或公众。
84
103
  </x-card>
85
- <x-card data-title="审查配置" data-icon="lucide:settings" data-href="/configuration/initial-setup">
86
- 审查并修改在初始设置期间创建的 config.yaml 文件,以调整您的偏好。
104
+ <x-card data-title="审阅配置" data-icon="lucide:settings" data-href="/configuration/initial-setup">
105
+ 审阅和修改在初始设置期间创建的 config.yaml 文件以调整您的偏好。
87
106
  </x-card>
88
- </x-cards>
107
+ </x-cards>
@@ -1,49 +1,50 @@
1
1
  # クリーンアップ
2
2
 
3
- `aigne doc clear` コマンドは、生成されたファイル、キャッシュされたデータ、および設定を削除するための簡単な方法を提供します。これは、ドキュメントプロジェクトをリセットしたり、クリーンな状態から始めたり、古いまたは破損したファイルに関連する問題をトラブルシューティングしたりする場合に役立ちます。
3
+ `aigne doc clear` コマンドは、生成されたファイル、キャッシュデータ、設定を削除するための簡単な方法を提供します。これは、ドキュメントプロジェクトをリセットしたり、クリーンな状態から開始したり、古くなったファイルや破損したファイルに関連する問題をトラブルシューティングしたりする場合に役立ちます。
4
4
 
5
5
  ## 対話的なクリーンアップ
6
6
 
7
- このコマンドを使用する最も簡単な方法は、引数なしで実行することです。
7
+ このコマンドを使用する最も簡単な方法は、引数なしで実行することです:
8
8
 
9
9
  ```bash
10
10
  aigne doc clear
11
11
  ```
12
12
 
13
- このコマンドを実行すると対話型プロンプトが起動し、削除したい項目を正確に選択できます。各オプションについて明確な説明が提供され、偶発的なデータ損失を防ぐため、ほとんどのユースケースでこのアプローチが推奨されます。
13
+ このコマンドを実行すると対話型のプロンプトが起動し、削除したい項目を正確に選択できます。各オプションについて明確な説明が提供され、偶発的なデータ損失を防ぐことができるため、ほとんどのユースケースでこのアプローチが推奨されます。
14
14
 
15
15
  ## クリーンアップ対象
16
16
 
17
- `clear` コマンドは、いくつかの異なる種類のデータを削除できます。次の表は、利用可能な各対象、その機能、および影響を受ける特定のファイルまたはディレクトリについて詳しく説明しています。
17
+ `clear` コマンドは、いくつかの異なる種類のデータを削除できます。次の表は、利用可能な各ターゲット、その機能、および影響を受ける特定のファイルやディレクトリについて詳しく説明しています。
18
18
 
19
- | 対象 | 説明 | 影響を受けるファイルとディレクトリ |
19
+ | Target | 説明 | 影響を受けるファイルとディレクトリ |
20
20
  | :--- | :--- | :--- |
21
- | **生成されたドキュメント** | ドキュメント出力ディレクトリに生成されたすべての Markdown ファイルを削除します。 | 設定で `docsDir` によって指定されたディレクトリ。 |
22
- | **ドキュメント構造** | 構造計画ファイルとすべての生成されたドキュメントを削除します。これにより、ドキュメントの内容が効果的にリセットされます。 | `.aigne/doc-smith/output/structure-plan.json` ファイルと `docsDir` ディレクトリ。 |
23
- | **ドキュメント設定** | プロジェクトの設定ファイルを削除します。これを実行した後、プロジェクトを再初期化する必要があります。 | `.aigne/doc-smith/config.yaml` ファイル。 |
24
- | **認証情報** | ドキュメントを公開するために使用される保存済みの認証トークンを削除します。クリアする特定のサイトを選択するように求められます。 | ホームディレクトリにある `~/.aigne/doc-smith-connected.yaml` ファイル。 |
21
+ | `generatedDocs` | 出力ディレクトリ内の生成されたすべてのドキュメントを削除しますが、ドキュメント構造計画は保持します。 | 設定で指定された `docsDir` ディレクトリ。 |
22
+ | `documentStructure` | 生成されたすべてのドキュメントとドキュメント構造計画を削除し、ドキュメントコンテンツを効果的にリセットします。 | `.aigne/doc-smith/output/structure-plan.json` ファイルと `docsDir` ディレクトリ。 |
23
+ | `documentConfig` | プロジェクトの設定ファイルを削除します。この操作の後、再度 `aigne doc init` を実行する必要があります。 | `.aigne/doc-smith/config.yaml` ファイル。 |
24
+ | `authTokens` | 公開サイト用に保存された認証トークンを削除します。どのサイトをクリアするか選択するよう求められます。 | ホームディレクトリにある `~/.aigne/doc-smith-connected.yaml` ファイル。 |
25
+ | `deploymentConfig` | 設定ファイルから `appUrl` を削除します。 | `.aigne/doc-smith/config.yaml` ファイル。 |
25
26
 
26
27
  ## 非対話的なクリーンアップ
27
28
 
28
- 自動化スクリプトやコマンドラインを好むユーザー向けに、`--targets` フラグを使用してクリアする対象を1つ以上直接指定できます。これにより、対話型プロンプトがバイパスされます。
29
+ 自動化スクリプトやコマンドラインを好むユーザーのために、`--targets` フラグを使用してクリアする1つ以上のターゲットを直接指定できます。これにより、対話型のプロンプトがバイパスされます。
29
30
 
30
- ### 単一の対象をクリア
31
+ ### 単一ターゲットのクリア
31
32
 
32
- 生成されたドキュメントのみをクリアするには、次のコマンドを使用します。
33
+ 生成されたドキュメントのみをクリアするには、次のコマンドを使用します:
33
34
 
34
35
  ```bash
35
36
  aigne doc clear --targets generatedDocs
36
37
  ```
37
38
 
38
- ### 複数の対象をクリア
39
+ ### 複数ターゲットのクリア
39
40
 
40
- 複数の対象名を指定して、一度にいくつかの項目をクリアできます。例えば、ドキュメント設定とドキュメント構造の両方を削除するには、次のように実行します。
41
+ 複数のターゲット名を指定して、一度に複数の項目をクリアできます。例えば、ドキュメント設定とドキュメント構造の両方を削除するには、次のように実行します:
41
42
 
42
43
  ```bash
43
44
  aigne doc clear --targets documentConfig documentStructure
44
45
  ```
45
46
 
46
- 設定をクリアした後、セットアッププロセスを再度実行して、新たに始めることができます。
47
+ 設定をクリアした後、再度セットアッププロセスを実行して新たに開始できます。
47
48
 
48
49
  ---
49
50
 
@@ -1,50 +1,52 @@
1
1
  # Cleaning Up
2
2
 
3
- The `aigne doc clear` command provides a straightforward method for removing generated files, cached data, and configuration settings. This is useful when you want to reset your documentation project, start from a clean state, or troubleshoot issues related to outdated or corrupted files.
3
+ The `aigne doc clear` command provides a systematic method for removing generated files, cached data, and configuration settings from your project. This is a practical step when you need to reset the documentation workspace, start from a clean state, or resolve issues that may be caused by outdated files.
4
4
 
5
5
  ## Interactive Cleaning
6
6
 
7
- The simplest way to use the command is to run it without any arguments:
7
+ For controlled and precise cleanup, running the command without any arguments is the recommended procedure.
8
8
 
9
9
  ```bash
10
10
  aigne doc clear
11
11
  ```
12
12
 
13
- Executing this command will launch an interactive prompt, allowing you to select precisely which items you want to remove. This is the recommended approach for most use cases as it provides clear descriptions for each option and prevents accidental data loss.
13
+ This action initiates an interactive prompt, which lists all available cleanup options. Each option is presented with a clear description of what it does, allowing you to select the exact items for removal. This interactive method prevents the accidental deletion of important data.
14
14
 
15
- ## Cleanup Targets
15
+ ## Cleanup Options
16
16
 
17
- The `clear` command can remove several distinct types of data. The following table details each available target, what it does, and the specific files or directories it affects.
17
+ The `clear` command can remove several distinct types of data. The following table provides a detailed breakdown of each available option, its function, and the specific files or directories it affects.
18
18
 
19
- | Target | Description | Files and Directories Affected |
19
+ | Option | Description | Files and Directories Affected |
20
20
  | :--- | :--- | :--- |
21
- | **Generated Documents** | Deletes all Markdown files that were generated in your documentation output directory. | The directory specified by `docsDir` in your configuration. |
22
- | **Documentation Structure** | Deletes the structure plan file and all generated documents. This effectively resets your documentation content. | The `.aigne/doc-smith/output/structure-plan.json` file and the `docsDir` directory. |
23
- | **Document Configuration** | Deletes the project's configuration file. After running this, you will need to re-initialize the project. | The `.aigne/doc-smith/config.yaml` file. |
24
- | **Authorizations** | Removes saved authorization tokens used for publishing your documentation. You will be prompted to select specific sites to clear. | The `~/.aigne/doc-smith-connected.yaml` file in your home directory. |
21
+ | `generatedDocs` | Deletes all generated documents located in the output directory. The documentation structure plan is preserved. | The directory specified by `docsDir` in your configuration. |
22
+ | `documentStructure` | Deletes all generated documents and the documentation structure plan. This action resets all documentation content. | The `.aigne/doc-smith/output/structure-plan.json` file and the `docsDir` directory. |
23
+ | `documentConfig` | Deletes the project's configuration file. After this action, `aigne doc init` must be run to create a new configuration. | The `.aigne/doc-smith/config.yaml` file. |
24
+ | `authTokens` | Removes saved authorization tokens for publishing sites. You will be prompted to select which site authorizations to clear. | The `~/.aigne/doc-smith-connected.yaml` file located in your home directory. |
25
+ | `deploymentConfig` | Removes only the `appUrl` setting from your configuration file, leaving other settings intact. | The `.aigne/doc-smith/config.yaml` file. |
26
+ | `mediaDescription` | Deletes the cached, AI-generated descriptions for your media files. These will be regenerated during the next documentation build. | The `.aigne/doc-smith/cache/media-description.json` file. |
25
27
 
26
28
  ## Non-Interactive Cleaning
27
29
 
28
- For automated scripts or users who prefer the command line, you can specify one or more targets to clear directly using the `--targets` flag. This will bypass the interactive prompt.
30
+ For use in automated scripts or for users who prefer direct command-line operations, you can specify one or more cleanup targets using the `--targets` flag. This bypasses the interactive prompt and executes the cleanup immediately.
29
31
 
30
- ### Clear a Single Target
32
+ ### Clear a Single Option
31
33
 
32
- To clear only the generated documents, use the following command:
34
+ To remove only the generated documents, execute the following command:
33
35
 
34
36
  ```bash
35
37
  aigne doc clear --targets generatedDocs
36
38
  ```
37
39
 
38
- ### Clear Multiple Targets
40
+ ### Clear Multiple Options
39
41
 
40
- You can provide multiple target names to clear several items at once. For example, to remove both the document configuration and the documentation structure, run:
42
+ You can provide a space-separated list of target names to remove several items at once. For instance, to delete both the document configuration and the documentation structure, run the command below:
41
43
 
42
44
  ```bash
43
45
  aigne doc clear --targets documentConfig documentStructure
44
46
  ```
45
47
 
46
- After clearing your configuration, you can start fresh by running the setup process again.
48
+ After clearing the configuration, you can begin a new setup process.
47
49
 
48
50
  ---
49
51
 
50
- For more information on the initial setup, refer to the [Initial Setup](./configuration-initial-setup.md) guide.
52
+ For detailed instructions on creating a new configuration, please refer to the [Initial Setup](./configuration-initial-setup.md) guide.
@@ -1,49 +1,50 @@
1
1
  # 清理
2
2
 
3
- `aigne doc clear` 指令提供了一種直接的方法,用於移除生成的檔案、快取資料和配置設定。當您想重設文件專案、從乾淨的狀態開始,或解決與過時或損壞檔案相關的問題時,此功能非常有用。
3
+ `aigne doc clear` 指令提供了一個直接的方法來移除生成的檔案、快取資料和配置設定。當您想要重設您的文件專案、從乾淨的狀態開始,或解決與過時或損壞檔案相關的問題時,這個指令非常有用。
4
4
 
5
5
  ## 互動式清理
6
6
 
7
- 使用此指令最簡單的方法就是不帶任何參數直接執行:
7
+ 使用此指令最簡單的方法是不帶任何參數直接執行:
8
8
 
9
9
  ```bash
10
10
  aigne doc clear
11
11
  ```
12
12
 
13
- 執行此指令將會啟動一個互動式提示,讓您能精確選擇要移除的項目。對於大多數使用情境而言,這是建議的方法,因為它為每個選項提供了清晰的說明,並能防止意外的資料遺失。
13
+ 執行此指令將啟動一個互動式提示,讓您精確選擇要移除的項目。這是大多數使用情境下的建議方法,因為它為每個選項提供了清晰的說明,並能防止意外的資料遺失。
14
14
 
15
15
  ## 清理目標
16
16
 
17
- `clear` 指令可以移除幾種不同類型的資料。下表詳細說明了每個可用的目標、其功能,以及它所影響的特定檔案或目錄。
17
+ `clear` 指令可以移除幾種不同類型的資料。下表詳細說明了每個可用的目標、其功能以及它所影響的特定檔案或目錄。
18
18
 
19
- | 目標 | 說明 | 受影響的檔案和目錄 |
19
+ | Target | 說明 | 受影響的檔案與目錄 |
20
20
  | :--- | :--- | :--- |
21
- | **生成的檔案** | 刪除在您的文件輸出目錄中生成的所有 Markdown 檔案。 | 您的配置中由 `docsDir` 指定的目錄。 |
22
- | **文件結構** | 刪除結構計畫檔案和所有生成的檔案。這能有效地重設您的文件內容。 | `.aigne/doc-smith/output/structure-plan.json` 檔案和 `docsDir` 目錄。 |
23
- | **文件配置** | 刪除專案的設定檔。執行此操作後,您將需要重新初始化專案。 | `.aigne/doc-smith/config.yaml` 檔案。 |
24
- | **授權** | 移除用於發布文件的已儲存授權權杖。系統將提示您選擇要清除授權的特定網站。 | 您家目錄中的 `~/.aigne/doc-smith-connected.yaml` 檔案。 |
21
+ | `generatedDocs` | 刪除您輸出目錄中所有已生成的檔案,但保留文件結構計畫。 | 您設定中 `docsDir` 所指定的目錄。 |
22
+ | `documentStructure` | 刪除所有已生成的檔案和文件結構計畫,有效地重設您的文件內容。 | `.aigne/doc-smith/output/structure-plan.json` 檔案和 `docsDir` 目錄。 |
23
+ | `documentConfig` | 刪除專案的設定檔。此操作後,您將需要重新執行 `aigne doc init`。 | `.aigne/doc-smith/config.yaml` 檔案。 |
24
+ | `authTokens` | 移除已儲存的發布網站授權權杖。系統將提示您選擇要清除哪些網站。 | 您家目錄中的 `~/.aigne/doc-smith-connected.yaml` 檔案。 |
25
+ | `deploymentConfig` | 從您的設定檔中刪除 `appUrl`。 | `.aigne/doc-smith/config.yaml` 檔案。 |
25
26
 
26
27
  ## 非互動式清理
27
28
 
28
- 對於自動化腳本或偏好使用命令列的使用者,您可以使用 `--targets` 旗標直接指定一個或多個要清理的目標。這將會繞過互動式提示。
29
+ 對於自動化腳本或偏好使用命令列的使用者,您可以使用 `--targets` 旗標直接指定一個或多個要清除的目標。這將繞過互動式提示。
29
30
 
30
- ### 清理單一目標
31
+ ### 清除單一目標
31
32
 
32
- 若要僅清理生成的檔案,請使用以下指令:
33
+ 若要僅清除已生成的檔案,請使用以下指令:
33
34
 
34
35
  ```bash
35
36
  aigne doc clear --targets generatedDocs
36
37
  ```
37
38
 
38
- ### 清理多個目標
39
+ ### 清除多個目標
39
40
 
40
- 您可以提供多個目標名稱來一次性清理多個項目。例如,若要同時移除文件配置和文件結構,請執行:
41
+ 您可以提供多個目標名稱來一次清除多個項目。例如,若要同時移除文件設定和文件結構,請執行:
41
42
 
42
43
  ```bash
43
44
  aigne doc clear --targets documentConfig documentStructure
44
45
  ```
45
46
 
46
- 清理完配置後,您可以再次執行設定流程以重新開始。
47
+ 清除您的設定後,您可以再次執行設定流程以重新開始。
47
48
 
48
49
  ---
49
50
 
@@ -1,6 +1,6 @@
1
1
  # 清理
2
2
 
3
- `aigne doc clear` 命令提供了一种直接的方法,用于移除生成的文件、缓存数据和配置设置。当您想要重置文档项目、从一个干净的状态开始,或者排查与过时或损坏文件相关的问题时,这个命令非常有用。
3
+ `aigne doc clear` 命令提供了一种简单直接的方法来移除生成的文件、缓存数据和配置设置。当您想要重置文档项目、从干净的状态开始或排查与过时或损坏文件相关的问题时,这个命令非常有用。
4
4
 
5
5
  ## 交互式清理
6
6
 
@@ -10,22 +10,23 @@
10
10
  aigne doc clear
11
11
  ```
12
12
 
13
- 执行此命令将启动一个交互式提示,让您精确选择要移除的项目。这是大多数用例的推荐方法,因为它为每个选项提供了清晰的描述,并能防止意外的数据丢失。
13
+ 执行此命令将启动一个交互式提示,让您能够精确选择要移除的项目。这是大多数用例的推荐方法,因为它为每个选项提供了清晰的描述,并能防止意外的数据丢失。
14
14
 
15
15
  ## 清理目标
16
16
 
17
- `clear` 命令可以移除几种不同类型的数据。下表详细介绍了每个可用目标、其功能以及它影响的具体文件或目录。
17
+ `clear` 命令可以移除几种不同类型的数据。下表详细说明了每个可用的目标、其功能以及所影响的具体文件或目录。
18
18
 
19
- | 目标 | 描述 | 受影响的文件和目录 |
19
+ | Target | Description | Files and Directories Affected |
20
20
  | :--- | :--- | :--- |
21
- | **生成的文档** | 删除在您的文档输出目录中生成的所有 Markdown 文件。 | 您的配置中由 `docsDir` 指定的目录。 |
22
- | **文档结构** | 删除结构计划文件和所有生成的文档。这将有效地重置您的文档内容。 | `.aigne/doc-smith/output/structure-plan.json` 文件和 `docsDir` 目录。 |
23
- | **文档配置** | 删除项目的配置文件。运行此操作后,您需要重新初始化项目。 | `.aigne/doc-smith/config.yaml` 文件。 |
24
- | **授权** | 移除用于发布文档的已保存授权令牌。系统将提示您选择要清除授权的特定站点。 | 您主目录下的 `~/.aigne/doc-smith-connected.yaml` 文件。 |
21
+ | `generatedDocs` | 删除输出目录中所有生成的文档,但保留文档结构计划。 | 您配置中由 `docsDir` 指定的目录。 |
22
+ | `documentStructure` | 删除所有生成的文档和文档结构计划,从而有效重置您的文档内容。 | `.aigne/doc-smith/output/structure-plan.json` 文件和 `docsDir` 目录。 |
23
+ | `documentConfig` | 删除项目的配置文件。执行此操作后,您需要重新运行 `aigne doc init`。 | `.aigne/doc-smith/config.yaml` 文件。 |
24
+ | `authTokens` | 移除已保存的用于发布站点的授权令牌。系统将提示您选择要清除哪些站点。 | 您主目录下的 `~/.aigne/doc-smith-connected.yaml` 文件。 |
25
+ | `deploymentConfig` | 从您的配置文件中删除 `appUrl`。 | `.aigne/doc-smith/config.yaml` 文件。 |
25
26
 
26
27
  ## 非交互式清理
27
28
 
28
- 对于自动化脚本或偏好命令行的用户,您可以使用 `--targets` 标志直接指定一个或多个要清理的目标。这将绕过交互式提示。
29
+ 对于自动化脚本或偏好使用命令行的用户,您可以使用 `--targets` 标志直接指定一个或多个要清理的目标。这将绕过交互式提示。
29
30
 
30
31
  ### 清理单个目标
31
32
 
@@ -43,8 +44,8 @@ aigne doc clear --targets generatedDocs
43
44
  aigne doc clear --targets documentConfig documentStructure
44
45
  ```
45
46
 
46
- 清理配置后,您可以再次运行设置过程以重新开始。
47
+ 清理配置后,您可以通过再次运行设置过程来重新开始。
47
48
 
48
49
  ---
49
50
 
50
- 有关初始设置的更多信息,请参阅[初始设置](./configuration-initial-setup.md)指南。
51
+ 有关初始设置的更多信息,请参阅 [初始设置](./configuration-initial-setup.md) 指南。