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

package/docs/guides-translating-documentation.md

@@ -1,100 +0,0 @@
-# Translating Documentation
-
-This guide provides instructions on how to translate your generated documentation into multiple languages using the `aigne doc translate` command. The process uses AI to ensure translations are contextually aware and maintain technical accuracy.
-
-The tool supports 12 languages, such as Chinese, Japanese, and German, allowing you to make your documentation accessible to a global audience. The primary language of your source documents is automatically excluded from the list of available translation languages.
-
-## The `translate` Command
-
-The `aigne doc translate` command generates translations for your existing documentation files. You can run it in an interactive mode for a step-by-step process or specify options directly on the command line for faster, automated workflows.
-
-### Interactive Mode
-
-For a guided experience, run the command without any arguments. This is the recommended approach for new users.
-
-```bash
-aigne doc translate
-```
-
-When you run this command, the tool will guide you through the following steps:
-
-1.  **Select Documents:** You will be prompted to choose the specific documents you wish to translate from a list of all available files in your project.
-
-    ![Select documents to translate](../assets/screenshots/doc-translate.png)
-
-2.  **Select Languages:** Next, you will be asked to select the target languages for translation. Any languages you have used before will be pre-selected to save time.
-
-    ![Select languages for translation](../assets/screenshots/doc-translate-langs.png)
-
-3.  **Process and Save:** The tool begins the translation process. Once complete, the translated files are saved in the same directory as the original files. The new files are named by adding a language code to the original filename. For example, a Chinese translation of `overview.md` will be saved as `overview.zh.md`.
-
-### Command-Line Options
-
-For non-interactive use or scripting, you can use command-line flags to control the translation process. This method is efficient when you already know which files and languages you need.
-
-<x-field-group>
-  <x-field data-name="--docs" data-type="array<string>">
-    <x-field-desc markdown>Specify one or more document paths to translate. If this flag is not used, the tool will start in interactive mode to let you select from a list of available documents.</x-field-desc>
-  </x-field>
-  <x-field data-name="--langs" data-type="array<string>">
-    <x-field-desc markdown>Specify one or more target language codes (e.g., `zh`, `ja`, `de`). If omitted, you will be prompted to select languages interactively.</x-field-desc>
-  </x-field>
-  <x-field data-name="--glossary" data-type="string">
-    <x-field-desc markdown>Provide a path to a glossary file (e.g., `@path/to/glossary.md`). This ensures that specific technical terms, brand names, or acronyms are translated consistently across all documents.</x-field-desc>
-  </x-field>
-  <x-field data-name="--feedback" data-type="string">
-    <x-field-desc markdown>Provide specific instructions to guide the AI's translation style. For example, you can ask for a more formal tone or specify how to handle certain phrases.</x-field-desc>
-  </x-field>
-</x-field-group>
-
-### Usage Examples
-
-#### 1. Translate Specific Documents into Multiple Languages
-
-To translate `overview.md` and `examples.md` into Chinese (`zh`) and Japanese (`ja`) without any interactive prompts, run the following command:
-
-```bash
-aigne doc translate --docs overview.md --docs examples.md --langs zh --langs ja
-```
-
-#### 2. Use a Glossary for Consistent Terminology
-
-If your documentation contains specialized vocabulary or brand names, you can use a glossary file to ensure they are always translated correctly.
-
-```bash
-aigne doc translate --glossary @./project-glossary.md
-```
-
-#### 3. Provide Feedback to Refine Translation Style
-
-You can guide the translation style by providing feedback. For instance, to request a more formal and technical tone for the output:
-
-```bash
-aigne doc translate --feedback "Use a formal, technical tone for all translations."
-```
-
-This feedback is recorded in the document's update history, which can be useful for tracking changes.
-
-## Supported Languages
-
-The tool provides translation support for 12 languages. The native language of the documentation is English (`en`).
-
-| Language              | Code    |
-| --------------------- | ------- |
-| Chinese (Simplified)  | `zh`    |
-| Chinese (Traditional) | `zh-TW` |
-| Japanese              | `ja`    |
-| Korean                | `ko`    |
-| Spanish               | `es`    |
-| French                | `fr`    |
-| German                | `de`    |
-| Portuguese            | `pt`    |
-| Russian               | `ru`    |
-| Italian               | `it`    |
-| Arabic                | `ar`    |
-
-## Summary
-
-The `translate` command offers a structured and reliable method for localizing your documentation. You can use its interactive mode for a guided process or its command-line options for efficient, automated workflows. Features like glossaries and feedback help maintain the quality and consistency of the translated content.
-
-After translating your documents, the next step is to make them available to your users. For instructions on how to do this, see the [Publishing Your Docs](./guides-publishing-your-docs.md) guide.

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

