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

package/docs/configuration-preferences.md

@@ -1,144 +0,0 @@
-# Managing Preferences
-
-AIGNE DocSmith is designed to learn from your feedback. When you refine or correct generated content, DocSmith can convert that feedback into persistent rules, called preferences. These rules ensure that your specific style, structural requirements, and content policies are applied consistently in future documentation tasks. All preferences are stored in a human-readable YAML file located at `.aigne/doc-smith/preferences.yml` in your project root.
-
-## The Preference Lifecycle
-
-The following diagram illustrates how your feedback becomes a reusable rule that can be applied to future tasks and managed from the command line.
-
-```d2 The Preference Lifecycle
-direction: down
-
-developer: {
-  label: "Developer"
-  shape: person
-}
-
-docsmith_system: {
-  label: "AIGNE DocSmith System"
-  shape: rectangle
-
-  cli: {
-    label: "CLI Command\n(refine / translate)"
-    shape: rectangle
-  }
-
-  agent: {
-    label: "Internal Analysis Agent"
-    shape: rectangle
-  }
-
-  decision: {
-    label: "Is feedback a\nreusable policy?"
-    shape: diamond
-  }
-
-  create_rule: {
-    label: "Create New Preference Rule"
-    shape: rectangle
-  }
-}
-
-preferences_file: {
-  label: ".aigne/doc-smith/preferences.yml"
-  shape: cylinder
-}
-
-one_time_fix: {
-  label: "Apply as a one-time fix"
-  shape: oval
-}
-
-developer -> docsmith_system.cli: "1. Provides feedback"
-docsmith_system.cli -> docsmith_system.agent: "2. Captures feedback"
-docsmith_system.agent -> docsmith_system.decision: "3. Analyzes"
-docsmith_system.decision -> docsmith_system.create_rule: "Yes"
-docsmith_system.create_rule -> preferences_file: "4. Saves rule to file"
-docsmith_system.decision -> one_time_fix: "No"
-```
-
-### How Preferences are Created
-
-When you provide feedback during the `refine` or `translate` stages, an internal agent analyzes your input. It determines if the feedback is a one-time fix (e.g., correcting a typo) or a reusable policy (e.g., "always write code comments in English"). If it represents a lasting instruction, it creates a new preference rule and saves it to your project's `preferences.yml` file.
-
-### Rule Properties
-
-Each rule saved in `preferences.yml` has the following structure:
-
-<x-field-group>
-  <x-field data-name="id" data-type="string" data-desc="A unique, randomly generated identifier for the rule (e.g., pref_a1b2c3d4e5f6g7h8)."></x-field>
-  <x-field data-name="active" data-type="boolean" data-desc="Indicates if the rule is currently enabled. Inactive rules are ignored during generation tasks."></x-field>
-  <x-field data-name="scope" data-type="string">
-    <x-field-desc markdown>Defines when the rule should be applied. Valid scopes are `global`, `structure`, `document`, or `translation`.</x-field-desc>
-  </x-field>
-  <x-field data-name="rule" data-type="string" data-desc="The specific, distilled instruction that will be passed to the AI in future tasks."></x-field>
-  <x-field data-name="feedback" data-type="string" data-desc="The original, natural language feedback provided by the user, preserved for reference."></x-field>
-  <x-field data-name="createdAt" data-type="string" data-desc="The ISO 8601 timestamp indicating when the rule was created."></x-field>
-  <x-field data-name="paths" data-type="string[]" data-required="false">
-    <x-field-desc markdown>An optional list of file paths. If present, the rule only applies to content generated for these specific source files.</x-field-desc>
-  </x-field>
-</x-field-group>
-
-## Managing Preferences with the CLI
-
-You can view and manage all your saved preferences using the `aigne doc prefs` command. This allows you to list, activate, deactivate, or permanently remove rules.
-
-### Listing All Preferences
-
-To see a complete list of all saved preferences, both active and inactive, use the `--list` flag.
-
-```bash List all preferences icon=lucide:terminal
-aigne doc prefs --list
-```
-
-The command displays a formatted list showing the status, scope, ID, and any path limitations for each rule.
-
-```text Example Output icon=lucide:clipboard-list
-# User Preferences
-
-**Format explanation:**
-- 🟢 = Active preference, ⚪ = Inactive preference
-- [scope] = Preference scope (global, structure, document, translation)
-- ID = Unique preference identifier
-- Paths = Specific file paths (if applicable)
-
-🟢 [structure] pref_a1b2c3d4e5f6g7h8 | Paths: overview.md
-   Add a 'Next Steps' section at the end of overview documents.
- 
-⚪ [document] pref_i9j0k1l2m3n4o5p6
-   Code comments must be written in English.
-```
-
-### Deactivating and Reactivating Preferences
-
-If you need to temporarily disable a rule without deleting it, you can toggle its active status with the `--toggle` flag. Running the command without an ID will launch an interactive mode, allowing you to select one or more preferences to toggle.
-
-```bash Toggle preferences interactively icon=lucide:terminal
-aigne doc prefs --toggle
-```
-
-To toggle a specific rule directly, provide its ID using the `--id` flag. This action changes the rule's `active` property.
-
-```bash Toggle a specific preference icon=lucide:terminal
-aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
-```
-
-### Removing Preferences
-
-To permanently delete one or more preferences, use the `--remove` flag. This action cannot be undone.
-
-For an interactive selection prompt, run the command without an ID.
-
-```bash Remove preferences interactively icon=lucide:terminal
-aigne doc prefs --remove
-```
-
-To remove a specific rule directly, provide its ID using the `--id` flag.
-
-```bash Remove a specific preference icon=lucide:terminal
-aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
-```
-
-## Next Steps
-
-Managing preferences is a key part of tailoring DocSmith to your project's specific needs. For more customization options, explore the main [Configuration Guide](./configuration.md).

