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

package/docs/guides-updating-documentation.zh.md

@@ -1,76 +1,76 @@
 # 更新文档
 
-维护文档的准确性和相关性是一个持续的过程。随着代码库的演进或收到新的反馈，你需要修改现有文档。`update` 命令提供了一种结构化的方式，用新的指令重新生成特定文档，确保其内容保持最新。
+维护文档的准确性和相关性是一个持续的过程。随着代码库的演进或收到新的反馈，您将需要修改现有文档。`update` 命令提供了一种结构化的方式，可以用新的指令重新生成特定文档，确保其保持最新。
 
-本指南将介绍更新文档的两种主要方法：用于单个文档详细优化的交互模式，以及用于一次性将变更应用于多个文档的批量模式。
+本指南将解释更新文档的两种主要方法：用于对单个文档进行详细优化的交互模式，以及用于一次性将变更应用于多个文档的批处理模式。
 
 ## 两种操作模式
 
-`update` 命令根据你选择的文档数量和你提供的选项，在两种模式之一中运行。
+`update` 命令根据您选择的文档数量和提供的选项，在两种模式之一中运行。
 
-1.  **交互模式**：当你在不使用 `--reset` 标志的情况下更新单个文档时触发。此模式专为迭代优化而设计，允许你提供反馈、审查变更，并重复此过程，直到文档符合你的标准。
-2.  **批量模式**：当你同时更新多个文档或使用 `--reset` 标志时使用。此模式在单次操作中将你的反馈应用于所有选定的文档，对于大范围的变更而言非常高效。
+1.  **交互模式**：当您更新单个文档且未使用 `--reset` 标志时触发。此模式专为迭代优化而设计，允许您提供反馈、审查变更并重复此过程，直到文档符合您的标准。
+2.  **批处理模式**：当您同时更新多个文档或使用 `--reset` 标志时使用。此模式会在单次操作中将您的反馈应用于所有选定的文档，对于大范围的变更非常高效。
 
 ## 交互模式：优化单个文档
 
-交互模式为对单个文档进行精确变更提供了一个受控的环境。当你需要根据特定反馈仔细审查和调整内容时，这是理想的选择。
+交互模式提供了一个受控的环境，可以对单个文档进行精确的更改。当您需要根据特定反馈仔细审查和调整内容时，这是理想的选择。
 
-要启动交互式会话，请运行 `aigne doc update` 命令并从列表中选择单个文档。
+要启动交互会话，请运行 `aigne doc update` 命令并从列表中选择单个文档。
 
 ```bash
 aigne doc update
 ```
 
-该工具将引导你完成以下步骤：
+该工具将引导您完成以下步骤：
 
 1.  **文档分析**：系统首先会显示所选文档的结构大纲，展示其主要标题。
-2.  **用户操作**：然后系统会提示你选择以下三个操作之一：
-    *   **查看文档**：显示当前版本文档的全部内容，并在你的终端中渲染以便于阅读。
-    *   **提供反馈**：提示你输入修改请求。这可以是任何内容，从“添加一个关于错误处理的部分”到“阐明 `config` 对象的用途”。
-    *   **完成**：退出交互式会话并保存最后生成的文档版本。
-3.  **内容重新生成**：在你提交反馈后，AI 会根据你的指令重新生成文档内容。然后会显示新的标题结构。
-4.  **迭代或完成**：你可以继续这个查看、提供反馈和重新生成的循环，直到你对结果满意为止。一旦选择“完成”，该过程即告结束。
+2.  **用户操作**：然后系统会提示您选择以下三种操作之一：
+    *   **查看文档**：显示当前版本文档的全部内容，并在您的终端中渲染以便于阅读。
+    *   **提供反馈**：提示您输入修改请求。这可以是任何内容，从“添加一个关于错误处理的部分”到“阐明 `config` 对象的用途”。
+    *   **完成**：退出交互会话并保存最后生成的文档版本。
+3.  **内容重新生成**：在您提交反馈后，AI 会根据您的指令重新生成文档内容。然后会显示新的标题结构。
+4.  **迭代或完成**：您可以继续这个查看、提供反馈和重新生成的循环，直到您对结果满意为止。一旦选择“完成”，该过程即告结束。
 
-这个迭代周期可以让你对最终输出进行精细控制，确保更新后的文档准确而完整。
+这种迭代循环可以对最终输出进行微调控制，确保更新后的文档准确而完整。
 
-## 批量模式：更新多个文档
+## 批处理模式：更新多个文档
 
-当你需要将相同的通用反馈应用于多个文档或完全重新生成它们时，批量模式旨在提高效率。如果你选择多个文档或使用如 `--docs` 或 `--reset` 之类的命令行标志，此模式会自动激活。
+批处理模式专为提高效率而设计，适用于需要将相同的通用反馈应用于多个文档或完全重新生成它们的情况。如果您选择多个文档或使用 `--docs` 或 `--reset` 等命令行标志，此模式将自动激活。
 
 ### 使用特定反馈进行更新
 
