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

package/docs/guides-updating-documentation.md

@@ -0,0 +1,77 @@
+# Updating Documentation
+
+Maintaining the accuracy and relevance of documentation is a continuous process. As your codebase evolves or you receive new feedback, you will need to modify existing documents. The `update` command provides a structured way to regenerate specific documents with new instructions, ensuring they stay current.
+
+This guide explains the two primary methods for updating your documentation: an interactive mode for detailed, single-document refinement and a batch mode for applying changes to multiple documents at once.
+
+## Two Modes of Operation
+
+The `update` command operates in one of two modes depending on the number of documents you select and the options you provide.
+
+1.  **Interactive Mode**: Triggered when you update a single document without the `--reset` flag. This mode is designed for iterative refinement, allowing you to provide feedback, review the changes, and repeat the process until the document meets your standards.
+2.  **Batch Mode**: Used when you update multiple documents simultaneously or when you use the `--reset` flag. This mode applies your feedback to all selected documents in a single operation, which is efficient for broad changes.
+
+## Interactive Mode: Refining a Single Document
+
+Interactive mode provides a controlled environment for making precise changes to a single document. It is the ideal choice when you need to carefully review and adjust content based on specific feedback.
+
+To start an interactive session, run the `aigne doc update` command and select a single document from the list.
+
+```bash
+aigne doc update
+```
+
+The tool will guide you through the following steps:
+
+1.  **Document Analysis**: The system first displays the structural outline of the selected document, showing its main headings.
+2.  **User Action**: You are then prompted to choose one of three actions:
+    *   **View document**: Displays the full content of the current version of the document, rendered in your terminal for easy reading.
+    *   **Give feedback**: Prompts you to enter your modification requests. This can be anything from "add a section about error handling" to "clarify the purpose of the `config` object."
+    *   **Done**: Exits the interactive session and saves the last generated version of the document.
+3.  **Content Regeneration**: After you submit feedback, the AI regenerates the document content based on your instructions. The new heading structure is then displayed.
+4.  **Iterate or Finish**: You can continue this loop of viewing, providing feedback, and regenerating until you are satisfied with the result. Once you select "Done," the process is complete.
+
+This iterative cycle allows for fine-tuned control over the final output, ensuring the updated document is accurate and complete.
+
+## Batch Mode: Updating Multiple Documents
+
+Batch mode is designed for efficiency when you need to apply the same general feedback to multiple documents or completely regenerate them. This mode is automatically activated if you select more than one document or use command-line flags like `--docs` or `--reset`.
+
+### Updating with Specific Feedback
+
+You can provide feedback directly from the command line to update one or more documents without entering an interactive session.
+
+```bash title="Update a single document with feedback"
+aigne doc update --docs /guides/overview.md --feedback "Add a section explaining the authentication flow"
+```
+
+```bash title="Update multiple documents with the same feedback"
+aigne doc update --docs /guides/overview.md --docs /guides/getting-started.md --feedback "Improve the clarity of all code examples"
+```
+
+### Resetting and Regenerating
+
+The `--reset` flag instructs the tool to ignore the previous versions of the documents and regenerate them from scratch based on the source code. This is useful when significant changes in the code have made the existing documentation obsolete.
+
+```bash title="Regenerate a specific document from scratch"
+aigne doc update --docs /guides/overview.md --reset
+```
+
+## Command Reference
+
+The `update` command accepts several flags to control its behavior.
+
+| Parameter | Description | Example |
+| :--- | :--- | :--- |
+| `--docs <path>` | Specifies one or more document paths to update. Can be used multiple times. | `--docs /overview --docs /guides/generating-documentation` |
+| `--feedback <text>` | Provides instructions for what to change in the content. | `--feedback "Add more detail to the installation steps"` |
+| `--glossary <file>` | Specifies a glossary file to ensure consistent terminology during regeneration. | `--glossary @/path/to/glossary.md` |
+| `--reset` | A boolean flag that forces a complete regeneration of the selected documents, ignoring their previous versions. | `--reset` |
+
+## Summary
+
+The `update` command offers a flexible workflow for keeping your documentation aligned with your project. Use the interactive mode for detailed, iterative changes on a single document and the batch mode for applying broad updates across multiple files efficiently.
+
+For related tasks, refer to the following guides:
+- [Generating Documentation](./guides-generating-documentation.md)
+- [Translating Documentation](./guides-translating-documentation.md)

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

