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

package/docs/configuration.zh.md

@@ -1,31 +1,71 @@
 # 配置指南
 
-AIGNE DocSmith 的行为由一个中央文件 `config.yaml` 控制，该文件位于 `.aigne/doc-smith/config.yaml`。此文件规定了文档的风格、目标受众、语言和结构。
+AIGNE DocSmith 的行为由一个中央配置文件 `.aigne/doc-smith/config.yaml` 控制。该文件允许您自定义文档的风格、目标受众、语言和结构，以满足您的特定需求。
 
-您可以通过运行 `aigne doc init` 使用交互式设置向导来创建和管理此文件。有关分步演练，请参阅[交互式设置](./configuration-interactive-setup.md)指南。
+您可以通过运行 `aigne doc init` 使用交互式设置向导来创建和管理此文件。有关分步演练，请参阅 [交互式设置](./configuration-interactive-setup.md) 指南。此外，您也可以直接编辑该文件以进行更精细的控制。
 
-## 核心配置领域
+下图说明了配置工作流程：
 
-您的文档由几个关键的配置领域来塑造。浏览这些指南，了解如何微调生成过程的每个方面。
+```d2 配置工作流程
+direction: down
+
+User: {
+  shape: person
+}
+
+CLI: {
+  label: "运行命令\n'aigne doc init'"
+  shape: rectangle
+}
+
+Setup-Wizard: {
+  label: "交互式设置向导"
+  shape: rectangle
+}
+
+Config-File: {
+  label: ".aigne/doc-smith/config.yaml"
+  shape: rectangle
+}
+
+AIGNE-DocSmith-Engine: {
+  label: "AIGNE DocSmith 引擎"
+}
+
+# 路径 1：交互式设置（推荐）
+User -> CLI: "推荐路径"
+CLI -> Setup-Wizard: "启动"
+Setup-Wizard -> Config-File: "创建/修改"
+
+# 路径 2：手动编辑
+User -> Config-File: "备用路径：\n直接编辑"
+
+# 最后一步
+Config-File -> AIGNE-DocSmith-Engine: "配置"
+```
+
+## 核心配置区域
+
+您的文档由几个关键的配置区域决定。请浏览这些指南，了解如何微调生成过程的各个方面。
 
 <x-cards data-columns="2">
   <x-card data-title="交互式设置" data-icon="lucide:wand-2" data-href="/configuration/interactive-setup">
     了解引导式向导如何帮助您配置文档项目，包括设置建议和冲突检测。
   </x-card>
   <x-card data-title="LLM 设置" data-icon="lucide:brain-circuit" data-href="/configuration/llm-setup">
-    了解如何连接不同的 AI 模型，包括使用无需 API 密钥的内置 AIGNE Hub。
+    了解如何连接不同的 AI 模型，包括使用内置的、无需 API 密钥的 AIGNE Hub。
   </x-card>
   <x-card data-title="语言支持" data-icon="lucide:languages" data-href="/configuration/language-support">
     查看支持的语言完整列表，并了解如何设置主语言和启用自动翻译。
   </x-card>
-  <x-card data-title="管理偏好" data-icon="lucide:sliders-horizontal" data-href="/configuration/preferences">
+  <x-card data-title="管理偏好设置" data-icon="lucide:sliders-horizontal" data-href="/configuration/preferences">
     了解 DocSmith 如何利用您的反馈创建持久性规则，以及如何通过 CLI 管理这些规则。
   </x-card>
 </x-cards>
 
 ## 参数参考
 
-`config.yaml` 文件包含几个控制文档输出的键值对。以下是每个参数的详细参考。
+`config.yaml` 文件包含多个控制文档输出的键值对。以下是每个参数的详细参考。
 
 ### 项目信息
 
@@ -33,20 +73,20 @@ AIGNE DocSmith 的行为由一个中央文件 `config.yaml` 控制，该文件
 
 | 参数 | 描述 |
 |---|---|