-你可以直接从命令行提供反馈来更新一个或多个文档，而无需进入交互式会话。
+您可以直接从命令行提供反馈来更新一个或多个文档，而无需进入交互会话。
 
 ```bash title="使用反馈更新单个文档"
-aigne doc update --docs /guides/overview.md --feedback "Add a section explaining the authentication flow"
+aigne doc update --docs overview.md --feedback "Add a section explaining the authentication flow"
 ```
 
 ```bash title="使用相同的反馈更新多个文档"
-aigne doc update --docs /guides/overview.md --docs /guides/getting-started.md --feedback "Improve the clarity of all code examples"
+aigne doc update --docs overview.md --docs guides-getting-started.md --feedback "Improve the clarity of all code examples"
 ```
 
-### 重置与重新生成
+### 重置和重新生成
 
 `--reset` 标志指示工具忽略文档的先前版本，并根据源代码从头开始重新生成它们。当代码中的重大变更使现有文档过时时，这非常有用。
 
 ```bash title="从头开始重新生成特定文档"
-aigne doc update --docs /guides/overview.md --reset
+aigne doc update --docs overview.md --reset
 ```
 
 ## 命令参考
 
-`update` 命令接受多个标志来控制其行为。
+`update` 命令接受几个标志来控制其行为。
 
 | Parameter | Description | Example |
 | :--- | :--- | :--- |
-| `--docs <path>` | 指定要更新的一个或多个文档路径。可多次使用。 | `--docs /overview --docs /guides/generating-documentation` |
-| `--feedback <text>` | 提供有关内容变更的指令。 | `--feedback "为安装步骤添加更多细节"` |
+| `--docs <path>` | 指定要更新的一个或多个文档路径。可多次使用。 | `--docs overview.md --docs guides-generating-documentation.md` |
+| `--feedback <text>` | 提供有关内容变更的指令。 | `--feedback "Add more detail to the installation steps"` |
 | `--glossary <file>` | 指定一个术语表文件，以确保在重新生成期间术语的一致性。 | `--glossary @/path/to/glossary.md` |
 | `--reset` | 一个布尔标志，强制完全重新生成所选文档，忽略其先前版本。 | `--reset` |
 
 ## 总结
 
-`update` 命令提供了一个灵活的工作流，可让你的文档与项目保持一致。使用交互模式对单个文档进行详细的迭代变更，使用批量模式高效地将广泛的更新应用于多个文件。
+`update` 命令提供了一个灵活的工作流，可让您的文档与项目保持一致。使用交互模式对单个文档进行详细的迭代更改，使用批处理模式高效地将广泛的更新应用于多个文件。
 
 有关相关任务，请参阅以下指南：
 - [生成文档](./guides-generating-documentation.md)

package/docs/overview.ja.md

@@ -1,8 +1,8 @@
 # 概要
 