@@ -0,0 +1,77 @@
+# 更新文件
+
+維護文件的準確性和相關性是一個持續的過程。隨著您的程式碼庫不斷演進或收到新的回饋，您將需要修改現有的文件。`update` 指令提供了一種結構化的方式，可根據新的指示重新產生特定文件，確保其保持最新狀態。
+
+本指南將說明更新文件的兩種主要方法：用於詳細、單一文件優化的互動模式，以及一次性將變更應用於多個文件的批次模式。
+
+## 兩種操作模式
+
+`update` 指令根據您選擇的文件數量和提供的選項，在兩種模式之一中運作。
+
+1.  **互動模式**：當您更新單一文件且未使用 `--reset` 旗標時觸發。此模式專為迭代優化而設計，讓您可以提供回饋、檢視變更並重複此過程，直到文件符合您的標準為止。
+2.  **批次模式**：當您同時更新多個文件或使用 `--reset` 旗標時使用。此模式會在一次操作中將您的回饋應用於所有選定的文件，對於廣泛的變更而言非常有效率。
+
+## 互動模式：優化單一文件
+
+互動模式提供了一個受控的環境，可對單一文件進行精確的變更。當您需要根據特定回饋仔細檢視和調整內容時，這是理想的選擇。
+
+若要啟動互動式會話，請執行 `aigne doc update` 指令並從清單中選擇單一文件。
+
+```bash
+aigne doc update
+```
+
+該工具將引導您完成以下步驟：
+
+1.  **文件分析**：系統首先會顯示所選文件的結構大綱，展示其主要標題。
+2.  **使用者操作**：接著系統會提示您選擇以下三種操作之一：
+    *   **檢視文件**：顯示文件目前版本的完整內容，並在您的終端機中呈現以便於閱讀。
+    *   **提供回饋**：提示您輸入修改請求。這可以是任何內容，從「新增一個關於錯誤處理的章節」到「闡明 `config` 物件的用途」。
+    *   **完成**：退出互動式會話並儲存最後產生的文件版本。
+3.  **內容重新產生**：在您提交回饋後，AI 會根據您的指示重新產生文件內容。然後會顯示新的標題結構。
+4.  **迭代或完成**：您可以繼續這個檢視、提供回饋和重新產生的循環，直到您對結果滿意為止。一旦您選擇「完成」，此過程即告結束。
+
+這種迭代循環可以對最終輸出進行微調控制，確保更新後的文件準確且完整。
+
+## 批次模式：更新多個文件
+
+當您需要將相同的通用回饋應用於多個文件或完全重新產生它們時，批次模式是為效率而設計的。如果您選擇了多個文件或使用 `--docs` 或 `--reset` 等命令列旗標，此模式將自動啟動。
+
+### 使用特定回饋進行更新
+
+您可以直接從命令列提供回饋來更新一個或多個文件，而無需進入互動式會話。
+
+```bash title="使用回饋更新單一文件"
+aigne doc update --docs /guides/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"
+```
+
+### 重設與重新產生
+
+`--reset` 旗標指示工具忽略文件的先前版本，並根據原始程式碼從頭開始重新產生它們。當程式碼中的重大變更使現有文件過時時，這非常有用。
+
+```bash title="從頭開始重新產生特定文件"
+aigne doc update --docs /guides/overview.md --reset
+```
+
+## 指令參考
+
+`update` 指令接受數個旗標來控制其行為。
+
+| 參數 | 說明 | 範例 |
+| :--- | :--- | :--- |
+| `--docs <path>` | 指定要更新的一個或多個文件路徑。可多次使用。 | `--docs /overview --docs /guides/generating-documentation` |
+| `--feedback <text>` | 提供內容變更的指示。 | `--feedback "為安裝步驟新增更多細節"` |
+| `--glossary <file>` | 指定一個術語表檔案，以確保在重新產生過程中術語的一致性。 | `--glossary @/path/to/glossary.md` |
+| `--reset` | 一個布林旗標，強制完全重新產生所選文件，忽略其先前版本。 | `--reset` |
+
+## 總結
+
+`update` 指令提供了一個靈活的工作流程，讓您的文件與專案保持一致。使用互動模式對單一文件進行詳細的迭代變更，並使用批次模式有效率地將廣泛的更新應用於多個檔案。
+
+如需相關任務，請參閱以下指南：
+- [產生文件](./guides-generating-documentation.md)
+- [翻譯文件](./guides-translating-documentation.md)

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

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