-| `projectName` | 您的项目名称。如果可用，则从 `package.json` 中检测。 |
-| `projectDesc` | 您的项目的简短描述。从 `package.json` 中检测。 |
-| `projectLogo` | 您的项目徽标图像的路径或 URL。 |
+| `projectName` | 您的项目名称。如果 `package.json` 文件存在，则从中检测。 |
+| `projectDesc` | 您的项目简短描述。从 `package.json` 文件中检测。 |
+| `projectLogo` | 您的项目徽标图片的路径或 URL。 |
 
 ### 文档策略
 
 这些参数定义了生成内容的基调、风格和深度。
 
 #### `documentPurpose`
-定义您希望读者实现的主要成果。此设置会影响文档的整体结构和重点。
+定义您希望读者实现的主要成果。此设置影响文档的整体结构和重点。
 
 | 选项 | 名称 | 描述 |
 |---|---|---|
-| `getStarted` | 快速入门 | 帮助新用户在30分钟内从零开始上手。 |
+| `getStarted` | 快速入门 | 帮助新用户在 30 分钟内从零开始上手。 |
 | `completeTasks` | 完成特定任务 | 引导用户完成常见的工作流程和用例。 |
 | `findAnswers` | 快速查找答案 | 为所有功能和 API 提供可搜索的参考。 |
 | `understandSystem`| 理解系统 | 解释其工作原理以及做出设计决策的原因。 |
@@ -54,30 +94,30 @@ AIGNE DocSmith 的行为由一个中央文件 `config.yaml` 控制，该文件
 | `mixedPurpose` | 服务于多种目的 | 涵盖多种需求的文档。 |
 
 #### `targetAudienceTypes`
-定义最常阅读此文档的读者。此选择会影响写作风格和示例。
+定义最常阅读此文档的受众。此选择会影响写作风格和示例。
 
 | 选项 | 名称 | 描述 |
 |---|---|---|
 | `endUsers` | 最终用户（非技术人员） | 使用产品但不编码的人员。 |
-| `developers` | 集成您的产品/API 的开发人员 | 将此添加到其项目中的工程师。 |
+| `developers` | 集成您的产品/API 的开发者 | 将此添加到其项目中的工程师。 |
 | `devops` | DevOps / SRE / 基础设施团队 | 部署、监控和维护系统的团队。 |
-| `decisionMakers`| 技术决策者 | 评估或计划实施的架构师或负责人。 |
+| `decisionMakers`| 技术决策者 | 评估或规划实施的架构师或负责人。 |
 | `supportTeams` | 支持团队 | 帮助他人使用产品的人员。 |
-| `mixedTechnical`| 混合技术受众 | 开发人员、DevOps 和其他技术用户。 |
+| `mixedTechnical`| 混合技术受众 | 开发者、DevOps 和其他技术用户。 |
 
 #### `readerKnowledgeLevel`
-定义读者通常在阅读前已具备的知识。这会调整对基础知识的假设程度。
+定义读者通常具备的知识水平。这会调整对基础知识的假设程度。
 
 | 选项 | 名称 | 描述 |
 |---|---|---|
-| `completeBeginners` | 完全是初学者，从零开始 | 完全不熟悉该领域/技术。 |
+| `completeBeginners` | 完全是初学者，从零开始 | 完全不熟悉此领域/技术。 |
 | `domainFamiliar` | 之前使用过类似的工具 | 了解问题领域，但对这个具体解决方案不熟悉。 |
 | `experiencedUsers` | 是试图做某件特定事情的专家 | 需要参考或高级主题的常规用户。 |
-| `emergencyTroubleshooting`| 紧急/故障排查 | 某些东西坏了，需要快速修复。 |
-| `exploringEvaluating` | 正在将此工具与其他工具进行评估 | 试图了解这是否符合他们的需求。 |
+| `emergencyTroubleshooting`| 紧急情况/故障排查 | 某些东西坏了，需要快速修复。 |
+| `exploringEvaluating` | 正在评估此工具并与其他工具进行比较 | 试图了解这是否符合他们的需求。 |
 
 #### `documentationDepth`
-定义文档应达到的全面程度。
+定义文档的全面程度。
 
 | 选项 | 名称 | 描述 |
 |---|---|---|
