@aigne/doc-smith 0.8.11-beta.6 → 0.8.11

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

@@ -2,9 +2,9 @@
 
 `aigne doc generate` コマンドは、ソースコードから完全なドキュメントセットを作成するための主要な機能です。このコマンドは、コードベースを分析し、論理的なドキュメント構造を計画し、各セクションのコンテンツを生成するプロセスを開始します。これは、初期状態からドキュメントを作成するための標準的な方法です。
 
-## 初めての生成
+## 最初の生成
 
-開始するには、プロジェクトのルートディレクトリに移動して、次のコマンドを実行します。
+まず、プロジェクトのルートディレクトリに移動し、次のコマンドを実行します。
 
 ```bash aigne doc generate icon=lucide:play-circle
 aigne doc generate
@@ -12,30 +12,30 @@ 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 がコードを分析し、構造を計画し、各ドキュメントを生成します](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
@@ -46,75 +46,50 @@ User: {
 
 AIGNE-CLI: {
   label: "AIGNE CLI"
-}
 
-Config-Check: {
-  label: "設定は\n存在しますか？"
-  shape: diamond
-}
+  config-check: {
+    label: "設定ファイルは存在しますか？"
+    shape: diamond
+  }
 
-Setup-Wizard: {
-  label: "対話型\nセットアップウィザード"
-}
+  interactive-setup: {
+    label: "対話式セットアップウィザード"
+  }
 
-Generation-Process: {
-  label: "生成プロセス"
-  grid-columns: 1
+  generation-process: {
+    label: "3. 生成プロセス"
 
-  Analyze: { label: "コードベースの分析" }
-  Plan: { label: "構造の計画" }
-  Generate: { label: "コンテンツの生成" }
-}
+    analyze-code: "コードの分析"
+    plan-structure: "構造の計画"
+    generate-content: "コンテンツの生成"
 
-Source-Code: {
-  label: "ソースコード"
-  shape: cylinder
-}
+    analyze-code -> plan-structure -> generate-content
+  }
 
-Config-File: {
-  label: "config.yaml"
-  shape: cylinder
+  output: {
+    label: "出力ディレクトリ"
+  }
 }
 
-Output-Directory: {
-  label: "出力ディレクトリ"
-  shape: cylinder
-}
-
-User -> AIGNE-CLI: "1. aigne doc generate"
-AIGNE-CLI -> Config-Check: "2. 設定の確認"
-
-Config-Check -> Setup-Wizard: "3a. いいえ"
-Setup-Wizard -> User: "入力を要求"
-User -> Setup-Wizard: "回答を提供"
-Setup-Wizard -> Config-File: "作成"
-Config-File -> Generation-Process: "使用"
-Setup-Wizard -> Generation-Process: "4. 続行"
-
-Config-Check -> Generation-Process: "3b. はい"
-
-Source-Code -> Generation-Process.Analyze: "入力"
-Generation-Process.Analyze -> Generation-Process.Plan
-Generation-Process.Plan -> Generation-Process.Generate
-Generation-Process.Generate -> Output-Directory: "5. ドキュメントの書き込み"
-
-Output-Directory -> User: "6. ドキュメントのレビュー"
+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 anthropic: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

@@ -14,24 +14,24 @@ aigne doc generate
 
 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 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
+*   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)
 
 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, 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
 
@@ -46,75 +46,50 @@ User: {
 
 AIGNE-CLI: {
   label: "AIGNE CLI"
-}
 
-Config-Check: {
-  label: "Configuration\nExists?"
-  shape: diamond
-}
+  config-check: {
+    label: "Config file exists?"
+    shape: diamond
+  }
 
-Setup-Wizard: {
-  label: "Interactive\nSetup Wizard"
-}
+  interactive-setup: {
+    label: "Interactive Setup Wizard"
+  }
 
-Generation-Process: {
-  label: "Generation Process"
-  grid-columns: 1
+  generation-process: {
+    label: "3. Generation Process"
 
-  Analyze: { label: "Analyze Codebase" }
-  Plan: { label: "Plan Structure" }
-  Generate: { label: "Generate Content" }
-}
+    analyze-code: "Analyze Code"
+    plan-structure: "Plan Structure"
+    generate-content: "Generate Content"
 
-Source-Code: {
-  label: "Source Code"
-  shape: cylinder
-}
+    analyze-code -> plan-structure -> generate-content
+  }
 
-Config-File: {
-  label: "config.yaml"
-  shape: cylinder
+  output: {
+    label: "Output Directory"
+  }
 }
 
-Output-Directory: {
-  label: "Output Directory"
-  shape: cylinder
-}
-
-User -> AIGNE-CLI: "1. aigne doc generate"
-AIGNE-CLI -> Config-Check: "2. Check for config"
-
-Config-Check -> Setup-Wizard: "3a. No"
-Setup-Wizard -> User: "Prompt for input"
-User -> Setup-Wizard: "Provide answers"
-Setup-Wizard -> Config-File: "Creates"
-Config-File -> Generation-Process: "Uses"
-Setup-Wizard -> Generation-Process: "4. Proceed"
-
-Config-Check -> Generation-Process: "3b. Yes"
-
-Source-Code -> Generation-Process.Analyze: "Input"
-Generation-Process.Analyze -> Generation-Process.Plan
-Generation-Process.Plan -> Generation-Process.Generate
-Generation-Process.Generate -> Output-Directory: "5. Write documentation"
-
-Output-Directory -> User: "6. Review documentation"
+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 section"`         |
-| `--model`           | Specifies a particular Large Language Model from AIGNE Hub to use for content generation. This allows you to switch between different models.       | `aigne doc generate --model anthropic: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?
 
 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>

package/docs/features-generate-documentation.zh-TW.md

@@ -1,6 +1,6 @@
 # 產生文件
 
-`aigne doc generate` 指令是從您的原始碼建立一套完整文件的主要功能。此指令會啟動一個流程，分析您的程式碼庫、規劃一個合乎邏輯的文件結構，然後為每個部分產生內容。這是從初始狀態建立文件的標準方法。
+`aigne doc generate` 指令是從原始程式碼建立完整文件集的主要功能。此指令會啟動一個流程，分析您的程式碼庫、規劃邏輯性的文件結構，然後為每個部分產生內容。這是從初始狀態建立文件的標準方法。
 
 ## 首次產生
 
@@ -12,26 +12,26 @@ 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 會分析您的程式碼、規劃結構並產生每個文件](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)
 
 ## 產生流程
 
@@ -46,75 +46,50 @@ User: {
 
 AIGNE-CLI: {
   label: "AIGNE CLI"
-}
 
-Config-Check: {
-  label: "設定檔\n是否存在？"
-  shape: diamond
-}
+  config-check: {
+    label: "設定檔是否存在？"
+    shape: diamond
+  }
 
-Setup-Wizard: {
-  label: "互動式\n設定精靈"
-}
+  interactive-setup: {
+    label: "互動式設定精靈"
+  }
 
-Generation-Process: {
-  label: "產生流程"
-  grid-columns: 1
+  generation-process: {
+    label: "3. 產生流程"
 
-  Analyze: { label: "分析程式碼庫" }
-  Plan: { label: "規劃結構" }
-  Generate: { label: "產生內容" }
-}
+    analyze-code: "分析程式碼"
+    plan-structure: "規劃結構"
+    generate-content: "產生內容"
 
-Source-Code: {
-  label: "原始碼"
-  shape: cylinder
-}
+    analyze-code -> plan-structure -> generate-content
+  }
 
-Config-File: {
-  label: "config.yaml"
-  shape: cylinder
+  output: {
+    label: "輸出目錄"
+  }
 }
 
-Output-Directory: {
-  label: "輸出目錄"
-  shape: cylinder
-}
-
-User -> AIGNE-CLI: "1. aigne doc generate"
-AIGNE-CLI -> Config-Check: "2. 檢查設定檔"
-
-Config-Check -> Setup-Wizard: "3a. 否"
-Setup-Wizard -> User: "提示輸入"
-User -> Setup-Wizard: "提供答案"
-Setup-Wizard -> Config-File: "建立"
-Config-File -> Generation-Process: "使用"
-Setup-Wizard -> Generation-Process: "4. 繼續"
-
-Config-Check -> Generation-Process: "3b. 是"
-
-Source-Code -> Generation-Process.Analyze: "輸入"
-Generation-Process.Analyze -> Generation-Process.Plan
-Generation-Process.Plan -> Generation-Process.Generate
-Generation-Process.Generate -> Output-Directory: "5. 寫入文件"
-
-Output-Directory -> User: "6. 檢閱文件"
+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 "Add an API Reference section"`         |
-| `--model`           | 指定使用 AIGNE Hub 中的特定大型語言模型來產生內容。這讓您可以在不同模型之間切換。                                                | `aigne doc generate --model anthropic:claude-3-5-sonnet`                |
+| 選項 | 描述 | 範例 |
+| :------------------ | :----------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------- |
+| `--forceRegenerate` | 刪除所有現有文件並從頭開始重新產生。在對原始程式碼或設定進行重大變更後使用此選項。 | `aigne doc generate --forceRegenerate` |
+| `--feedback` | 提供高層次的回饋以完善整體文件結構，例如新增、移除或重組章節。 | `aigne doc generate --feedback "Add an API Reference"` |
+| `--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.zh.md

@@ -12,110 +12,84 @@ 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
 
 User: {
   shape: c4-person
-  label: "用户"
 }
 
 AIGNE-CLI: {
   label: "AIGNE CLI"
-}
 
-Config-Check: {
-  label: "配置\n存在？"
-  shape: diamond
-}
+  config-check: {
+    label: "配置文件是否存在？"
+    shape: diamond
+  }
 
-Setup-Wizard: {
-  label: "交互式\n设置向导"
-}
+  interactive-setup: {
+    label: "交互式设置向导"
+  }
 
-Generation-Process: {
-  label: "生成过程"
-  grid-columns: 1
+  generation-process: {
+    label: "3. 生成过程"
 
-  Analyze: { label: "分析代码库" }
-  Plan: { label: "规划结构" }
-  Generate: { label: "生成内容" }
-}
+    analyze-code: "分析代码"
+    plan-structure: "规划结构"
+    generate-content: "生成内容"
 
-Source-Code: {
-  label: "源代码"
-  shape: cylinder
-}
+    analyze-code -> plan-structure -> generate-content
+  }
 
-Config-File: {
-  label: "config.yaml"
-  shape: cylinder
+  output: {
+    label: "输出目录"
+  }
 }
 
-Output-Directory: {
-  label: "输出目录"
-  shape: cylinder
-}
-
-User -> AIGNE-CLI: "1. aigne doc generate"
-AIGNE-CLI -> Config-Check: "2. 检查配置"
-
-Config-Check -> Setup-Wizard: "3a. 否"
-Setup-Wizard -> User: "提示输入"
-User -> Setup-Wizard: "提供回答"
-Setup-Wizard -> Config-File: "创建"
-Config-File -> Generation-Process: "使用"
-Setup-Wizard -> Generation-Process: "4. 继续"
-
-Config-Check -> Generation-Process: "3b. 是"
-
-Source-Code -> Generation-Process.Analyze: "输入"
-Generation-Process.Analyze -> Generation-Process.Plan
-Generation-Process.Plan -> Generation-Process.Generate
-Generation-Process.Generate -> Output-Directory: "5. 写入文档"
-
-Output-Directory -> User: "6. 审阅文档"
+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 "Add an API Reference section"`         |
-| `--model`           | 指定 AIGNE Hub 中的特定大型语言模型用于内容生成。这允许您在不同模型之间切换。       | `aigne doc generate --model anthropic: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>