@aigne/doc-smith 0.8.11-beta.6 → 0.8.11

package/docs/cli-reference.zh-TW.md

@@ -1,27 +1,27 @@
-# CLI 命令參考
+# CLI 指令參考
 
-本指南為所有可用的 `aigne doc` 子命令、其參數和選項提供了全面的參考。它旨在幫助使用者充分利用命令列介面的全部潛力。
+本指南為所有可用的 `aigne doc` 子指令、其參數和選項提供了全面的參考。它旨在幫助希望充分利用命令列介面的使用者。
 
-一般語法為：
+一般語法是：
 
-```bash command
+```bash command icon=lucide:terminal
 aigne doc <command> [options]
 ```
 
-### 命令工作流程
+### 指令工作流程
 
-下圖說明了使用 DocSmith 的 CLI 命令建立和維護文件的一般生命週期，以及它們互動的資料。
+下圖說明了使用 DocSmith 的 CLI 指令建立和維護文件的典型生命週期，以及它們所互動的資料。
 
 ```d2
 direction: down
 
-# Artifacts
+# 產物
 Source-Code: {
   label: "原始碼"
   shape: cylinder
 }
 Configuration: {
-  label: "設定\n(.aigne/doc-smith/config.yml)"
+  label: "設定檔\n(.aigne/doc-smith/config.yml)"
   shape: cylinder
 }
 Generated-Docs: {
@@ -29,11 +29,11 @@ Generated-Docs: {
   shape: cylinder
 }
 Published-Docs: {
-  label: "已發佈的網站"
+  label: "發佈的網站"
   shape: cylinder
 }
 
-# --- Core Workflow ---
+# --- 核心工作流程 ---
 Lifecycle: {
   label: "文件生命週期"
   
@@ -67,13 +67,13 @@ Lifecycle: {
   }
 }
 
-# --- Utility Commands ---
+# --- 工具指令 ---
 Utilities: {
-  label: "工具命令"
+  label: "工具指令"
   grid-columns: 2
   
   prefs: {
-    label: "檢視設定\n`aigne doc prefs`"
+    label: "管理偏好設定\n`aigne doc prefs`"
     shape: rectangle
   }
   clear: {
@@ -83,26 +83,26 @@ Utilities: {
 }
 
 
-# --- Connections ---
+# --- 連線 ---
 
-# Setup and Generation
+# 設定與產生
 Lifecycle.init -> Configuration: "建立"
 Source-Code -> Lifecycle.generate: "讀取"
 Configuration -> Lifecycle.generate: "讀取"
 Lifecycle.generate -> Generated-Docs: "建立 / 覆寫"
 Lifecycle.generate -> Lifecycle.init: {
-  label: "若無設定則執行"
+  label: "若無設定檔則執行"
   style.stroke-dash: 4
 }
 
-# Refinement Loop
+# 優化迴圈
 Generated-Docs <-> Lifecycle.Refinement: "讀取與寫入"
 
-# Publishing
+# 發佈
 Lifecycle.Refinement -> Lifecycle.publish
 Lifecycle.publish -> Published-Docs: "上傳至"
 
-# Utility Connections
+# 工具連線
 Utilities.prefs -> Configuration: "讀取"
 Utilities.clear -> Configuration: "刪除"
 Utilities.clear -> Generated-Docs: "刪除"
@@ -121,6 +121,7 @@ Utilities.clear -> Generated-Docs: "刪除"
 ```bash
 aigne doc init
 ```
+![互動式設定精靈完成畫面的螢幕截圖。](../assets/screenshots/doc-complete-setup.png)
 
 有關如何根據您的需求客製化 DocSmith 的更多詳細資訊，請參閱 [設定指南](./configuration.md)。
 
@@ -128,15 +129,17 @@ aigne doc init
 
 ## `aigne doc generate`
 
-分析您的原始碼並根據您的設定產生一套完整的文件。如果找不到設定，它會自動啟動互動式設定精靈 (`aigne doc init`)。
+分析您的原始碼，並根據您的設定產生一套完整的文件。如果找不到設定檔，它會自動啟動互動式設定精靈 (`aigne doc init`)。
+
+![generate 指令執行畫面的螢幕截圖。](../assets/screenshots/doc-generate.png)
 
 ### 選項
 
-| Option              | Type    | Description                                                                                                   |
-| ------------------- | ------- | ------------------------------------------------------------------------------------------------------------- |
-| `--forceRegenerate` | boolean | 捨棄現有內容並從頭開始重新產生所有文件。                                     |
-| `--feedback`        | string  | 提供回饋以調整和優化整體文件結構。                                   |
-| `--model`           | string  | 指定用於產生的特定大型語言模型（例如 `anthropic:claude-3-5-sonnet`）。此選項會覆寫預設設定。 |
+| 選項 | 類型 | 說明 |
+| :------------------ | :------ | :------------------------------------------------------------------------------------------------------- |
+| `--forceRegenerate` | boolean | 捨棄現有內容，從頭開始重新產生所有文件。 |
+| `--feedback` | string | 提供回饋以調整和優化整體文件結構。 |
+| `--model` | string | 指定用於產生的特定大型語言模型 (例如：`openai:gpt-4o`)。這會覆寫預設值。 |
 
 ### 使用範例
 
@@ -168,18 +171,20 @@ aigne doc generate --model openai:gpt-4o
 
 ## `aigne doc update`
 
-優化並重新產生特定文件。您可以以互動方式執行以選擇文件，或直接使用選項指定它們。這對於根據回饋進行有針對性的改進，而無需重新產生整個專案，非常有用。
+優化並重新產生特定文件。您可以以互動方式執行以選擇文件，或直接使用選項指定它們。這對於根據回饋進行針對性改進，而無需重新產生整個專案很有用。
+
+![update 指令執行畫面的螢幕截圖。](../assets/screenshots/doc-update.png)
 
 ### 選項
 
-| Option     | Type  | Description                                                                                 |
-| ---------- | ----- | ------------------------------------------------------------------------------------------- |
-| `--docs`     | array | 要重新產生的文件路徑列表。可多次指定。                         |
-| `--feedback` | string | 提供具體回饋以改善所選文件的內容。              |
+| 選項 | 類型 | 說明 |
+| :--------- | :---- | :-------------------------------------------------------------------------- |
+| `--docs` | array | 要重新產生的文件路徑列表。可多次指定。 |
+| `--feedback` | string | 提供具體回饋以改善所選文件的內容。 |
 
 ### 使用範例
 
-**啟動互動式會話以選擇要更新的文件：**
+**啟動互動式工作階段以選擇要更新的文件：**
 
 ```bash
 aigne doc update
@@ -188,27 +193,29 @@ aigne doc update
 **使用針對性回饋更新特定文件：**
 
 ```bash
-aigne doc update --docs /overview.md --feedback "Add more detailed FAQ entries"
+aigne doc update --docs /overview --feedback "Add more detailed FAQ entries"
 ```
 
 ---
 
 ## `aigne doc translate`
 
-將現有文件翻譯成一種或多種語言。它可以以互動方式執行以選擇文件和語言，也可以透過將它們指定為參數以非互動方式執行。
+將現有文件翻譯成一種或多種語言。可以以互動方式執行以選擇文件和語言，或透過將它們指定為參數以非互動方式執行。
+
+![translate 指令執行畫面的螢幕截圖。](../assets/screenshots/doc-translate.png)
 
 ### 選項
 
-| Option       | Type  | Description                                                                                                |
-| ------------ | ----- | ---------------------------------------------------------------------------------------------------------- |
-| `--docs`       | array | 要翻譯的文件路徑列表。可多次指定。                                         |
-| `--langs`      | array | 目標語言代碼列表（例如 `zh-CN`、`ja`）。可多次指定。                            |
-| `--feedback`   | string | 提供回饋以改善翻譯品質。                                               |
-| `--glossary`   | string | 詞彙表檔案的路徑，以確保跨語言的術語一致性。使用 `@path/to/glossary.md`。 |
+| 選項 | 類型 | 說明 |
+| :--------- | :---- | :----------------------------------------------------------------------------------- |
+| `--docs` | array | 要翻譯的文件路徑列表。可多次指定。 |
+| `--langs` | array | 目標語言代碼列表 (例如：`zh-CN`、`ja`)。可多次指定。 |
+| `--feedback` | string | 提供回饋以改善翻譯品質。 |
+| `--glossary` | string | 詞彙表檔案的路徑，以確保跨語言的術語一致性。使用 `@path/to/glossary.md`。 |
 
 ### 使用範例
 
-**啟動互動式翻譯會話：**
+**啟動互動式翻譯工作階段：**
 
 ```bash
 aigne doc translate
@@ -217,7 +224,7 @@ aigne doc translate
 **將特定文件翻譯成中文和日文：**
 
 ```bash
-aigne doc translate --langs zh-CN --langs ja --docs /features/generate-documentation.md --docs /overview.md
+aigne doc translate --langs zh-CN --langs ja --docs /features/generate-documentation --docs /overview
 ```
 
 **使用詞彙表和回饋進行翻譯以提高品質：**
@@ -230,23 +237,25 @@ aigne doc translate --glossary @glossary.md --feedback "Use technical terminolog
 
 ## `aigne doc publish`
 
-發佈您的文件並產生一個可分享的連結。此命令會將您的內容上傳到一個 Discuss Kit 實例。您可以使用官方的 AIGNE DocSmith 平台或執行您自己的 [Discuss Kit](https://www.web3kit.rocks/discuss-kit) 實例。
+發佈您的文件並產生一個可分享的連結。此指令會將您的內容上傳到一個 Discuss Kit 執行個體。您可以使用官方的 AIGNE DocSmith 平台，或執行您自己的 [Discuss Kit](https://www.web3kit.rocks/discuss-kit) 執行個體。
+
+![publish 指令執行畫面的螢幕截圖。](../assets/screenshots/doc-publish.png)
 
 ### 選項
 
-| Option     | Type   | Description                                                                                          |
-| ---------- | ------ | ---------------------------------------------------------------------------------------------------- |
-| `--appUrl` | string | 您自行託管的 Discuss Kit 實例的 URL。若未提供，此命令將以互動模式執行。 |
+| 選項 | 類型 | 說明 |
+| :------- | :----- | :------------------------------------------------------------------------------------------------------ |
+| `--appUrl` | string | 您自行託管的 Discuss Kit 執行個體的 URL。如果未提供，指令將以互動方式執行。 |
 
 ### 使用範例
 
-**啟動互動式發佈會話：**
+**啟動互動式發佈工作階段：**
 
 ```bash
 aigne doc publish
 ```
 
-**直接發佈至自行託管的實例：**
+**直接發佈到自行託管的執行個體：**
 
 ```bash
 aigne doc publish --appUrl https://your-discuss-kit-instance.com
@@ -256,25 +265,46 @@ aigne doc publish --appUrl https://your-discuss-kit-instance.com
 
 ## `aigne doc prefs`
 
-顯示專案目前的設定。這是一個唯讀命令，可幫助您驗證在 `init` 或 `generate` 過程中應用的設定。
+管理使用者偏好設定和由回饋驅動的規則。隨著時間的推移，DocSmith 會從您的回饋中學習並建立持續性的偏好設定。此指令允許您查看、切換或移除這些學習到的規則。
+
+### 選項
+
+| 選項 | 類型 | 說明 |
+| :------- | :------ | :------------------------------------------------------------------------- |
+| `--list` | boolean | 列出所有已儲存的偏好設定。 |
+| `--remove` | boolean | 以互動方式提示選擇並移除一個或多個偏好設定。 |
+| `--toggle` | boolean | 以互動方式提示選擇並切換偏好設定的啟用狀態。 |
+| `--id` | array | 直接指定一個或多個要移除或切換的偏好設定 ID。 |
 
 ### 使用範例
 
-**檢視目前專案設定：**
+**列出所有已儲存的偏好設定：**
+
+```bash
+aigne doc prefs --list
+```
+
+**啟動互動式移除模式：**
+
+```bash
+aigne doc prefs --remove
+```
+
+**透過 ID 切換特定偏好設定：**
 
 ```bash
-aigne doc prefs
+aigne doc prefs --toggle --id "pref_2a1dfe2b09695aab"
 ```
 
 ---
 
 ## `aigne doc clear`
 
-啟動一個互動式會話以清除本地儲存的資料。這可用於移除產生的文件、文件結構設定或快取的驗證權杖。
+啟動一個互動式工作階段以清除本機儲存的資料。這可用於移除產生的文件、文件結構設定或快取的驗證權杖。
 
 ### 使用範例
 
-**啟動互動式清理程序：**
+**啟動互動式清理過程：**
 
 ```bash
 aigne doc clear

package/docs/cli-reference.zh.md

@@ -1,10 +1,10 @@
 # CLI 命令参考
 
-本指南为所有可用的 `aigne doc` 子命令及其参数和选项提供了全面的参考。它旨在帮助用户充分利用命令行界面。
+本指南为所有可用的 `aigne doc` 子命令及其参数和选项提供了全面的参考。它旨在帮助希望充分利用命令行的用户。
 
 通用语法为：
 
-```bash command
+```bash command icon=lucide:terminal
 aigne doc <command> [options]
 ```
 
@@ -67,13 +67,13 @@ Lifecycle: {
   }
 }
 
-# --- 实用命令 ---
+# --- 实用工具命令 ---
 Utilities: {
-  label: "实用命令"
+  label: "实用工具命令"
   grid-columns: 2
   
   prefs: {
-    label: "查看配置\n`aigne doc prefs`"
+    label: "管理偏好\n`aigne doc prefs`"
     shape: rectangle
   }
   clear: {
@@ -89,9 +89,9 @@ Utilities: {
 Lifecycle.init -> Configuration: "创建"
 Source-Code -> Lifecycle.generate: "读取"
 Configuration -> Lifecycle.generate: "读取"
-Lifecycle.generate -> Generated-Docs: "创建/覆盖"
+Lifecycle.generate -> Generated-Docs: "创建 / 覆盖"
 Lifecycle.generate -> Lifecycle.init: {
-  label: "无配置时运行"
+  label: "若无配置则运行"
   style.stroke-dash: 4
 }
 
@@ -114,13 +114,14 @@ Utilities.clear -> Generated-Docs: "删除"
 
 手动启动交互式配置向导。这对于设置新项目或修改现有项目的配置非常有用。该向导会引导您定义源代码路径、设置输出目录、选择语言以及定义文档的风格和目标受众。
 
-### 用法示例
+### 使用示例
 
 **启动设置向导：**
 
 ```bash
 aigne doc init
 ```
+![交互式设置向导完成截图。](../assets/screenshots/doc-complete-setup.png)
 
 有关如何根据您的需求定制 DocSmith 的更多详细信息，请参阅[配置指南](./configuration.md)。
 
@@ -128,17 +129,19 @@ aigne doc init
 
 ## `aigne doc generate`
 
-分析您的源代码并根据您的配置生成一套完整的文档。如果未找到配置，它将自动启动交互式设置向导 (`aigne doc init`)。
+分析您的源代码并根据您的配置生成一套完整的文档。如果未找到配置，它将自动启动交互式设置向导（`aigne doc init`）。
+
+![generate 命令运行截图。](../assets/screenshots/doc-generate.png)
 
 ### 选项
 
-| 选项 | 类型 | 描述 |
-| ------------------- | ------- | ------------------------------------------------------------------------------------------------------------- |
-| `--forceRegenerate` | boolean | 丢弃现有内容并从头开始重新生成所有文档。 |
-| `--feedback` | string | 提供反馈以调整和优化整体文档结构。 |
-| `--model` | string | 指定用于生成的特定大语言模型（例如 `anthropic:claude-3-5-sonnet`）。此选项会覆盖默认设置。 |
+| Option              | Type    | Description                                                                                              |
+| :------------------ | :------ | :------------------------------------------------------------------------------------------------------- |
+| `--forceRegenerate` | boolean | 丢弃现有内容并从头开始重新生成所有文档。                                |
+| `--feedback`        | string  | 提供反馈以调整和优化整体文档结构。                              |
+| `--model`           | string  | 指定用于生成的特定大语言模型（例如，`openai:gpt-4o`）。此选项将覆盖默认设置。 |
 
-### 用法示例
+### 使用示例
 
 **生成或更新文档：**
 
@@ -170,14 +173,16 @@ aigne doc generate --model openai:gpt-4o
 
 优化并重新生成特定文档。您可以以交互方式运行它来选择文档，或直接使用选项指定文档。这对于根据反馈进行有针对性的改进非常有用，而无需重新生成整个项目。
 
+![update 命令运行截图。](../assets/screenshots/doc-update.png)
+
 ### 选项
 
-| 选项 | 类型 | 描述 |
-| ---------- | ----- | ------------------------------------------------------------------------------------------- |
-| `--docs` | array | 要重新生成的文档路径列表。可以多次指定。 |
-| `--feedback` | string | 提供具体反馈以改进所选文档的内容。 |
+| Option     | Type  | Description                                                                 |
+| :--------- | :---- | :-------------------------------------------------------------------------- |
+| `--docs`     | array | 要重新生成的文档路径列表。可多次指定。    |
+| `--feedback` | string  | 提供具体反馈以改进所选文档的内容。 |
 
-### 用法示例
+### 使用示例
 
 **启动交互式会话以选择要更新的文档：**
 
@@ -188,25 +193,27 @@ aigne doc update
 **使用有针对性的反馈更新特定文档：**
 
 ```bash
-aigne doc update --docs /overview.md --feedback "Add more detailed FAQ entries"
+aigne doc update --docs /overview --feedback "Add more detailed FAQ entries"
 ```
 
 ---
 
 ## `aigne doc translate`
 
-将现有文档翻译成一种或多种语言。可以以交互方式运行它来选择文档和语言，也可以通过将它们指定为参数以非交互方式运行。
+将现有文档翻译成一种或多种语言。可以以交互方式运行它来选择文档和语言，也可以通过指定参数以非交互方式运行。
+
+![translate 命令运行截图。](../assets/screenshots/doc-translate.png)
 
 ### 选项
 
-| 选项 | 类型 | 描述 |
-| ------------ | ----- | ---------------------------------------------------------------------------------------------------------- |
-| `--docs` | array | 要翻译的文档路径列表。可以多次指定。 |
-| `--langs` | array | 目标语言代码列表（例如 `zh-CN`、`ja`）。可以多次指定。 |
-| `--feedback` | string | 提供反馈以提高翻译质量。 |
-| `--glossary` | string | 词汇表文件的路径，以确保跨语言术语的一致性。使用 `@path/to/glossary.md`。 |
+| Option     | Type  | Description                                                                          |
+| :--------- | :---- | :----------------------------------------------------------------------------------- |
+| `--docs`     | array | 要翻译的文档路径列表。可多次指定。              |
+| `--langs`    | array | 目标语言代码列表（例如，`zh-CN`、`ja`）。可多次指定。 |
+| `--feedback` | string  | 提供反馈以提高翻译质量。                       |
+| `--glossary` | string  | 词汇表文件的路径，以确保跨语言的术语一致性。使用 `@path/to/glossary.md`。 |
 
-### 用法示例
+### 使用示例
 
 **启动交互式翻译会话：**
 
@@ -217,7 +224,7 @@ aigne doc translate
 **将特定文档翻译成中文和日文：**
 
 ```bash
-aigne doc translate --langs zh-CN --langs ja --docs /features/generate-documentation.md --docs /overview.md
+aigne doc translate --langs zh-CN --langs ja --docs /features/generate-documentation --docs /overview
 ```
 
 **使用词汇表和反馈进行翻译以提高质量：**
@@ -232,13 +239,15 @@ aigne doc translate --glossary @glossary.md --feedback "Use technical terminolog
 
 发布您的文档并生成一个可共享的链接。此命令会将您的内容上传到 Discuss Kit 实例。您可以使用官方的 AIGNE DocSmith 平台，也可以运行您自己的 [Discuss Kit](https://www.web3kit.rocks/discuss-kit) 实例。
 
+![publish 命令运行截图。](../assets/screenshots/doc-publish.png)
+
 ### 选项
 
-| 选项 | 类型 | 描述 |
-| ---------- | ------ | ---------------------------------------------------------------------------------------------------- |
-| `--appUrl` | string | 您自托管的 Discuss Kit 实例的 URL。如果未提供，该命令将以交互方式运行。 |
+| Option   | Type   | Description                                                                                             |
+| :------- | :----- | :------------------------------------------------------------------------------------------------------ |
+| `--appUrl` | string | 您的自托管 Discuss Kit 实例的 URL。如果未提供，该命令将以交互模式运行。 |
 
-### 用法示例
+### 使用示例
 
 **启动交互式发布会话：**
 
@@ -256,23 +265,44 @@ aigne doc publish --appUrl https://your-discuss-kit-instance.com
 
 ## `aigne doc prefs`
 
-显示项目的当前配置设置。这是一个只读命令，可帮助您验证在 `init` 或 `generate` 过程中应用的设置。
+管理用户偏好和由反馈驱动的规则。随着时间的推移，DocSmith 会从您的反馈中学习并创建持久的偏好设置。此命令允许您查看、切换或移除这些学习到的规则。
+
+### 选项
+
+| Option   | Type    | Description                                                                |
+| :------- | :------ | :------------------------------------------------------------------------- |
+| `--list`   | boolean | 列出所有已保存的偏好设置。                                               |
+| `--remove` | boolean | 以交互方式提示选择并移除一个或多个偏好设置。        |
+| `--toggle` | boolean | 以交互方式提示选择并切换偏好设置的激活状态。 |
+| `--id`     | array   | 指定一个或多个偏好 ID 以直接移除或切换。         |
+
+### 使用示例
 
-### 用法示例
+**列出所有已保存的偏好设置：**
+
+```bash
+aigne doc prefs --list
+```
+
+**启动交互式移除模式：**
+
+```bash
+aigne doc prefs --remove
+```
 
-**查看当前项目配置：**
+**按 ID 切换特定偏好设置：**
 
 ```bash
-aigne doc prefs
+aigne doc prefs --toggle --id "pref_2a1dfe2b09695aab"
 ```
 
 ---
 
 ## `aigne doc clear`
 
-启动一个交互式会话以清除本地存储的数据。这可用于删除生成的文档、文档结构配置或缓存的身份验证令牌。
+启动一个交互式会话以清除本地存储的数据。此命令可用于移除生成的文档、文档结构配置或缓存的身份验证令牌。
 
-### 用法示例
+### 使用示例
 
 **启动交互式清理过程：**