package/docs/guides.ja.md

@@ -0,0 +1,32 @@
+# ガイド
+
+このセクションでは、AIGNE DocSmith を使用して一般的なドキュメント作成タスクを実行するための、構造化されたステップバイステップの手順を説明します。各ガイドは、最初の生成から最終的な公開まで、特定のワークフローを順を追って説明するように設計されています。
+
+以下のガイドを選択して、特定のコマンドとその機能について学びましょう。
+
+<x-cards data-columns="2">
+  <x-card data-title="ドキュメントの生成" data-icon="lucide:file-plus-2" data-href="/guides/generating-documentation">
+    ソースファイルから新しいドキュメント一式を作成するプロセスを最初から最後まで解説します。
+  </x-card>
+  <x-card data-title="ドキュメントの更新" data-icon="lucide:file-edit" data-href="/guides/updating-documentation">
+    コードの変更や新しいフィードバックに基づいて既存のドキュメントを修正する方法を説明します。
+  </x-card>
+  <x-card data-title="ドキュメントの翻訳" data-icon="lucide:languages" data-href="/guides/translating-documentation">
+    ドキュメントを複数のサポートされている言語に翻訳する手順を詳しく説明します。
+  </x-card>
+  <x-card data-title="ドキュメントの公開" data-icon="lucide:send" data-href="/guides/publishing-your-docs">
+    生成されたドキュメントをオンラインで公開し、アクセス可能にする方法を示します。
+  </x-card>
+  <x-card data-title="履歴の管理" data-icon="lucide:history" data-href="/guides/managing-history">
+    ドキュメントに加えられた更新の履歴を表示する方法を示します。
+  </x-card>
+  <x-card data-title="ドキュメントの評価" data-icon="lucide:clipboard-check" data-href="/guides/evaluating-documents">
+    評価コマンドを使用して、生成されたドキュメントの品質と完全性を評価する方法を詳しく説明します。
+  </x-card>
+  <x-card data-title="クリーンアップ" data-icon="lucide:trash-2" data-href="/guides/cleaning-up">
+    clear コマンドを使用して、生成されたファイル、設定、キャッシュデータを削除する方法について説明します。
+  </x-card>
+  <x-card data-title="インタラクティブチャット" data-icon="lucide:bot" data-href="/guides/interactive-chat">
+    インタラクティブチャットアシスタントを使用してドキュメントを生成、修正、管理する方法を説明します。
+  </x-card>
+</x-cards>

package/docs/guides.md

@@ -0,0 +1,32 @@
+# Guides
+
+This section provides structured, step-by-step instructions for performing common documentation tasks with AIGNE DocSmith. Each guide is designed to walk you through a specific workflow, from initial generation to final publication.
+
+Select a guide below to learn about a specific command and its functions.
+
+<x-cards data-columns="2">
+  <x-card data-title="Generating Documentation" data-icon="lucide:file-plus-2" data-href="/guides/generating-documentation">
+    Walks through the process of creating a new set of documents from your source files from start to finish.
+  </x-card>
+  <x-card data-title="Updating Documentation" data-icon="lucide:file-edit" data-href="/guides/updating-documentation">
+    Explains how to modify existing documents based on code changes or new feedback.
+  </x-card>
+  <x-card data-title="Translating Documentation" data-icon="lucide:languages" data-href="/guides/translating-documentation">
+    Details the steps to translate your documents into multiple supported languages.
+  </x-card>
+  <x-card data-title="Publishing Your Docs" data-icon="lucide:send" data-href="/guides/publishing-your-docs">
+    Shows how to make your generated documentation live and accessible online.
+  </x-card>
+  <x-card data-title="Managing History" data-icon="lucide:history" data-href="/guides/managing-history">
+    Shows how to view the history of updates made to your documentation.
+  </x-card>
+  <x-card data-title="Evaluating Documents" data-icon="lucide:clipboard-check" data-href="/guides/evaluating-documents">
+    Details how to use the evaluation command to assess the quality and completeness of your generated documentation.
+  </x-card>
+  <x-card data-title="Cleaning Up" data-icon="lucide:trash-2" data-href="/guides/cleaning-up">
+    Provides instructions on how to use the clear command to remove generated files, configurations, and cached data.
+  </x-card>
+  <x-card data-title="Interactive Chat" data-icon="lucide:bot" data-href="/guides/interactive-chat">
+    Explains how to use the interactive chat assistant to generate, modify, and manage your documentation.
+  </x-card>
+</x-cards>