@@ -1,95 +0,0 @@
-# 翻譯文件
-
-本指南說明如何使用 `aigne doc translate` 指令將您產生的文件翻譯成多種語言。此過程使用 AI 來確保翻譯具有情境感知能力並保持技術準確性。
-
-該工具支援 12 種語言，讓您能夠觸及全球受眾。您的來源文件的主要語言將自動從可用的翻譯語言清單中排除。
-
-## `translate` 指令
-
-`aigne doc translate` 指令用於為您現有的文件檔案產生翻譯。您可以以互動模式執行它來選擇您想要的文件和語言，或者您也可以使用命令列旗標直接指定這些選項以實現自動化工作流程。
-
-### 互動模式
-
-若要獲得引導式體驗，請在不帶任何參數的情況下執行此指令：
-
-```bash
-aigne doc translate
-```
-
-執行時，該工具將執行以下步驟：
-1.  掃描現有文件。
-2.  提示您從清單中選擇您希望翻譯的特定文件。
-3.  提示您選擇目標翻譯語言。為方便起見，先前選擇的語言將被預先勾選。
-4.  為每個選定的文件和語言組合開始翻譯過程。
-5.  將翻譯後的文件儲存在同一個目錄中。新檔案的命名方式是在原始檔名後附加語言代碼（例如，`overview.md` 的中文翻譯會變成 `overview.zh.md`）。
-
-### 命令列選項
-
-對於非互動式使用或腳本編寫，您可以使用以下命令列旗標來控制翻譯過程。
-
-<x-field-group>
-  <x-field data-name="--docs" data-type="array<string>">
-    <x-field-desc markdown>指定一個或多個要翻譯的文件路徑。若未提供，該工具將進入互動模式，讓您從可用文件清單中進行選擇。</x-field-desc>
-  </x-field>
-  <x-field data-name="--langs" data-type="array<string>">
-    <x-field-desc markdown>指定一個或多個目標語言代碼（例如 `zh`、`ja`）。若省略，系統將提示您以互動方式選擇語言。</x-field-desc>
-  </x-field>
-  <x-field data-name="--glossary" data-type="string">
-    <x-field-desc markdown>提供詞彙表檔案的路徑（例如 `@path/to/glossary.md`）。這能確保特定的技術術語在所有文件中得到一致的翻譯。</x-field-desc>
-  </x-field>
-  <x-field data-name="--feedback" data-type="string">
-    <x-field-desc markdown>提供具體的指示或回饋來引導 AI 的翻譯風格，例如調整語氣或術語。</x-field-desc>
-  </x-field>
-</x-field-group>
-
-### 使用範例
-
-#### 1. 將特定文件翻譯成多種語言
-
-若要將 `overview.md` 和 `examples.md` 翻譯成中文（`zh`）和日文（`ja`）且不使用互動式提示：
-
-```bash
-aigne doc translate --docs overview.md --docs examples.md --langs zh --langs ja
-```
-
-#### 2. 使用詞彙表以確保術語一致
-
-為確保技術術語翻譯正確，請提供一個詞彙表檔案。這對於保持品牌名稱或專業詞彙的一致性很有用。
-
-```bash
-aigne doc translate --glossary @./glossary.md
-```
-
-#### 3. 提供回饋以完善翻譯風格
-
-您可以透過提供回饋來引導翻譯風格。例如，若要請求更正式的語氣：
-
-```bash
-aigne doc translate --feedback "Use a formal, technical tone for all translations."
-```
-
-此回饋將記錄在更新後文件的歷史記錄中。
-
-## 支援的語言
-
-該工具支援 12 種語言的翻譯。文件的原生語言是英文（`en`）。
-
-| 語言 | 代碼 |
-| :--- | :--- |
-| 簡體中文 | `zh` |
-| 繁體中文| `zh-TW`|
-| 日文 | `ja` |
-| 韓文 | `ko` |
-| 西班牙文 | `es` |
-| 法文 | `fr` |
-| 德文 | `de` |
-| 葡萄牙文 | `pt` |
-| 俄文 | `ru` |
-| 義大利文 | `it` |
-| 阿拉伯文 | `ar` |
-
-## 總結
-
-`translate` 指令提供了一種結構化的方法來本地化您的文件。您可以使用其互動模式進行引導式翻譯，或使用命令列選項進行自動化工作流程。使用詞彙表和回饋等功能有助於保持翻譯內容的品質和一致性。
-
-翻譯完文件後，您可以繼續進行[發佈您的文件](./guides-publishing-your-docs.md)。

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