package/docs/configuration-preferences.zh-TW.md

@@ -1,144 +0,0 @@
-# 管理偏好設定
-
-AIGNE DocSmith 的設計旨在從您的回饋中學習。當您優化或修正生成的內容時，DocSmith 可以將該回饋轉化為持久性規則，稱為偏好設定。這些規則確保您特定的風格、結構要求和內容策略在未來的文檔任務中得到一致應用。所有偏好設定都儲存在您專案根目錄下一個人類可讀的 YAML 檔案中，路徑為 `.aigne/doc-smith/preferences.yml`。
-
-## 偏好設定的生命週期
-
-下圖說明了您的回饋如何成為一個可重複使用的規則，該規則可應用於未來的任務，並可透過命令列進行管理。
-
-```d2 偏好設定的生命週期
-direction: down
-
-developer: {
-  label: "開發者"
-  shape: person
-}
-
-docsmith_system: {
-  label: "AIGNE DocSmith 系統"
-  shape: rectangle
-
-  cli: {
-    label: "CLI 指令\n(refine / translate)"
-    shape: rectangle
-  }
-
-  agent: {
-    label: "內部分析 Agent"
-    shape: rectangle
-  }
-
-  decision: {
-    label: "回饋是否為\n可重複使用的策略？"
-    shape: diamond
-  }
-
-  create_rule: {
-    label: "建立新的偏好設定規則"
-    shape: rectangle
-  }
-}
-
-preferences_file: {
-  label: ".aigne/doc-smith/preferences.yml"
-  shape: cylinder
-}
-
-one_time_fix: {
-  label: "作為一次性修復應用"
-  shape: oval
-}
-
-developer -> docsmith_system.cli: "1. 提供回饋"
-docsmith_system.cli -> docsmith_system.agent: "2. 捕捉回饋"
-docsmith_system.agent -> docsmith_system.decision: "3. 進行分析"
-docsmith_system.decision -> docsmith_system.create_rule: "是"
-docsmith_system.create_rule -> preferences_file: "4. 將規則儲存至檔案"
-docsmith_system.decision -> one_time_fix: "否"
-```
-
-### 如何建立偏好設定
-
-當您在 `refine` 或 `translate` 階段提供回饋時，一個內部 Agent 會分析您的輸入。它會判斷該回饋是一次性修復（例如，修正一個錯字）還是可重複使用的策略（例如，「程式碼註解必須以英文撰寫」）。如果它代表一個持久性的指令，它會建立一個新的偏好設定規則，並將其儲存到您專案的 `preferences.yml` 檔案中。
-
-### 規則屬性
-
-儲存在 `preferences.yml` 中的每個規則都具有以下結構：
-
-<x-field-group>
-  <x-field data-name="id" data-type="string" data-desc="規則的唯一隨機生成識別碼（例如：pref_a1b2c3d4e5f6g7h8）。"></x-field>
-  <x-field data-name="active" data-type="boolean" data-desc="表示規則目前是否啟用。未啟用的規則在生成任務期間會被忽略。"></x-field>
-  <x-field data-name="scope" data-type="string">
-    <x-field-desc markdown>定義規則應在何時應用。有效的範圍為 `global`、`structure`、`document` 或 `translation`。</x-field-desc>
-  </x-field>
-  <x-field data-name="rule" data-type="string" data-desc="在未來任務中將傳遞給 AI 的具體、精煉的指令。"></x-field>
-  <x-field data-name="feedback" data-type="string" data-desc="使用者提供的原始自然語言回饋，保留以供參考。"></x-field>
-  <x-field data-name="createdAt" data-type="string" data-desc="表示規則建立時間的 ISO 8601 時間戳記。"></x-field>
-  <x-field data-name="paths" data-type="string[]" data-required="false">
-    <x-field-desc markdown>可選的檔案路徑列表。如果存在，此規則僅適用於為這些特定來源檔案生成的內容。</x-field-desc>
-  </x-field>
-</x-field-group>
-
-## 使用 CLI 管理偏好設定
-
-您可以使用 `aigne doc prefs` 指令來檢視和管理所有已儲存的偏好設定。這讓您可以列出、啟用、停用或永久移除規則。
-
-### 列出所有偏好設定
-
-要查看所有已儲存偏好設定的完整列表（包括啟用和未啟用的），請使用 `--list` 標記。
-
-```bash 列出所有偏好設定 icon=lucide:terminal
-aigne doc prefs --list
-```
-
-該指令會顯示一個格式化的列表，顯示每個規則的狀態、範圍、ID 以及任何路徑限制。
-
-```text 輸出範例 icon=lucide:clipboard-list
-# 使用者偏好設定
-
-**格式說明：**
-- 🟢 = 啟用中的偏好設定，⚪ = 未啟用的偏好設定
-- [scope] = 偏好設定範圍 (global, structure, document, translation)
-- ID = 唯一偏好設定識別碼
-- Paths = 特定檔案路徑（如果適用）
-
-🟢 [structure] pref_a1b2c3d4e5f6g7h8 | Paths: overview.md
-   在概覽文件的末尾新增一個「後續步驟」部分。
- 
-⚪ [document] pref_i9j0k1l2m3n4o5p6
-   程式碼註解必須以英文撰寫。
-```
-
-### 停用與重新啟用偏好設定
-
-如果您需要暫時停用一個規則而不刪除它，您可以使用 `--toggle` 標記來切換其啟用狀態。若執行指令時不帶 ID，將會啟動互動模式，讓您選擇一個或多個偏好設定進行切換。
-
-```bash 以互動模式切換偏好設定 icon=lucide:terminal
-aigne doc prefs --toggle
-```
-
-要直接切換特定規則，請使用 `--id` 標記提供其 ID。此操作會更改規則的 `active` 屬性。
-
-```bash 切換特定偏好設定 icon=lucide:terminal
-aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
-```
-
-### 移除偏好設定
-
-要永久刪除一個或多個偏好設定，請使用 `--remove` 標記。此操作無法復原。
-
-若要進入互動式選擇提示，請在不帶 ID 的情況下執行該指令。
-
-```bash 以互動模式移除偏好設定 icon=lucide:terminal
-aigne doc prefs --remove
-```
-
-要直接移除特定規則，請使用 `--id` 標記提供其 ID。
-
-```bash 移除特定偏好設定 icon=lucide:terminal
-aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
-```
-
-## 後續步驟
-
-管理偏好設定是根據您專案的特定需求量身打造 DocSmith 的關鍵部分。如需更多自訂選項，請探索主要的[設定指南](./configuration.md)。