package/docs/guides.zh-TW.md

@@ -0,0 +1,32 @@
+# 指南
+
+本節提供結構化、逐步的說明，指導您如何使用 AIGNE DocSmith 執行常見的文件任務。每個指南都旨在引導您完成特定的工作流程，從最初的生成到最終的發布。
+
+請選擇下方的指南，以了解特定指令及其功能。
+
+<x-cards data-columns="2">
+  <x-card data-title="產生文件" data-icon="lucide:file-plus-2" data-href="/guides/generating-documentation">
+    逐步介紹從頭到尾根據您的原始檔案建立新文件的過程。
+  </x-card>
+  <x-card data-title="更新文件" data-icon="lucide:file-edit" data-href="/guides/updating-documentation">
+    說明如何根據程式碼變更或新的回饋來修改現有文件。
+  </x-card>
+  <x-card data-title="翻譯文件" data-icon="lucide:languages" data-href="/guides/translating-documentation">
+    詳細說明將您的文件翻譯成多種支援語言的步驟。
+  </x-card>
+  <x-card data-title="發布您的文件" data-icon="lucide:send" data-href="/guides/publishing-your-docs">
+    展示如何將您產生的文件上線並可供線上存取。
+  </x-card>
+  <x-card data-title="管理歷史紀錄" data-icon="lucide:history" data-href="/guides/managing-history">
+    展示如何查看對您的文件所做的更新歷史紀錄。
+  </x-card>
+  <x-card data-title="評估文件" data-icon="lucide:clipboard-check" data-href="/guides/evaluating-documents">
+    詳細說明如何使用評估指令來評鑑您所產生文件的品質與完整性。
+  </x-card>
+  <x-card data-title="清理" data-icon="lucide:trash-2" data-href="/guides/cleaning-up">
+    提供如何使用清除指令來移除已產生的檔案、設定和快取資料的說明。
+  </x-card>
+  <x-card data-title="互動式聊天" data-icon="lucide:bot" data-href="/guides/interactive-chat">
+    說明如何使用互動式聊天助理來產生、修改和管理您的文件。
+  </x-card>
+</x-cards>

package/docs/guides.zh.md

@@ -0,0 +1,32 @@
+# 指南
+
+本节提供了结构化的、分步的说明，用于使用 AIGNE DocSmith 执行常见的文档任务。每个指南都旨在引导您完成一个特定的工作流程，从初始生成到最终发布。
+
+请在下方选择一个指南，以了解特定命令及其功能。
+
+<x-cards data-columns="2">
+  <x-card data-title="生成文档" data-icon="lucide:file-plus-2" data-href="/guides/generating-documentation">
+    从头到尾完整地介绍了如何从源文件创建一套新文档的过程。
+  </x-card>
+  <x-card data-title="更新文档" data-icon="lucide:file-edit" data-href="/guides/updating-documentation">
+    解释了如何根据代码变更或新反馈修改现有文档。
+  </x-card>
+  <x-card data-title="翻译文档" data-icon="lucide:languages" data-href="/guides/translating-documentation">
+    详细介绍了将文档翻译成多种支持语言的步骤。
+  </x-card>
+  <x-card data-title="发布文档" data-icon="lucide:send" data-href="/guides/publishing-your-docs">
+    展示了如何将生成的文档上线并使其可在线访问。
+  </x-card>
+  <x-card data-title="管理历史记录" data-icon="lucide:history" data-href="/guides/managing-history">
+    展示了如何查看文档的更新历史记录。
+  </x-card>
+  <x-card data-title="评估文档" data-icon="lucide:clipboard-check" data-href="/guides/evaluating-documents">
+    详细介绍了如何使用评估命令来评估所生成文档的质量和完整性。
+  </x-card>
+  <x-card data-title="清理" data-icon="lucide:trash-2" data-href="/guides/cleaning-up">
+    提供了如何使用清理命令来移除生成的文件、配置和缓存数据的说明。
+  </x-card>
+  <x-card data-title="交互式聊天" data-icon="lucide:bot" data-href="/guides/interactive-chat">
+    解释了如何使用交互式聊天助手来生成、修改和管理您的文档。
+  </x-card>
+</x-cards>