@@ -1,95 +0,0 @@
-# 翻译文档
-
-本指南介绍如何使用 `aigne doc translate` 命令将您生成的文档翻译成多种语言。该过程利用 AI 来确保翻译能够感知上下文并保持技术准确性。
-
-该工具支持 12 种语言，让您的内容能够触达全球受众。您源文档的主要语言将自动从可用翻译语言列表中排除。
-
-## `translate` 命令
-
-`aigne doc translate` 命令用于为现有文档文件生成翻译。您可以以交互方式运行它来选择要翻译的文档和语言，也可以直接使用命令行标志指定这些选项以实现自动化工作流程。
-
-### 交互模式
-
-如需引导式体验，请不带任何参数运行该命令：
-
-```bash
-aigne doc translate
-```
-
-执行后，该工具将执行以下步骤：
-1.  扫描现有文档。
-2.  提示您从列表中选择要翻译的具体文档。
-3.  提示您选择目标翻译语言。为方便起见，先前选择的语言将被预先勾选。
-4.  为每个选定的文档和语言对开始翻译过程。
-5.  将翻译后的文件保存在同一目录中。新文件通过在原始文件名后附加语言代码来命名（例如，`overview.md` 的中文翻译将变为 `overview.zh.md`）。
-
-### 命令行选项
-
-对于非交互式使用或脚本编写，您可以使用以下命令行标志来控制翻译过程。
-
-<x-field-group>
-  <x-field data-name="--docs" data-type="array<string>">
-    <x-field-desc markdown>指定要翻译的一个或多个文档路径。如果未提供，该工具将进入交互模式，让您从可用文档列表中进行选择。</x-field-desc>
-  </x-field>
-  <x-field data-name="--langs" data-type="array<string>">
-    <x-field-desc markdown>指定一个或多个目标语言代码（例如 `zh`、`ja`）。如果省略，系统将提示您以交互方式选择语言。</x-field-desc>
-  </x-field>
-  <x-field data-name="--glossary" data-type="string">
-    <x-field-desc markdown>提供词汇表文件的路径（例如 `@path/to/glossary.md`）。这可以确保特定技术术语在所有文档中得到一致的翻译。</x-field-desc>
-  </x-field>
-  <x-field data-name="--feedback" data-type="string">
-    <x-field-desc markdown>提供具体说明或反馈以指导 AI 的翻译风格，例如调整语气或术语。</x-field-desc>
-  </x-field>
-</x-field-group>
-
-### 用法示例
-
-#### 1. 将特定文档翻译成多种语言
-
-要将 `overview.md` 和 `examples.md` 翻译成中文（`zh`）和日文（`ja`），且无需交互式提示：
-
-```bash
-aigne doc translate --docs overview.md --docs examples.md --langs zh --langs ja
-```
-
-#### 2. 使用词汇表确保术语一致
-
-为确保技术术语翻译正确，请提供词汇表文件。这对于保持品牌名称或专业词汇的一致性非常有用。
-
-```bash
-aigne doc translate --glossary @./glossary.md
-```
-
-#### 3. 提供反馈以优化翻译风格
-
-您可以通过提供反馈来指导翻译风格。例如，要求使用更正式的语气：
-
-```bash
-aigne doc translate --feedback "Use a formal, technical tone for all translations."
-```
-
-此反馈将被记录在更新后文档的历史记录中。
-
-## 支持的语言
-
-该工具支持 12 种语言的翻译。文档的母语是英语（`en`）。
-
-| 语言 | 代码 |
-| :--- | :--- |
-| 中文（简体） | `zh` |
-| 中文（繁体）| `zh-TW`|
-| 日语 | `ja` |
-| 韩语 | `ko` |
-| 西班牙语 | `es` |
-| 法语 | `fr` |
-| 德语 | `de` |
-| 葡萄牙语 | `pt` |
-| 俄语 | `ru` |
-| 意大利语 | `it` |
-| 阿拉伯语 | `ar` |
-
-## 总结
-
-`translate` 命令为本地化文档提供了一种结构化方法。您可以使用其交互模式进行引导式翻译，或使用命令行选项实现自动化工作流程。使用词汇表和反馈等功能有助于保持翻译内容的质量和一致性。
-
-翻译完文档后，您可以继续[发布您的文档](./guides-publishing-your-docs.md)。

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