package/docs/configuration-preferences.zh.md

@@ -1,144 +0,0 @@
-# 管理偏好设置
-
-AIGNE DocSmith 旨在从您的反馈中学习。当您优化或纠正生成的内容时，DocSmith 可以将该反馈转换为持久性规则，称为偏好设置。这些规则确保您特定的风格、结构要求和内容策略在未来的文档任务中得到一致的应用。所有偏好设置都存储在位于您项目根目录下的一个人类可读的 YAML 文件中：`.aigne/doc-smith/preferences.yml`。
-
-## 偏好设置的生命周期
-
-下图说明了您的反馈如何成为一个可重用的规则，该规则可以应用于未来的任务并通过命令行进行管理。
-
-```d2 偏好设置的生命周期
-direction: down
-
-developer: {
-  label: "开发者"
-  shape: person
-}
-
-docsmith_system: {
-  label: "AIGNE DocSmith 系统"
-  shape: rectangle
-
-  cli: {
-    label: "CLI 命令\n(refine / translate)"
-    shape: rectangle
-  }
-
-  agent: {
-    label: "内部分析 Agent"
-    shape: rectangle
-  }
-
-  decision: {
-    label: "反馈是否为\n可重用策略？"
-    shape: diamond
-  }
-
-  create_rule: {
-    label: "创建新偏好规则"
-    shape: rectangle
-  }
-}
-
-preferences_file: {
-  label: ".aigne/doc-smith/preferences.yml"
-  shape: cylinder
-}
-
-one_time_fix: {
-  label: "作为一次性修复应用"
-  shape: oval
-}
-
-developer -> docsmith_system.cli: "1. 提供反馈"
-docsmith_system.cli -> docsmith_system.agent: "2. 捕获反馈"
-docsmith_system.agent -> docsmith_system.decision: "3. 分析"
-docsmith_system.decision -> docsmith_system.create_rule: "是"
-docsmith_system.create_rule -> preferences_file: "4. 将规则保存到文件"
-docsmith_system.decision -> one_time_fix: "否"
-```
-
-### 如何创建偏好设置
-
-当您在 `refine` 或 `translate` 阶段提供反馈时，一个内部 Agent 会分析您的输入。它会判断该反馈是一次性修复（例如，纠正拼写错误）还是可重用策略（例如，“代码注释必须用英文编写”）。如果它代表一个持久性指令，Agent 就会创建一条新的偏好规则并将其保存到您项目的 `preferences.yml` 文件中。
-
-### 规则属性
-
-保存在 `preferences.yml` 中的每条规则都具有以下结构：
-
-<x-field-group>
-  <x-field data-name="id" data-type="string" data-desc="规则的唯一、随机生成的标识符（例如，pref_a1b2c3d4e5f6g7h8）。"></x-field>
-  <x-field data-name="active" data-type="boolean" data-desc="指示规则当前是否已启用。未激活的规则在生成任务期间将被忽略。"></x-field>
-  <x-field data-name="scope" data-type="string">
-    <x-field-desc markdown>定义规则何时应用。有效范围是 `global`、`structure`、`document` 或 `translation`。</x-field-desc>
-  </x-field>
-  <x-field data-name="rule" data-type="string" data-desc="将在未来任务中传递给 AI 的具体、提炼后的指令。"></x-field>
-  <x-field data-name="feedback" data-type="string" data-desc="用户提供的原始自然语言反馈，保留以供参考。"></x-field>
-  <x-field data-name="createdAt" data-type="string" data-desc="指示规则创建时间的 ISO 8601 时间戳。"></x-field>
-  <x-field data-name="paths" data-type="string[]" data-required="false">
-    <x-field-desc markdown>一个可选的文件路径列表。如果存在，该规则仅适用于为这些特定源文件生成的内容。</x-field-desc>
-  </x-field>
-</x-field-group>
-
-## 使用 CLI 管理偏好设置
-
-您可以使用 `aigne doc prefs` 命令查看和管理所有已保存的偏好设置。这允许您列出、激活、停用或永久删除规则。
-
-### 列出所有偏好设置
-
-要查看所有已保存的偏好设置（包括激活和未激活的）的完整列表，请使用 `--list` 标志。
-
-```bash 列出所有偏好设置 icon=lucide:terminal
-aigne doc prefs --list
-```
-
-该命令会显示一个格式化的列表，其中显示了每条规则的状态、范围、ID 以及任何路径限制。
-
-```text 输出示例 icon=lucide:clipboard-list
-# 用户偏好设置
-
-**格式说明：**
-- 🟢 = 激活的偏好设置, ⚪ = 未激活的偏好设置
-- [scope] = 偏好范围 (global, structure, document, translation)
-- ID = 唯一偏好标识符
-- Paths = 特定文件路径 (如果适用)
-
-🟢 [structure] pref_a1b2c3d4e5f6g7h8 | Paths: overview.md
-   在概览文档末尾添加一个“后续步骤”部分。
- 
-⚪ [document] pref_i9j0k1l2m3n4o5p6
-   代码注释必须用英文编写。
-```
-
-### 停用和重新激活偏好设置
-
-如果您需要暂时禁用某条规则而不删除它，可以使用 `--toggle` 标志切换其激活状态。在不带 ID 的情况下运行该命令将启动交互模式，允许您选择一个或多个偏好设置进行切换。
-
-```bash 以交互方式切换偏好设置 icon=lucide:terminal
-aigne doc prefs --toggle
-```
-
-要直接切换特定规则，请使用 `--id` 标志提供其 ID。此操作会更改规则的 `active` 属性。
-
-```bash 切换特定偏好设置 icon=lucide:terminal
-aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
-```
-
-### 删除偏好设置
-
-要永久删除一个或多个偏好设置，请使用 `--remove` 标志。此操作无法撤销。
-
-要获得交互式选择提示，请在不带 ID 的情况下运行该命令。
-
-```bash 以交互方式删除偏好设置 icon=lucide:terminal
-aigne doc prefs --remove
-```
-
-要直接删除特定规则，请使用 `--id` 标志提供其 ID。
-
-```bash 删除特定偏好设置 icon=lucide:terminal
-aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
-```
-
-## 后续步骤
-
-管理偏好设置是根据项目特定需求定制 DocSmith 的关键部分。有关更多自定义选项，请浏览主要的[配置指南](./configuration.md)。