-AIGNE DocSmithは、人工知能を利用してプロジェクトのソースコードからドキュメントを自動的に作成するツールです。AIGNEフレームワーク上に構築されており、コードベースを正確に反映した、構造化された多言語ドキュメントを生成するように設計されています。
+AIGNE DocSmithは、人工知能を利用してプロジェクトのソースコードからドキュメントを自動的に作成するツールです。これは[AIGNE Framework](https://www.aigne.io/framework)上に構築されており、コードベースを正確に反映した構造化された多言語ドキュメントを生成するように設計されています。
 
-DocSmithの主な目的は、手動でのドキュメント作成における一般的な課題、例えば作成に時間がかかる、コードの変更に伴い内容が古くなる、一貫性に欠けるといった問題に対処することです。このプロセスを自動化することで、DocSmithはドキュメントを常に最新かつ正確な状態に保つのに役立ちます。
+DocSmithの主な目的は、手動でのドキュメント作成に伴う一般的な課題、例えば作成に時間がかかる、コードの変更に伴い内容が古くなる、一貫性に欠けるといった問題に対処することです。このプロセスを自動化することで、DocSmithはドキュメントを常に最新かつ正確に保つ手助けをします。
 
 ## 仕組み
 
@@ -32,13 +32,13 @@ DocSmith -> Docs: "生成"
 
 ## 主な機能
 
-DocSmithは、ドキュメントの作成から公開までのライフサイクルを管理するための一連の機能を提供します。
+DocSmithは、作成から公開までのドキュメントライフサイクルを管理するための一連の機能を提供します。
 
-*   **AIによる生成**：コードベースを分析して論理的なドキュメント構造を提案し、コードの機能を説明するコンテンツを生成します。
-*   **多言語サポート**：ドキュメントを英語、中国語（簡体字）、日本語を含む12言語に翻訳します。翻訳プロセスは文脈を考慮し、技術的な正確性を維持します。
-*   **LLMとの統合**：さまざまな大規模言語モデル（LLM）と接続します。デフォルトでは、[AIGNE Hub](https://www.aigne.io/en/hub)を使用します。これは、Google GeminiやOpenAI GPTなどのモデルを個別のAPIキーなしで切り替えることができるサービスです。プロバイダーに直接アクセスするために、独自のAPIキーを設定することもできます。
-*   **スマートアップデート**：ソースコードの変更を検出し、ドキュメントの該当セクションを更新します。また、生成されたコンテンツを洗練させるために、具体的なフィードバックを提供することもできます。
-*   **公開オプション**：生成されたドキュメントを単一のコマンドで公開します。公式のDocSmithプラットフォーム、または独自の[Discuss Kit](https://www.web3kit.rocks/discuss-kit)インスタンスにデプロイできます。Discuss Kitは、ドキュメントをホスティングおよび表示するためのサービスです。
+*   **AIによる生成**：コードベースを分析し、論理的なドキュメント構造を提案し、コードの機能を説明するコンテンツを生成します。
+*   **多言語サポート**：ドキュメントを英語、中国語（簡体字）、日本語を含む12言語に翻訳します。翻訳プロセスは、技術的な正確性を維持するために文脈を認識します。
+*   **LLMとの統合**：さまざまな大規模言語モデル（LLM）と連携します。デフォルトでは、[AIGNE Hub](https://www.aigne.io/en/hub)を使用します。これは、個別のAPIキーを必要とせずにGoogle GeminiやOpenAI GPTのようなモデルを切り替えることができるサービスです。プロバイダーに直接アクセスするために、独自のAPIキーを設定することもできます。
+*   **スマートアップデート**：ソースコードの変更を検出し、ドキュメントの対応するセクションを更新します。また、生成されたコンテンツを洗練させるために、具体的なフィードバックを提供することもできます。
+*   **公開オプション**：単一のコマンドで生成されたドキュメントを公開します。公式のDocSmithプラットフォーム、または独自の[Discuss Kit](https://www.web3kit.rocks/discuss-kit)インスタンスにデプロイできます。Discuss Kitは、ドキュメントをホスティングおよび表示するためのサービスです。
 
 ## 利用可能なコマンド
 
@@ -47,15 +47,15 @@ DocSmithは一連のコマンドを通じて操作されます。以下の表は
 | コマンド | 説明 |
 | :--- | :--- |
 | `generate` | ソースファイルから新しいドキュメントセットを作成します。 |
-| `update` | コードの変更や新しいフィードバックに基づいて、既存のドキュメントを修正します。 |
-| `translate` | ドキュメントをサポートされている12言語のいずれか、または複数に翻訳します。 |
+| `update` | コードの変更や新しいフィードバックに基づいて既存のドキュメントを修正します。 |
+| `translate` | ドキュメントをサポートされている12言語のいずれかまたは複数に翻訳します。 |
 | `publish` | ドキュメントをライブでアクセス可能なURLにデプロイします。 |
 | `evaluate` | 生成されたドキュメントの品質と完全性を評価します。 |
-| `history` | ドキュメントに行われた更新の履歴を表示します。 |
+| `history` | ドキュメントに加えられた更新履歴を表示します。 |
 | `chat` | ドキュメント作成タスクを支援するための対話型チャットセッションを開始します。 |
-| `clear` | 生成されたファイル、設定、およびキャッシュデータを削除します。 |
+| `clear` | 生成されたファイル、設定、キャッシュデータを削除します。 |
 | `prefs` | ドキュメント生成のために保存された設定や構成を管理します。 |
 
 ---
 
-この概要では、AIGNE DocSmithの目的と機能の全体像を説明しました。ツールの使用を開始するには、[はじめに](./getting-started.md)ガイドに進み、インストールとセットアップの手順を確認してください。
+この概要では、AIGNE DocSmithの目的と機能の全体像を説明しました。ツールの使用を開始するには、インストールとセットアップの手順が記載されている[スタートガイド](./getting-started.md)に進んでください。

package/docs/overview.md

@@ -1,6 +1,6 @@
 # Overview
 
-AIGNE DocSmith is a tool that uses Artificial Intelligence to automatically create documentation from your project's source code. It is built on the AIGNE Framework and is designed to produce structured, multi-language documents that accurately reflect your codebase.
+AIGNE DocSmith is a tool that uses Artificial Intelligence to automatically create documentation from your project's source code. It is built on the [AIGNE Framework](https://www.aigne.io/framework) and is designed to produce structured, multi-language documents that accurately reflect your codebase.
 
 The primary goal of DocSmith is to address the common challenges of manual documentation, such as being time-consuming to write, becoming outdated as code changes, and lacking consistency. By automating this process, DocSmith helps ensure your documentation remains current and accurate.
 

package/docs/overview.zh-TW.md

@@ -1,12 +1,12 @@
 # 總覽
 
-AIGNE DocSmith 是一個利用人工智慧從專案原始碼自動建立文件的工具。它建立在 AIGNE 框架之上，旨在產出能準確反映您程式碼庫的結構化、多語言文件。
+AIGNE DocSmith 是一款利用人工智慧從您專案的原始碼自動建立文件的工具。它建構於 [AIGNE Framework](https://www.aigne.io/framework) 之上，旨在產出能準確反映您程式碼庫的結構化、多語言文件。
 
-DocSmith 的主要目標是解決手動撰寫文件時的常見挑戰，例如耗時、因程式碼變更而過時，以及缺乏一致性。透過自動化此流程，DocSmith 有助於確保您的文件保持最新和準確。
+DocSmith 的主要目標是解決手動編寫文件的常見挑戰，例如編寫耗時、隨著程式碼變更而過時，以及缺乏一致性。透過自動化此流程，DocSmith 有助於確保您的文件保持最新和準確。
 
 ## 運作方式
 
-DocSmith 透過分析您的專案原始碼來理解其結構、元件和功能。基於此分析，它會生成一套完整的文件，從高階指南到詳細的 API 參考資料。
+DocSmith 透過分析您專案的原始碼來運作，以理解其結構、元件和功能。根據此分析，它會產生一套完整的文件，從高階指南到詳細的 API 參考資料。
 
 ```d2
 direction: down
@@ -22,40 +22,40 @@ DocSmith: {
 }
 
 Docs: {
-  label: "生成的文件"
+  label: "產生的文件"
   shape: rectangle
 }
 
 Source-Code -> DocSmith: "分析"
-DocSmith -> Docs: "生成"
+DocSmith -> Docs: "產生"
 ```
 
 ## 核心功能
 
-DocSmith 提供一系列功能來處理從建立到發布的整個文件生命週期。
+DocSmith 提供了一系列功能來處理從建立到發布的整個文件生命週期。
 
-*   **AI 驅動生成**：分析您的程式碼庫以提出合乎邏輯的文件結構，並生成解釋程式碼功能的內容。
-*   **多語言支援**：將文件翻譯成 12 種語言，包括英文、簡體中文和日文。翻譯過程會感知上下文，以保持技術準確性。
-*   **與大型語言模型 (LLM) 整合**：可連接各種大型語言模型 (LLM)。預設情況下，它使用 [AIGNE Hub](https://www.aigne.io/en/hub)，這項服務讓您可以在 Google Gemini 和 OpenAI GPT 等模型之間切換，而無需獨立的 API 金鑰。您也可以設定自己的 API 金鑰以直接存取供應商。
-*   **智慧更新**：偵測原始碼中的變更，並更新文件的相應部分。您也可以提供具體的回饋來完善生成的內容。
-*   **發布選項**：只需一個指令即可發布您生成的文件。您可以部署到官方的 DocSmith 平台，或您自己的 [Discuss Kit](https://www.web3kit.rocks/discuss-kit) 實例。Discuss Kit 是一項用於託管和展示文件的服務。
+*   **AI 驅動的生成**：分析您的程式碼庫以提出合乎邏輯的文件結構，並產生解釋您程式碼功能的內容。
+*   **多語言支援**：將文件翻譯成 12 種語言，包括英語、簡體中文和日語。翻譯過程能感知上下文，以保持技術準確性。
+*   **與大型語言模型 (LLM) 整合**：連接各種大型語言模型 (LLM)。預設情況下，它使用 [AIGNE Hub](https://www.aigne.io/en/hub)，這是一項服務，讓您可以在 Google Gemini 和 OpenAI GPT 等模型之間切換，而無需單獨的 API 金鑰。您也可以設定自己的 API 金鑰以直接存取供應商。
+*   **智慧更新**：偵測您原始碼中的變更，並更新文件的相應部分。您還可以提供具體的回饋來完善產生的內容。
+*   **發布選項**：使用單一指令發布您產生的文件。您可以部署到官方 DocSmith 平台或您自己的 [Discuss Kit](https://www.web3kit.rocks/discuss-kit) 實例。Discuss Kit 是一項用於託管和顯示文件的服務。
 
 ## 可用指令
 
-DocSmith 透過一系列指令進行操作。下表總結了主要指令及其功能。
+DocSmith 透過一組指令進行操作。下表總結了主要指令及其功能。
 
 | Command | Description |
 | :--- | :--- |
-| `generate` | 從您的原始檔案建立一套新的文件。 |
+| `generate` | 從您的來源檔案建立一套新文件。 |
 | `update` | 根據程式碼變更或新的回饋修改現有文件。 |
 | `translate` | 將文件翻譯成 12 種支援語言中的一種或多種。 |
-| `publish` | 將您的文件部署到一個可公開存取的即時 URL。 |
-| `evaluate` | 評估您所生成文件的品質與完整性。 |
-| `history` | 檢視文件的更新歷史記錄。 |
+| `publish` | 將您的文件部署到一個可即時存取的 URL。 |
+| `evaluate` | 評估您所產生文件的品質和完整性。 |
+| `history` | 檢視您文件的更新歷史記錄。 |
 | `chat` | 啟動一個互動式聊天會話，以協助處理文件任務。 |
-| `clear` | 移除生成檔案、配置和快取資料。 |
-| `prefs` | 管理用於文件生成的已儲存偏好設定和配置。 |
+| `clear` | 移除產生的檔案、設定和快取資料。 |
+| `prefs` | 管理用於文件生成的已儲存偏好設定和組態。 |
 
 ---
 
-本總覽提供了 AIGNE DocSmith 用途和功能的高階摘要。若要開始使用此工具，請前往 [快速入門](./getting-started.md) 指南以取得安裝和設定說明。
+本總覽提供了 AIGNE DocSmith 的用途和功能的高階摘要。若要開始使用此工具，請前往 [快速入門](./getting-started.md) 指南以取得安裝和設定說明。

package/docs/overview.zh.md

@@ -1,12 +1,12 @@
 # 概述
 
-AIGNE DocSmith 是一款利用人工智能从项目源代码自动创建文档的工具。它基于 AIGNE 框架构建，旨在生成能够准确反映代码库的结构化、多语言文档。
+AIGNE DocSmith 是一款利用人工智能从项目源代码自动创建文档的工具。它基于 [AIGNE Framework](https://www.aigne.io/framework) 构建，旨在生成能够准确反映代码库的结构化、多语言文档。
 
-DocSmith 的主要目标是解决手动编写文档时面临的常见挑战，例如耗时、代码变更后内容过时以及缺乏一致性。通过自动化此过程，DocSmith 有助于确保您的文档保持最新和准确。
+DocSmith 的主要目标是解决手动编写文档时常见的挑战，例如耗时、代码变更后内容过时以及缺乏一致性。通过自动化此过程，DocSmith 有助于确保您的文档保持最新和准确。
 
 ## 工作原理
 
-DocSmith 通过分析项目的源代码来理解其结构、组件和功能。基于此分析，它会生成一套完整的文档，从高级指南到详细的 API 参考手册。
+DocSmith 通过分析项目的源代码来理解其结构、组件和功能。基于此分析，它会生成一套完整的文档，从高级指南到详细的 API 参考。
 
 ```d2
 direction: down
@@ -17,7 +17,7 @@ Source-Code: {
 }
 
 DocSmith: {
-  label: "AIGNE DocSmith\n（AI 分析引擎）"
+  label: "AIGNE DocSmith\n(AI 分析引擎)"
   shape: rectangle
 }
 
@@ -34,11 +34,11 @@ DocSmith -> Docs: "生成"
 
 DocSmith 提供了一系列功能来处理从创建到发布的整个文档生命周期。
 
-*   **AI 驱动生成**：分析您的代码库，提出逻辑化的文档结构，并生成解释代码功能的内容。
-*   **多语言支持**：可将文档翻译成 12 种语言，包括英语、简体中文和日语。翻译过程具备上下文感知能力，以保持技术准确性。
-*   **与 LLM 集成**：可连接各种大型语言模型（LLM）。默认情况下，它使用 [AIGNE Hub](https://www.aigne.io/en/hub)，该服务允许您在 Google Gemini 和 OpenAI GPT 等模型之间切换，而无需单独的 API 密钥。您也可以配置自己的 API 密钥以直接访问提供商。
-*   **智能更新**：检测源代码中的变更，并更新文档的相应部分。您还可以提供具体反馈以优化生成的内容。
-*   **发布选项**：通过单个命令即可发布您生成的文档。您可以将其部署到官方 DocSmith 平台，也可以部署到您自己的 [Discuss Kit](https://www.web3kit.rocks/discuss-kit) 实例。Discuss Kit 是一项用于托管和展示文档的服务。
+*   **AI 驱动的生成**：分析您的代码库以提出逻辑化的文档结构，并生成解释代码功能的内容。
+*   **多语言支持**：可将文档翻译成 12 种语言，包括英语、中文（简体）和日语。翻译过程能够感知上下文，以保持技术准确性。
+*   **与 LLM 集成**：可连接各种大语言模型 (LLM)。默认情况下，它使用 [AIGNE Hub](https://www.aigne.io/en/hub)，该服务允许您在 Google Gemini 和 OpenAI GPT 等模型之间切换，而无需单独的 API 密钥。您也可以配置自己的 API 密钥以直接访问提供商。
+*   **智能更新**：检测源代码中的更改并更新文档的相应部分。您还可以提供具体反馈以优化生成的内容。
+*   **发布选项**：通过单个命令发布您生成的文档。您可以部署到官方 DocSmith 平台或您自己的 [Discuss Kit](https://www.web3kit.rocks/discuss-kit) 实例。Discuss Kit 是一项用于托管和展示文档的服务。
 
 ## 可用命令
 
@@ -46,16 +46,16 @@ DocSmith 通过一组命令进行操作。下表总结了主要命令及其功
 
 | 命令 | 描述 |
 | :--- | :--- |
-| `generate` | 从源文件创建一套新的文档。 |
-| `update` | 根据代码变更或新的反馈修改现有文档。 |
-| `translate` | 将文档翻译成 12 种支持的语言中的一种或多种。 |
+| `generate` | 从您的源文件创建一套新的文档。 |
+| `update` | 根据代码更改或新的反馈修改现有文档。 |
+| `translate` | 将文档翻译成 12 种支持语言中的一种或多种。 |
 | `publish` | 将您的文档部署到一个可实时访问的 URL。 |
-| `evaluate` | 评估所生成文档的质量和完整性。 |
-| `history` | 查看文档的更新历史。 |
-| `chat` | 启动一个交互式聊天会话，以协助完成文档任务。 |
+| `evaluate` | 评估您生成的文档的质量和完整性。 |
+| `history` | 查看对您的文档所做的更新历史。 |
+| `chat` | 启动一个交互式聊天会话，以协助处理文档任务。 |
 | `clear` | 删除生成的文件、配置和缓存数据。 |
 | `prefs` | 管理用于文档生成的已保存偏好和配置。 |
 
 ---
 
-本概述简要介绍了 AIGNE DocSmith 的用途和功能。要开始使用该工具，请参阅 [快速入门](./getting-started.md) 指南以获取安装和设置说明。
+本概述对 AIGNE DocSmith 的用途和功能进行了高级总结。要开始使用该工具，请继续阅读 [快速入门](./getting-started.md) 指南以获取安装和设置说明。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.8.12-beta.5",
+  "version": "0.8.12-beta.7",
   "description": "AI-driven documentation generation tool built on the AIGNE Framework",
   "publishConfig": {
     "access": "public"

package/prompts/common/afs/afs-tools-usage.md

@@ -0,0 +1,5 @@
+<afs-tool-usage>
+When to use Tools:
+- During document generation, if the given context is missing or lacks referenced content, use afs_list/afs_search/afs_read to obtain more context
+- Code examples in generated documents must use APIs and packages defined in the input data sources. Do not generate non-existent code out of thin air. Use afs_list/afs_search/afs_read to query related code or references
+</afs-tool-usage>

package/prompts/common/afs/use-afs-instruction.md

@@ -0,0 +1 @@
+Use AFS tools to list/search/read files to obtain more context or references. Ensure all content is accurate, relevant, and well-structured.

package/prompts/detail/generate/system-prompt.md

@@ -1,7 +1,6 @@
 <role_and_goal>
 {% include "../../common/document/role-and-personality.md" %}
 
-Your task is to generate detailed document for the current {{nodeName}} based on user-provided information: current {{nodeName}} details (including title, description, path), DataSources, documentStructure (overall structural planning), and other relevant information.
 </role_and_goal>
 
 
@@ -50,18 +49,6 @@ Diagram generation rules:
 </content_generation_rules>
 
 
-<tool-usage>
-1. glob: Find files matching specific patterns with advanced filtering and sorting.
-
-2. grep: Search file contents using regular expressions with multiple strategies (git grep → system grep → JavaScript fallback).
-
-3. readFile: Read file contents with intelligent binary detection, pagination, and metadata extraction.
-
-When to use Tools:
-- During document generation, if the given context is missing or lacks referenced content, use glob/grep/readFile to obtain more context
-- Code examples in generated documents must use APIs and packages defined in the input data sources. Do not generate non-existent code out of thin air. Use glob/grep/readFile to query related code or references
-</tool-usage>
-
 
 <output_constraints>
 

package/prompts/detail/generate/user-prompt.md

@@ -52,3 +52,10 @@ User feedback on previous generation:
 {{feedback}}
 </feedback>
 {% endif %}
+
+{% include "../../common/afs/afs-tools-usage.md" %}
+
+<instructions>
+Generate detailed document for the current {{nodeName}} based on user-provided information: current {{nodeName}} details (including title, description, path), DataSources, documentStructure (overall structural planning), and other relevant information.
+{% include "../../common/afs/use-afs-instruction.md" %}
+</instructions>

package/prompts/detail/update/system-prompt.md

@@ -1,7 +1,5 @@
 <role_and_goal>
 {% include "../../common/document/role-and-personality.md" %}
-
-Your task is to analyze the original document content and user feedback, then use available tools to implement the requested improvements while maintaining the document's integrity and style.
 </role_and_goal>
 
 
@@ -108,6 +106,7 @@ Error handling:
 
 {% include "../generate/detail-example.md" %}
 
+
 <output_format>
 ** Only output operation execution status **:
 - Only return 'success' if operation executed successfully

package/prompts/detail/update/user-prompt.md

@@ -31,3 +31,10 @@
 <user_feedback>
 {{feedback}}
 </user_feedback>
+
+{% include "../../common/afs/afs-tools-usage.md" %}
+
+<instructions>
+Analyze the original document content and user feedback, then use available tools to implement the requested improvements while maintaining the document's integrity and style.
+{% include "../../common/afs/use-afs-instruction.md" %}
+</instructions>

package/prompts/structure/generate/system-prompt.md

@@ -1,25 +1,6 @@
 <role_and_goal>
 You are an AI document strategist with the personality of an **INTJ (The Architect)**. Your core strengths are strategic thinking, understanding complex systems, and creating logically sound blueprints. You are a perfectionist, rigorously logical, and can anticipate future challenges.
 
-
-Your task is to design a detailed structural plan for the document to be generated. This plan will serve as a "blueprint" for subsequent content generation, guiding the LLM on how to organize and present information, ensuring the document is logically clear, easy to understand, well-structured, and comprehensive.
-
-Key capabilities and behavioral principles:
-  - Data Comprehension: Ability to parse and understand structured and unstructured data, identifying key concepts, entities, attributes, relationships, and processes within them.
-  - Structured Thinking: Strong logical analysis capabilities to decompose complex information into clear chapters, sections, and items, establishing reasonable hierarchical relationships.
-  - User-Oriented Approach: Ability to flexibly adjust the focus and level of detail in structural planning based on document objectives and audience characteristics provided by users.
-  - Modular Design: Tendency to divide documents into independent, reusable modules or sections for easy content population and subsequent maintenance.
-  - Flexibility and Adaptability: Ability to handle multiple types of data sources and design the most suitable documentation structure based on data source characteristics (such as code function/class structures, API endpoints/parameters, text paragraphs/themes).
-  - Clarity and Completeness: Ensure the final structural plan is easy to understand and can guide the LLM to generate a comprehensive and well-organized document.
-
-
-Objectives:
-  - Create a clear and logical structural plan that comprehensively presents information from the user-provided context while providing users with intuitive navigation paths.
-  - Each {{nodeName}} should include: a {{nodeName}} title, a one-sentence introduction describing its main content, with presentation and organization methods tailored to the target audience.
-
-{% include "../../common/document-structure/intj-traits.md" %}
-
-Always follow one principle: You must ensure the final structural plan meets user requirements.
 </role_and_goal>
 
 

package/prompts/structure/generate/user-prompt.md

@@ -60,4 +60,25 @@ Sub-structures must meet the following requirements:
 - Further break down and comprehensively display the content planned in the parent document
 - All sub-structures must have their parentId value set to {{parentDocument.path}}
 </parent_document>
-{% endif %}
+{% endif %}
+
+<instructions>
+Your task is to design a detailed structural plan for the document to be generated. This plan will serve as a "blueprint" for subsequent content generation, guiding the LLM on how to organize and present information, ensuring the document is logically clear, easy to understand, well-structured, and comprehensive.
+
+Key capabilities and behavioral principles:
+  - Data Comprehension: Ability to parse and understand structured and unstructured data, identifying key concepts, entities, attributes, relationships, and processes within them.
+  - Structured Thinking: Strong logical analysis capabilities to decompose complex information into clear chapters, sections, and items, establishing reasonable hierarchical relationships.
+  - User-Oriented Approach: Ability to flexibly adjust the focus and level of detail in structural planning based on document objectives and audience characteristics provided by users.
+  - Modular Design: Tendency to divide documents into independent, reusable modules or sections for easy content population and subsequent maintenance.
+  - Flexibility and Adaptability: Ability to handle multiple types of data sources and design the most suitable documentation structure based on data source characteristics (such as code function/class structures, API endpoints/parameters, text paragraphs/themes).
+  - Clarity and Completeness: Ensure the final structural plan is easy to understand and can guide the LLM to generate a comprehensive and well-organized document.
+
+
+Objectives:
+  - Create a clear and logical structural plan that comprehensively presents information from the user-provided context while providing users with intuitive navigation paths.
+  - Each {{nodeName}} should include: a {{nodeName}} title, a one-sentence introduction describing its main content, with presentation and organization methods tailored to the target audience.
+
+{% include "../../common/document-structure/intj-traits.md" %}
+
+Always follow one principle: You must ensure the final structural plan meets user requirements.
+</instructions>

package/prompts/structure/update/system-prompt.md

@@ -6,23 +6,6 @@ Your task is to understand user requirements and execute the appropriate structu
 
 {% include "../../common/document-structure/intj-traits.md" %}
 
-Processing workflow:
-
-- If user feedback is not in English, translate it to English first to better understand user intent
-- Analyze user feedback to understand the specific intent (add, delete, update, or move sections)
-- Determine which tools to use based on the user's requirements
-- Execute the appropriate operations using available tools
-- Ensure all modifications maintain documentation structure integrity
-- Return 'success' when the latest version of websiteStructure meets user feedback
-
-Rules:
-** All changes must be made using Tools. **
-** Carefully check if the latest version of documentStructure data meets user requirements, must avoid duplicate Tool calls. **
-
-Objectives:
-  - Create a clear and logical structural plan that comprehensively presents information from the user-provided context while providing users with intuitive navigation paths.
-  - Each {{nodeName}} should include: a {{nodeName}} title, a one-sentence introduction describing its main content, with presentation and organization methods tailored to the target audience.
-
 </role_and_goal>
 
 

package/prompts/structure/update/user-prompt.md

@@ -20,3 +20,27 @@ Initial Documentation Structure:
 <user_feedback>
 {{ feedback }}
 </user_feedback>
+
+{% include "../../common/afs/afs-tools-usage.md" %}
+
+<instructions>
+
+Objectives:
+  - Create a clear and logical structural plan that comprehensively presents information from the user-provided context while providing users with intuitive navigation paths.
+  - Each {{nodeName}} should include: a {{nodeName}} title, a one-sentence introduction describing its main content, with presentation and organization methods tailored to the target audience.
+
+Processing workflow:
+
+- If user feedback is not in English, translate it to English first to better understand user intent
+- Analyze user feedback to understand the specific intent (add, delete, update, or move sections)
+- Determine which tools to use based on the user's requirements
+- Execute the appropriate operations using available tools
+- Ensure all modifications maintain documentation structure integrity
+- Return 'success' when the latest version of websiteStructure meets user feedback
+
+Rules:
+** All changes must be made using Tools. **
+** Carefully check if the latest version of documentStructure data meets user requirements, must avoid duplicate Tool calls. **
+
+{% include "../../common/afs/use-afs-instruction.md" %}
+</instructions>

package/tests/agents/history/view.test.mjs

@@ -0,0 +1,97 @@
+import { afterEach, beforeEach, describe, expect, test, mock, spyOn } from "bun:test";
+import { existsSync, mkdirSync, rmSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import { DOC_SMITH_DIR } from "../../../utils/constants/index.mjs";
+import viewHistory from "../../../agents/history/view.mjs";
+
+const TEST_DIR = join(process.cwd(), `${DOC_SMITH_DIR}-test`);
+const ORIGINAL_CWD = process.cwd();
+
+describe("History View", () => {
+  let consoleLogMock;
+
+  beforeEach(async () => {
+    // Clean up test directory
+    if (existsSync(TEST_DIR)) {
+      rmSync(TEST_DIR, { recursive: true });
+    }
+    mkdirSync(TEST_DIR, { recursive: true });
+
+    // Change to test directory
+    process.chdir(TEST_DIR);
+
+    // Spy on console.log
+    consoleLogMock = spyOn(console, "log");
+  });
+
+  afterEach(() => {
+    // Restore original directory
+    process.chdir(ORIGINAL_CWD);
+
+    // Clean up
+    if (existsSync(TEST_DIR)) {
+      rmSync(TEST_DIR, { recursive: true });
+    }
+
+    mock.restore();
+  });
+
+  test("should display message when no history exists", () => {
+    // No history file exists
+    const result = viewHistory();
+
+    expect(result).toEqual({});
+    expect(consoleLogMock).toHaveBeenCalledWith(expect.stringContaining("No update history found"));
+  });
+
+  test("should display formatted history entries", async () => {
+    // Create history file with sample data
+    const historyPath = join(process.cwd(), DOC_SMITH_DIR, "history.yaml");
+    mkdirSync(join(process.cwd(), DOC_SMITH_DIR), { recursive: true });
+
+    const historyData = {
+      entries: [
+        {
+          timestamp: "2023-01-01T00:00:00.000Z",
+          operation: "document_update",
+          feedback: "Updated documentation",
+          documentPath: "/readme.md",
+        },
+        {
+          timestamp: "2023-01-02T00:00:00.000Z",
+          operation: "structure_update",
+          feedback: "Reorganized sections",
+        },
+      ],
+    };
+
+    // Use YAML format instead of JSON
+    const { stringify } = await import("yaml");
+    writeFileSync(historyPath, stringify(historyData), "utf8");
+
+    const result = viewHistory();
+
+    expect(result).toEqual({});
+    expect(consoleLogMock).toHaveBeenCalledWith(expect.stringContaining("📜 Update History"));
+    expect(consoleLogMock).toHaveBeenCalledWith(expect.stringContaining("document_update"));
+    expect(consoleLogMock).toHaveBeenCalledWith(expect.stringContaining("structure_update"));
+    expect(consoleLogMock).toHaveBeenCalledWith(expect.stringContaining("Updated documentation"));
+    expect(consoleLogMock).toHaveBeenCalledWith(expect.stringContaining("Reorganized sections"));
+  });
+
+  test("should handle empty history entries", async () => {
+    // Create history file with empty entries
+    const historyPath = join(process.cwd(), DOC_SMITH_DIR, "history.yaml");
+    mkdirSync(join(process.cwd(), DOC_SMITH_DIR), { recursive: true });
+
+    const historyData = { entries: [] };
+    // Use YAML format instead of JSON
+    const { stringify } = await import("yaml");
+    writeFileSync(historyPath, stringify(historyData), "utf8");
+
+    const result = viewHistory();
+
+    expect(result).toEqual({});
+    expect(consoleLogMock).toHaveBeenCalledWith(expect.stringContaining("No update history found"));
+  });
+});