@@ -88,12 +128,12 @@ AIGNE DocSmith 的行为由一个中央文件 `config.yaml` 控制，该文件
 
 ### 自定义指令
 
-为了更精细的控制，您可以提供自由文本指令。
+为了进行更精细的控制，您可以提供自由文本指令。
 
 | 参数 | 描述 |
 |---|---|
 | `rules` | 一个多行字符串，您可以在其中定义特定的文档生成规则（例如，“始终包含性能基准测试”）。 |
-| `targetAudience`| 一个多行字符串，用于比预设更详细地描述您的特定目标受众。 |
+| `targetAudience`| 一个多行字符串，用于比预设选项更详细地描述您的特定目标受众。 |
 
 ### 语言和路径配置
 
@@ -101,20 +141,20 @@ AIGNE DocSmith 的行为由一个中央文件 `config.yaml` 控制，该文件
 
 | 参数 | 描述 |
 |---|---|
-| `locale` | 文档的主要语言（例如 `en`、`zh`）。 |
-| `translateLanguages` | 要将文档翻译成的语言代码列表（例如 `[ja, fr, es]`）。 |
-| `docsDir` | 保存生成的文档文件的目录。 |
-| `sourcesPath` | 供 DocSmith 分析的源代码路径或 glob 模式列表（例如 `['./src', './lib/**/*.js']`）。 |
-| `glossary` | 包含项目特定术语的 markdown 文件（`@glossary.md`）的路径，以确保翻译的一致性。 |
+| `locale` | 文档的主要语言（例如，`en`、`zh`）。 |
+| `translateLanguages` | 要将文档翻译成的语言代码列表（例如，`[ja, fr, es]`）。 |
+| `docsDir` | 生成的文档文件将保存到的目录。 |
+| `sourcesPath` | 供 DocSmith 分析的源代码路径或 glob 模式列表（例如，`['./src', './lib/**/*.js']`）。 |
+| `glossary` | 包含项目特定术语的 Markdown 文件（`@glossary.md`）路径，以确保翻译的一致性。 |
 
 ## `config.yaml` 示例
 
-这是一个完整的配置文件示例。您可以随时直接编辑此文件以更改设置。
+这是一个完整的配置文件示例。您可以随时直接编辑此文件来更改设置。
 
-```yaml Example config.yaml icon=logos:yaml
+```yaml config.yaml 示例 icon=logos:yaml
 # 用于文档发布的项目信息
 projectName: AIGNE DocSmith
-projectDesc: 一个 AI 驱动的文档生成工具。
+projectDesc: An AI-driven documentation generation tool.
 projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
 
 # =============================================================================
@@ -132,11 +172,11 @@ documentPurpose:
 targetAudienceTypes:
   - developers
 
-# 读者知识水平：读者在阅读前通常具备哪些知识？
+# 读者知识水平：读者通常具备哪些知识？
 # 选项：completeBeginners, domainFamiliar, experiencedUsers, emergencyTroubleshooting, exploringEvaluating
 readerKnowledgeLevel: domainFamiliar
 
-# 文档深度：文档应达到多大的全面程度？
+# 文档深度：文档应有多全面？
 # 选项：essentialOnly, balancedCoverage, comprehensive, aiDecide
 documentationDepth: balancedCoverage
 
@@ -148,7 +188,7 @@ rules: |+
 targetAudience: |+
   
 
-# 术语表：包含项目特定术语和定义的 markdown 文件的路径
+# 词汇表：包含项目特定术语和定义的 Markdown 文件路径
 # glossary: "@glossary.md"
 
 # 文档的主要语言
@@ -159,7 +199,7 @@ locale: en
 #   - zh
 #   - fr
 
-# 保存生成的文档的目录
+# 保存生成文档的目录
 docsDir: .aigne/doc-smith/docs
 
 # 要分析的源代码路径