package/docs/features-generate-documentation.ja.md

@@ -1,95 +0,0 @@
-# ドキュメントの生成
-
-`aigne doc generate` コマンドは、ソースコードから完全なドキュメントセットを作成するための主要な機能です。このコマンドは、コードベースを分析し、論理的なドキュメント構造を計画し、各セクションのコンテンツを生成するプロセスを開始します。これは、初期状態からドキュメントを作成するための標準的な方法です。
-
-## 最初の生成
-
-まず、プロジェクトのルートディレクトリに移動し、次のコマンドを実行します。
-
-```bash aigne doc generate icon=lucide:play-circle
-aigne doc generate
-```
-
-### 自動設定
-
-プロジェクトでこのコマンドを初めて実行する場合、DocSmith は設定が存在しないことを検出します。その後、対話式のセットアップウィザードが自動的に起動し、必要な設定手順を案内します。このプロセスにより、生成が開始される前に有効な設定が確実に配置されます。
-
-![generate コマンドの実行、初期化のスマートな実行](../assets/screenshots/doc-generate.png)
-
-ドキュメントの主要な側面を定義するための一連の質問に答えるよう求められます。これには以下が含まれます。
-
-*   ドキュメント生成ルールとスタイル
-*   対象読者
-*   主要言語と追加の翻訳言語
-*   ソースコードの入力パスとドキュメントの出力パス
-
-![質問に答えてプロジェクトのセットアップを完了](../assets/screenshots/doc-complete-setup.png)
-
-設定が完了すると、DocSmith はドキュメントの生成に進みます。
-
-![構造計画の実行とドキュメントの生成](../assets/screenshots/doc-generate-docs.png)
-
-正常に完了すると、新しく作成されたドキュメントは、セットアップ中に指定された出力ディレクトリで利用可能になります。
-
-![ドキュメントが正常に生成されました](../assets/screenshots/doc-generated-successfully.png)
-
-## 生成プロセス
-
-`generate` コマンドは、自動化されたマルチステップのワークフローを実行します。プロセスは以下の通りです。
-
-```d2
-direction: down
-
-User: {
-  shape: c4-person
-}
-
-AIGNE-CLI: {
-  label: "AIGNE CLI"
-
-  config-check: {
-    label: "設定ファイルは存在しますか？"
-    shape: diamond
-  }
-
-  interactive-setup: {
-    label: "対話式セットアップウィザード"
-  }
-
-  generation-process: {
-    label: "3. 生成プロセス"
-
-    analyze-code: "コードの分析"
-    plan-structure: "構造の計画"
-    generate-content: "コンテンツの生成"
-
-    analyze-code -> plan-structure -> generate-content
-  }
-
-  output: {
-    label: "出力ディレクトリ"
-  }
-}
-
-User -> AIGNE-CLI.config-check: "'aigne doc generate'"
-AIGNE-CLI.config-check -> AIGNE-CLI.interactive-setup: "[いいえ] 2. セットアップの開始"
-AIGNE-CLI.interactive-setup -> AIGNE-CLI.generation-process: "設定ファイルの作成"
-AIGNE-CLI.config-check -> AIGNE-CLI.generation-process: "[はい]"
-AIGNE-CLI.generation-process -> AIGNE-CLI.output: "4. ドキュメントの書き込み"
-```
-
-## コマンドオプション
-
-デフォルトの `generate` コマンドは、ほとんどのユースケースで十分です。しかし、その動作を変更するためのいくつかのオプションが利用可能で、完全な再生成を強制したり、ドキュメント構造を洗練させたりするのに役立ちます。
-
-| オプション          | 説明                                                                                                                                           | 例                                                     |
-| :------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------- |
-| `--forceRegenerate` | 既存のドキュメントをすべて削除し、最初から再生成します。ソースコードや設定に大幅な変更を加えた後に使用してください。                                       | `aigne doc generate --forceRegenerate`                   |
-| `--feedback`        | セクションの追加、削除、再編成など、ドキュメント全体の構造を洗練させるための大まかなフィードバックを提供します。                                           | `aigne doc generate --feedback "APIリファレンスを追加"`   |
-| `--model`           | コンテンツ生成に使用するAIGNE Hubの特定の大規模言語モデルを指定し、異なるモデルを切り替えることができます。                                                  | `aigne doc generate --model openai:gpt-4o`               |
-
-## 次のステップ
-
-最初のドキュメントを生成した後も、プロジェクトは進化し続けます。ドキュメントをコードと同期させるためには、更新を行う必要があります。次のセクションでは、新しい要件やコードの変更に基づいて、対象を絞った変更を行い、特定のファイルを再生成する方法について説明します。
-
-<x-card data-title="更新と改良" data-icon="lucide:file-edit" data-href="/features/update-and-refine">コードが変更された際のドキュメントの更新方法や、フィードバックを用いた特定の改善方法について学びます。</x-card>