@@ -1,77 +0,0 @@
-# ドキュメントの更新
-
-ドキュメントの正確性と関連性を維持することは、継続的なプロセスです。コードベースが進化したり、新しいフィードバックを受け取ったりするにつれて、既存のドキュメントを修正する必要があります。`update` コマンドは、新しい指示で特定のドキュメントを再生成するための構造化された方法を提供し、ドキュメントを最新の状態に保ちます。
-
-このガイドでは、ドキュメントを更新するための2つの主要な方法について説明します。1つは、単一ドキュメントの詳細な改良を行うための対話モード、もう1つは、複数のドキュメントに一度に変更を適用するためのバッチモードです。
-
-## 2つの動作モード
-
-`update` コマンドは、選択したドキュメントの数と指定したオプションに応じて、2つのモードのいずれかで動作します。
-
-1.  **対話モード**: `--reset` フラグなしで単一のドキュメントを更新する際にトリガーされます。このモードは反復的な改良のために設計されており、フィードバックを提供し、変更を確認し、ドキュメントが基準を満たすまでプロセスを繰り返すことができます。
-2.  **バッチモード**: 複数のドキュメントを同時に更新する場合、または `--reset` フラグを使用する場合に使用されます。このモードは、1回の操作で選択したすべてのドキュメントにフィードバックを適用するため、広範な変更に効率的です。
-
-## 対話モード: 単一ドキュメントの改良
-
-対話モードは、単一のドキュメントに正確な変更を加えるための制御された環境を提供します。特定のフィードバックに基づいてコンテンツを慎重に確認し、調整する必要がある場合に最適な選択肢です。
-
-対話セッションを開始するには、`aigne doc update` コマンドを実行し、リストから単一のドキュメントを選択します。
-
-```bash
-aigne doc update
-```
-
-ツールは次の手順であなたをガイドします:
-
-1.  **ドキュメント分析**: システムはまず、選択されたドキュメントの構造的なアウトラインを表示し、その主要な見出しを示します。
-2.  **ユーザーアクション**: 次に、3つのアクションのうち1つを選択するよう求められます:
-    *   **ドキュメントの表示**: ドキュメントの現行バージョンの全内容をターミナルにレンダリングして表示し、読みやすくします。
-    *   **フィードバックの提供**: 修正リクエストを入力するよう求められます。これは、「エラー処理に関するセクションを追加してください」から「`config` オブジェクトの目的を明確にしてください」まで、何でもかまいません。
-    *   **完了**: 対話セッションを終了し、最後に生成されたバージョンのドキュメントを保存します。
-3.  **コンテンツの再生成**: フィードバックを送信すると、AIがあなたの指示に基づいてドキュメントのコンテンツを再生成します。その後、新しい見出し構造が表示されます。
-4.  **反復または終了**: 結果に満足するまで、表示、フィードバックの提供、再生成のループを続けることができます。「完了」を選択すると、プロセスは終了です。
-
-この反復的なサイクルにより、最終的な出力を微調整でき、更新されたドキュメントが正確かつ完全であることが保証されます。
-
-## バッチモード: 複数ドキュメントの更新
-
-バッチモードは、複数のドキュメントに同じ一般的なフィードバックを適用したり、それらを完全に再生成したりする必要がある場合に、効率性を考慮して設計されています。このモードは、複数のドキュメントを選択した場合、または `--docs` や `--reset` のようなコマンドラインフラグを使用した場合に自動的に有効になります。
-
-### 特定のフィードバックによる更新
-
-対話セッションに入ることなく、コマンドラインから直接フィードバックを提供して、1つまたは複数のドキュメントを更新できます。
-
-```bash title="フィードバック付きで単一ドキュメントを更新"
-aigne doc update --docs overview.md --feedback "Add a section explaining the authentication flow"
-```
-
-```bash title="複数のドキュメントを同じフィードバックで更新"
-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 overview.md --reset
-```
-
-## コマンドリファレンス
-
-`update` コマンドは、その動作を制御するためのいくつかのフラグを受け入れます。
-
-| パラメータ | 説明 | 例 |
-| :--- | :--- | :--- |
-| `--docs <path>` | 更新する1つまたは複数のドキュメントパスを指定します。複数回使用できます。 | `--docs overview.md --docs guides-generating-documentation.md` |
-| `--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.md

@@ -1,79 +0,0 @@
-# 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.
-
-For information on creating documents from scratch, please see the [Generating Documentation](./guides-generating-documentation.md) guide.
-
-## 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. The system automatically chooses the appropriate mode based on your command.
-
-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 Update a single document with feedback
-aigne doc update --docs /overview --feedback "Add a section explaining the authentication flow"
-```
-
-```bash Update multiple documents with the same feedback
-aigne doc update --docs /overview --docs /getting-started --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 Regenerate a specific document from scratch
-aigne doc update --docs /overview --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. This flag 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

@@ -1,77 +0,0 @@
-# 更新文件
-
-維護文件的準確性和相關性是一個持續的過程。隨著您的程式碼庫不斷演進或收到新的回饋，您將需要修改現有文件。`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 overview.md --feedback "Add a section explaining the authentication flow"
-```
-
-```bash title="使用相同的回饋更新多個文件"
-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 overview.md --reset
-```
-
-## 指令參考
-
-`update` 指令接受數個旗標來控制其行為。
-
-| 參數 | 說明 | 範例 |
-| :--- | :--- | :--- |
-| `--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` 指令提供了一個靈活的工作流程，讓您的文件與您的專案保持一致。對於單一文件，使用互動模式進行詳細、迭代的變更；對於多個檔案，使用批次模式有效率地應用廣泛的更新。
-
-有關相關任務，請參閱以下指南：
-- [生成文件](./guides-generating-documentation.md)
-- [翻譯文件](./guides-translating-documentation.md)

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

@@ -1,77 +0,0 @@
-# 更新文档
-
-维护文档的准确性和相关性是一个持续的过程。随着代码库的演进或收到新的反馈，您将需要修改现有文档。`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 overview.md --feedback "Add a section explaining the authentication flow"
-```
-
-```bash title="使用相同的反馈更新多个文档"
-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 overview.md --reset
-```
-
-## 命令参考
-
-`update` 命令接受几个标志来控制其行为。
-
-| Parameter | Description | Example |
-| :--- | :--- | :--- |
-| `--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` 命令提供了一个灵活的工作流，可让您的文档与项目保持一致。使用交互模式对单个文档进行详细的迭代更改，使用批处理模式高效地将广泛的更新应用于多个文件。
-
-有关相关任务，请参阅以下指南：
-- [生成文档](./guides-generating-documentation.md)
-- [翻译文档](./guides-translating-documentation.md)

package/docs/guides.ja.md

@@ -1,32 +0,0 @@
-# ガイド
-
-このセクションでは、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>