@@ -167,6 +207,6 @@ sourcesPath:
   - ./
 ```
 
-配置设置完成后，您就可以创建符合项目需求的文档了。下一步是运行生成命令。
+配置完成后，您就可以创建符合项目需求的文档了。下一步是运行生成命令。
 
 ➡️ **下一步：** [生成文档](./features-generate-documentation.md)

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

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

package/docs/features-generate-documentation.md

@@ -1,101 +1,95 @@
 # Generate Documentation
 
-The `aigne doc generate` command is the core function for creating a complete documentation set from your source code. This process analyzes your codebase, plans a logical document structure, and then generates content for each section. It's the primary way to create your documentation from scratch.
+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
+```bash aigne doc generate icon=lucide:play-circle
 aigne doc generate
 ```
 
 ### Automatic Configuration
 
-If you run this command for the first time in a project, DocSmith detects that no configuration exists. It will then launch an interactive setup wizard to guide you through the initial setup. This ensures you have a properly configured environment before generation begins.
+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 the generate command for the first time triggers the setup wizard](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
+![Running generate command, smart execution of initialization](../assets/screenshots/doc-generate.png)
 
-You will be asked a series of questions to define:
+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 and translation languages
-- Source code and output paths
+*   Document generation rules and style
+*   The target audience
+*   Primary language and any additional translation languages
+*   Source code input and documentation output paths
 
-![Answer the questions to configure your documentation style, languages, and source paths](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
+![Answer questions to complete project setup](../assets/screenshots/doc-complete-setup.png)
 
-Once the configuration is complete, DocSmith proceeds with the documentation generation.
+After the configuration is complete, DocSmith proceeds with the documentation generation.
 
-![DocSmith analyzes your code, plans the structure, and generates each document](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
+![Executing structure planning and generating documents](../assets/screenshots/doc-generate-docs.png)
 
-Upon successful completion, your newly created documentation will be available in the output directory you specified.
+Upon successful completion, the newly created documentation will be available in the output directory specified during setup.
 
-![Once complete, you'll find your new documentation in the specified output directory](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
+![Documentation generated successfully](../assets/screenshots/doc-generated-successfully.png)
 
 ## The Generation Process
 
-The `generate` command follows an automated workflow. The process can be visualized as follows:
+The `generate` command executes an automated, multi-step workflow. The process is outlined below:
 
 ```d2
 direction: down
 
-start: "Start" {
-  shape: oval
+User: {
+  shape: c4-person
 }
 
-run_cmd: "Run `aigne doc generate`" {
-  shape: rectangle
-}
+AIGNE-CLI: {
+  label: "AIGNE CLI"
 
-check_config: "Configuration Found?" {
-  shape: diamond
-}
+  config-check: {
+    label: "Config file exists?"
+    shape: diamond
+  }
 
-interactive_setup: "Launch Interactive Setup Wizard" {
-  shape: rectangle
-}
+  interactive-setup: {
+    label: "Interactive Setup Wizard"
+  }
 
-plan_structure: "1. Analyze Code & Plan Structure" {
-  shape: rectangle
-}
+  generation-process: {
+    label: "3. Generation Process"
 
-gen_content: "2. Generate Document Content" {
-  shape: rectangle
-}
+    analyze-code: "Analyze Code"
+    plan-structure: "Plan Structure"
+    generate-content: "Generate Content"
 
-save_docs: "3. Save Documents" {
-  shape: rectangle
-}
+    analyze-code -> plan-structure -> generate-content
+  }
 
-end: "End" {
-  shape: oval
+  output: {
+    label: "Output Directory"
+  }
 }
 
-start -> run_cmd
-run_cmd -> check_config
-check_config -> interactive_setup: "No"
-interactive_setup -> plan_structure
-check_config -> plan_structure: "Yes"
-plan_structure -> gen_content
-gen_content -> save_docs
-save_docs -> end
+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
 
-While the default `generate` command is sufficient for most use cases, you can use several options to control the generation process. These are useful for regenerating content or refining the document structure.
+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 section"`         |
-| `--model`           | Specifies a particular Large Language Model from AIGNE Hub to use for content generation, allowing you to switch between models.       | `aigne doc generate --model claude:claude-3-5-sonnet`                |
+| 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?
 
-Now that you have generated your initial documentation, your project will continue to evolve. To keep your documents synchronized with your code, you will need to update them. Proceed to the next section to learn how to make targeted changes and regenerate specific files.
+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>
+<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>