package/docs/features-generate-documentation.md

@@ -1,95 +0,0 @@
-# Generate Documentation
-
-The `aigne doc generate` command is the primary function for creating a complete documentation set from your source code. This command initiates a process that analyzes your codebase, plans a logical documentation structure, and then generates content for each section. It is the standard method for creating your documentation from an initial state.
-
-## Your First Generation
-
-To begin, navigate to your project's root directory and run the following command:
-
-```bash aigne doc generate icon=lucide:play-circle
-aigne doc generate
-```
-
-### Automatic Configuration
-
-If you are running this command for the first time in a project, DocSmith will detect that no configuration exists. It will then automatically launch an interactive setup wizard to guide you through the required setup steps. This process ensures a valid configuration is in place before generation begins.
-
-![Running generate command, smart execution of initialization](../assets/screenshots/doc-generate.png)
-
-You will be prompted to answer a series of questions to define key aspects of your documentation, including:
-
-*   Document generation rules and style
-*   The target audience
-*   Primary language and any additional translation languages
-*   Source code input and documentation output paths
-
-![Answer questions to complete project setup](../assets/screenshots/doc-complete-setup.png)
-
-After the configuration is complete, DocSmith proceeds with the documentation generation.
-
-![Executing structure planning and generating documents](../assets/screenshots/doc-generate-docs.png)
-
-Upon successful completion, the newly created documentation will be available in the output directory specified during setup.
-
-![Documentation generated successfully](../assets/screenshots/doc-generated-successfully.png)
-
-## The Generation Process
-
-The `generate` command executes an automated, multi-step workflow. The process is outlined below:
-
-```d2
-direction: down
-
-User: {
-  shape: c4-person
-}
-
-AIGNE-CLI: {
-  label: "AIGNE CLI"
-
-  config-check: {
-    label: "Config file exists?"
-    shape: diamond
-  }
-
-  interactive-setup: {
-    label: "Interactive Setup Wizard"
-  }
-
-  generation-process: {
-    label: "3. Generation Process"
-
-    analyze-code: "Analyze Code"
-    plan-structure: "Plan Structure"
-    generate-content: "Generate Content"
-
-    analyze-code -> plan-structure -> generate-content
-  }
-
-  output: {
-    label: "Output Directory"
-  }
-}
-
-User -> AIGNE-CLI.config-check: "'aigne doc generate'"
-AIGNE-CLI.config-check -> AIGNE-CLI.interactive-setup: "[No] 2. Launch setup"
-AIGNE-CLI.interactive-setup -> AIGNE-CLI.generation-process: "Create config file"
-AIGNE-CLI.config-check -> AIGNE-CLI.generation-process: "[Yes]"
-AIGNE-CLI.generation-process -> AIGNE-CLI.output: "4. Write documentation"
-```
-
-## Command Options
-
-The default `generate` command is sufficient for most use cases. However, several options are available to modify its behavior, which can be useful for forcing a full regeneration or refining the documentation structure.
-
-| Option              | Description                                                                                                                                    | Example                                                  |
-| :------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------- |
-| `--forceRegenerate` | Deletes all existing documents and regenerates them from scratch. Use this after making significant changes to your source code or configuration. | `aigne doc generate --forceRegenerate`                   |
-| `--feedback`        | Provides high-level feedback to refine the overall documentation structure, such as adding, removing, or reorganizing sections.                | `aigne doc generate --feedback "Add an API Reference"`   |
-| `--model`           | Specifies a particular Large Language Model from AIGNE Hub to use for content generation, allowing you to switch between different models.       | `aigne doc generate --model openai:gpt-4o`               |
-
-## What's Next?
-
-After generating the initial documentation, your project will continue to evolve. To keep your documents synchronized with your code, you will need to perform updates. The next section explains how to make targeted changes and regenerate specific files based on new requirements or code modifications.
-
-<x-card data-title="Update and Refine" data-icon="lucide:file-edit" data-href="/features/update-and-refine">Learn how to update documents when your code changes or make specific improvements using feedback.</x-card>