package/docs/overview.ja.md

@@ -1,82 +1,61 @@
 # 概要
 
-AIGNE DocSmithは、ソースコードから直接ドキュメントを生成するAI駆動のツールです。[AIGNE Framework](https://www.aigne.io/en/framework)上に構築されており、構造化された多言語ドキュメントの作成を自動化します。このプロセスにより、ドキュメントの作成と保守にかかる手作業が削減され、コードベースとの同期が確保されます。
+AIGNE DocSmithは、人工知能を利用してプロジェクトのソースコードからドキュメントを自動的に作成するツールです。AIGNEフレームワーク上に構築されており、コードベースを正確に反映した、構造化された多言語ドキュメントを生成するように設計されています。
 
-以下の図は、DocSmithのハイレベルなワークフローを示しています。
+DocSmithの主な目的は、手動でのドキュメント作成における一般的な課題、例えば作成に時間がかかる、コードの変更に伴い内容が古くなる、一貫性に欠けるといった問題に対処することです。このプロセスを自動化することで、DocSmithはドキュメントを常に最新かつ正確な状態に保つのに役立ちます。
 
-```d2
-direction: right
-style: {
-  font-size: 14
-}
+## 仕組み
 
-# Actors
-source_code: "ソースコードリポジトリ" {
-  shape: cloud
-  style: {
-    fill: "#F0F4F8"
-    stroke: "#4A5568"
-  }
-}
+DocSmithは、プロジェクトのソースコードを分析して、その構造、コンポーネント、および機能を理解することによって動作します。この分析に基づいて、高レベルのガイドから詳細なAPIリファレンスまで、完全なドキュメントセットを生成します。
 
-docsmith: "AIGNE DocSmithエンジン" {
-  shape: hexagon
-  style: {
-    fill: "#E6FFFA"
-    stroke: "#2C7A7B"
-  }
+```d2
+direction: down
+
+Source-Code: {
+  label: "プロジェクトのソースコード"
+  shape: rectangle
 }
 
-published_docs: "公開されたドキュメント" {
-  shape: document
-  style: {
-    fill: "#FEFCBF"
-    stroke: "#B7791F"
-  }
+DocSmith: {
+  label: "AIGNE DocSmith\n(AI分析エンジン)"
+  shape: rectangle
 }
 
-# Main Flow
-source_code -> docsmith: "1. コードを分析"
-docsmith -> published_docs: "2. 生成と公開"
-
-# DocSmith Internal Process
-subflow: {
-  direction: down
-  
-  analyze: "構造の分析と計画"
-  generate: "コンテンツの生成"
-  translate: "翻訳（オプション）"
-  publish: "公開"
-  
-  analyze -> generate -> translate -> publish
+Docs: {
+  label: "生成されたドキュメント"
+  shape: rectangle
 }
 
-docsmith.subflow: subflow
+Source-Code -> DocSmith: "分析"
+DocSmith -> Docs: "生成"
 ```
 
 ## 主な機能
 
-DocSmithは、ドキュメント作成プロセスを自動化し、簡素化するための一連の機能を提供します。
-
-*   **構造計画:** コードベースを分析して、論理的なドキュメント構造を生成します。
-*   **コンテンツ生成:** 計画されたドキュメント構造に、ソースコードから生成されたコンテンツを埋め込みます。
-*   **多言語サポート:** ドキュメントを英語、中国語、スペイン語を含む12言語に翻訳します。
-*   **AIGNE Hub統合:** Google、OpenAI、Anthropicなどのさまざまな大規模言語モデル（LLM）へのアクセスを提供するサービスである[AIGNE Hub](https://www.aigne.io/en/hub)を使用し、個別のAPIキーを管理することなくモデルを切り替えることができます。
-*   **ワンクリック公開:** 共有可能なリンクでドキュメントを公開します。公式プラットフォームに公開するか、[Discuss Kit](https://www.web3kit.rocks/discuss-kit)を使用して独自のインスタンスを実行できます。
-*   **反復的な更新:** ソースコードの変更を検知してドキュメントを更新し、ユーザーのフィードバックに基づいて特定のドキュメントのターゲット再生成をサポートします。
-
-## AIGNEエコシステムの一部
+DocSmithは、ドキュメントの作成から公開までのライフサイクルを管理するための一連の機能を提供します。
 
-DocSmithは、AIアプリケーション開発のためのプラットフォームである[AIGNE](https://www.aigne.io)エコシステムのコンポーネントです。他のAIGNEコンポーネントと統合し、プラットフォームのAI機能とインフラストラクチャを利用します。
+*   **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がAIGNEアーキテクチャ内でどのように位置づけられているかを示しています。
+## 利用可能なコマンド
 
-![AIGNEエコシステムのアーキテクチャ](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
+DocSmithは一連のコマンドを通じて操作されます。以下の表は、主要なコマンドとその機能の概要です。
 
-## 次のステップ
+| コマンド | 説明 |
+| :--- | :--- |
+| `generate` | ソースファイルから新しいドキュメントセットを作成します。 |
+| `update` | コードの変更や新しいフィードバックに基づいて、既存のドキュメントを修正します。 |
+| `translate` | ドキュメントをサポートされている12言語のいずれか、または複数に翻訳します。 |
+| `publish` | ドキュメントをライブでアクセス可能なURLにデプロイします。 |
+| `evaluate` | 生成されたドキュメントの品質と完全性を評価します。 |
+| `history` | ドキュメントに行われた更新の履歴を表示します。 |
+| `chat` | ドキュメント作成タスクを支援するための対話型チャットセッションを開始します。 |
+| `clear` | 生成されたファイル、設定、およびキャッシュデータを削除します。 |
+| `prefs` | ドキュメント生成のために保存された設定や構成を管理します。 |
 
-DocSmithの使用を開始するには、インストールおよび設定ガイドに進んでください。
+---
 
-<x-card data-title="次へ：はじめに" data-href="/getting-started" data-icon="lucide:arrow-right-circle" data-cta="ガイドを開始">
-ステップバイステップのガイドに従って、ツールをインストールし、最初のプロジェクトを設定し、ドキュメントを生成します。
-</x-card>
+この概要では、AIGNE DocSmithの目的と機能の全体像を説明しました。ツールの使用を開始するには、[はじめに](./getting-started.md)ガイドに進み、インストールとセットアップの手順を確認してください。

package/docs/overview.md

@@ -1,82 +1,61 @@
 # Overview
 
-AIGNE DocSmith is an AI-driven tool that generates documentation directly from your source code. Built on the [AIGNE Framework](https://www.aigne.io/en/framework), it automates the creation of structured, multi-language documents. This process reduces the manual effort of writing and maintaining documentation, ensuring it stays synchronized with the 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 and is designed to produce structured, multi-language documents that accurately reflect your codebase.
 
-The following diagram illustrates the high-level workflow of DocSmith:
+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.
 
-```d2
-direction: right
-style: {
-  font-size: 14
-}
+## How It Works
 
-# Actors
-source_code: "Source Code Repository" {
-  shape: cloud
-  style: {
-    fill: "#F0F4F8"
-    stroke: "#4A5568"
-  }
-}
+DocSmith operates by analyzing your project's source code to understand its structure, components, and functionality. Based on this analysis, it generates a complete documentation set, from high-level guides to detailed API references.
 
-docsmith: "AIGNE DocSmith Engine" {
-  shape: hexagon
-  style: {
-    fill: "#E6FFFA"
-    stroke: "#2C7A7B"
-  }
+```d2
+direction: down
+
+Source-Code: {
+  label: "Project Source Code"
+  shape: rectangle
 }
 
-published_docs: "Published Documentation" {
-  shape: document
-  style: {
-    fill: "#FEFCBF"
-    stroke: "#B7791F"
-  }
+DocSmith: {
+  label: "AIGNE DocSmith\n(AI Analysis Engine)"
+  shape: rectangle
 }
 
-# Main Flow
-source_code -> docsmith: "1. Analyze Code"
-docsmith -> published_docs: "2. Generate & Publish"
-
-# DocSmith Internal Process
-subflow: {
-  direction: down
-  
-  analyze: "Analyze & Plan Structure"
-  generate: "Generate Content"
-  translate: "Translate (Optional)"
-  publish: "Publish"
-  
-  analyze -> generate -> translate -> publish
+Docs: {
+  label: "Generated Documentation"
+  shape: rectangle
 }
 
-docsmith.subflow: subflow
+Source-Code -> DocSmith: "Analyzes"
+DocSmith -> Docs: "Generates"
 ```
 
 ## Core Features
 
-DocSmith provides a set of features to automate and simplify the documentation process:
-
-*   **Structure Planning:** Analyzes a codebase to generate a logical documentation structure.
-*   **Content Generation:** Populates the planned documentation structure with content generated from the source code.
-*   **Multi-Language Support:** Translates documentation into 12 languages, including English, Chinese, and Spanish.
-*   **AIGNE Hub Integration:** Uses [AIGNE Hub](https://www.aigne.io/en/hub), a service that provides access to various Large Language Models (LLMs) like those from Google, OpenAI, and Anthropic, allowing model switching without managing individual API keys.
-*   **One-Click Publishing:** Makes your documentation live with shareable links. You can publish to the official platform or run your own instance using [Discuss Kit](https://www.web3kit.rocks/discuss-kit).
-*   **Iterative Updates:** Detects source code changes to update documentation and supports targeted regeneration of specific documents based on user feedback.
-
-## Part of the AIGNE Ecosystem
+DocSmith provides a set of features to handle the documentation lifecycle from creation to publication.
 
-DocSmith is a component of the [AIGNE](https://www.aigne.io) ecosystem, a platform for developing AI applications. It integrates with other AIGNE components to use the platform's AI capabilities and infrastructure.
+*   **AI-Powered Generation**: Analyzes your codebase to propose a logical documentation structure and generates content that explains your code's functionality.
+*   **Multi-Language Support**: Translates documentation into 12 languages, including English, Chinese (Simplified), and Japanese. The translation process is context-aware to maintain technical accuracy.
+*   **Integration with LLMs**: Connects with various Large Language Models (LLMs). By default, it uses [AIGNE Hub](https://www.aigne.io/en/hub), a service that allows you to switch between models like Google Gemini and OpenAI GPT without needing separate API keys. You can also configure your own API keys for direct provider access.
+*   **Smart Updates**: Detects changes in your source code and updates the corresponding sections of your documentation. You can also provide specific feedback to refine generated content.
+*   **Publishing Options**: Publish your generated documentation with a single command. You can deploy to the official DocSmith platform or to your own instance of [Discuss Kit](https://www.web3kit.rocks/discuss-kit). Discuss Kit is a service for hosting and displaying documentation.
 
-The following diagram shows how DocSmith fits within the AIGNE architecture:
+## Available Commands
 
-![AIGNE Ecosystem Architecture](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
+DocSmith is operated through a set of commands. The following table provides a summary of the main commands and their functions.
 
-## Next Steps
+| Command | Description |
+| :--- | :--- |
+| `generate` | Creates a new set of documentation from your source files. |
+| `update` | Modifies existing documents based on code changes or new feedback. |
+| `translate` | Translates documents into one or more of the 12 supported languages. |
+| `publish` | Deploys your documentation to a live, accessible URL. |
+| `evaluate` | Assesses the quality and completeness of your generated documentation. |
+| `history` | Views the history of updates made to your documentation. |
+| `chat` | Starts an interactive chat session to assist with documentation tasks. |
+| `clear` | Removes generated files, configurations, and cached data. |
+| `prefs` | Manages saved preferences and configurations for documentation generation. |
 
-To begin using DocSmith, proceed to the installation and configuration guide.
+---
 
-<x-card data-title="Next: Getting Started" data-href="/getting-started" data-icon="lucide:arrow-right-circle" data-cta="Start the guide">
-Follow the step-by-step guide to install the tool, configure your first project, and generate documentation.
-</x-card>
+This overview provides a high-level summary of AIGNE DocSmith's purpose and capabilities. To begin using the tool, proceed to the [Getting Started](./getting-started.md) guide for installation and setup instructions.