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

package/docs/configuration-initial-setup.md

@@ -1,45 +1,45 @@
 # Initial Setup
 
-This guide provides a step-by-step walkthrough of the interactive setup process for AIGNE DocSmith. This process is initiated the first time you run the `generate` command, or it can be started manually. Its purpose is to create a `config.yaml` file that stores your preferences for generating documentation.
+This document provides a step-by-step guide to the interactive setup process for AIGNE DocSmith. This procedure is initiated automatically the first time you run the `aigne doc generate` command, or it can be started manually. The objective is to create a `config.yaml` file that stores your preferences for generating documentation.
 
-## Starting the Process
+## How to Start the Setup Process
 
-To manually begin the configuration, navigate to your project's root directory in your terminal and execute the following command:
+To begin the configuration manually, navigate to your project's root directory in a terminal and execute the following command:
 
 ```bash
 aigne doc init
 ```
 
-This command launches an interactive questionnaire that will guide you through configuring your documentation settings.
+This command launches an interactive questionnaire to configure your documentation settings. The process consists of 10 steps designed to tailor the generated documentation to your specific requirements.
 
 ## Configuration Steps
 
-The setup process consists of nine questions designed to tailor the documentation to your specific needs.
+The setup process will prompt you with a series of questions. The following sections detail each step.
 
 ### Step 1: Define Documentation Purpose
 
-You will first be asked to define the primary goals of your documentation. This selection influences the tone, structure, and focus of the generated content.
+The first step is to define the primary goals of your documentation. This selection influences the tone, structure, and focus of the generated content.
 
-**Prompt:** `📝 [1/9]: What should your documentation help readers achieve?`
+**Prompt:** `📝 [1/10]: What should your documentation help readers achieve?`
 
-You can select multiple options from the list below:
+You can select one or more options from the following list:
 
 | Option | Name | Description |
 | :--- | :--- | :--- |
 | `getStarted` | Get started quickly | Help new users go from zero to working in <30 minutes. |
 | `completeTasks` | Complete specific tasks | Guide users through common workflows and use cases. |
-| `findAnswers` | Find answers fast | Provide searchable reference for all features and APIs. |
+| `findAnswers` | Find answers fast | Provide a searchable reference for all features and APIs. |
 | `understandSystem` | Understand the system | Explain how it works and the reasoning behind design decisions. |
 | `solveProblems` | Solve problems | Help users troubleshoot and fix issues. |
-| `mixedPurpose` | Mix of above | Cover multiple needs comprehensively. |
+| `mixedPurpose` | Mix of above | Cover multiple needs. |
 
 ### Step 2: Identify Target Audience
 
-Next, specify who will be the primary readers of your documentation. This helps tailor the language and technical depth appropriately.
+Next, specify the primary readers of your documentation. This helps to adjust the language and technical depth appropriately.
 
-**Prompt:** `👥 [2/9]: Who will be reading your documentation?`
+**Prompt:** `👥 [2/10]: Who will be reading your documentation?`
 
-You can select one or more of the following audiences:
+You may select multiple audiences from this list:
 
 | Option | Name | Description |
 | :--- | :--- | :--- |
@@ -50,37 +50,29 @@ You can select one or more of the following audiences:
 | `supportTeams` | Support teams | People helping others use the product. |
 | `mixedTechnical` | Mixed technical audience | A combination of developers, DevOps, and other technical users. |
 
-### Step 3: Provide Custom Rules
+### Step 3: Specify Reader Knowledge Level
 
-This optional step allows you to provide specific instructions or constraints for the AI to follow during content generation.
-
-**Prompt:** `📋 [3/9]: Any custom rules or requirements for your documentation? (Optional, press Enter to skip)`
-
-You can input any specific requirements, such as tone, style, or content to exclude. For example: "Avoid using marketing language and focus on technical accuracy."
-
-### Step 4: Specify Reader Knowledge Level
-
-Indicate the assumed knowledge level of your audience. This ensures the content is pitched at the right level, without being too basic or too complex.
+Indicate the assumed knowledge level of your audience. This ensures the content is presented at an appropriate level, avoiding information that is either too basic or too complex.
 
-**Prompt:** `🧠 [4/9]: How much do readers already know about your project?`
+**Prompt:** `🧠 [3/10]: How much do readers already know about your project?`
 
 Select the option that best describes your readers:
 
 | Option | Name | Description |
 | :--- | :--- | :--- |
 | `completeBeginners` | Complete beginners | New to the domain or technology entirely. |
-| `domainFamiliar` | Domain-familiar, tool-new | Know the problem space but are new to this solution. |
-| `experiencedUsers` | Experienced users | Regular users who need reference or advanced topics. |
+| `domainFamiliar` | Domain-familiar, tool-new | Know the problem space but are new to this specific solution. |
+| `experiencedUsers` | Experienced users | Regular users who need reference material or advanced topics. |
 | `emergencyTroubleshooting` | Emergency/troubleshooting | Users who need to fix a problem quickly. |
 | `exploringEvaluating` | Exploring/evaluating | Users trying to determine if the tool fits their needs. |
 
-### Step 5: Set Documentation Depth
+### Step 4: Set Documentation Depth
 
-Choose how detailed the documentation should be. This determines the scope and level of detail in the generated content.
+Choose how detailed the documentation should be. This parameter determines the scope and level of detail in the generated content.
 
-**Prompt:** `📊 [5/9]: How detailed should your documentation be?`
+**Prompt:** `📊 [4/10]: How detailed should your documentation be?`
 
-Select one of the following levels of detail:
+Select one of the following levels:
 
 | Option | Name | Description |
 | :--- | :--- | :--- |
@@ -89,49 +81,65 @@ Select one of the following levels of detail:
 | `comprehensive` | Comprehensive | Covers all features, edge cases, and advanced scenarios. |
 | `aiDecide` | Let AI decide | The tool analyzes code complexity to suggest an appropriate depth. |
 
-### Step 6: Select Primary Language
+### Step 5: Select Primary Language
 
 Choose the main language for your documentation. The system will detect your operating system's language and suggest it as the default.
 
-**Prompt:** `🌐 [6/9]: What's your main documentation language?`
+**Prompt:** `🌐 [5/10]: What's your main documentation language?`
 
-You will be presented with a list of 12 supported languages, including English, Chinese (Simplified), and Spanish.
+You can select from a list of 12 supported languages, including English, Chinese (Simplified), and Spanish.
 
-### Step 7: Choose Translation Languages
+### Step 6: Choose Translation Languages
 
-Select any additional languages you want the documentation to be translated into.
+Select any additional languages into which you want the documentation to be translated.
 
-**Prompt:** `🔄 [7/9]: Which languages should we translate to?`
+**Prompt:** `🔄 [6/10]: Which languages should we translate to?`
 
-You can choose multiple languages from the list of supported options, excluding the primary language you selected in the previous step.
+You can choose multiple languages from the supported options, excluding the primary language selected in the previous step.
 
-### Step 8: Define Output Directory
+### Step 7: Define Documentation Directory
 
-Specify the folder where the generated documentation files should be saved.
+Specify the folder where the generated documentation files will be saved.
 
-**Prompt:** `📁 [8/9]: Where should we save your documentation?`
+**Prompt:** `📁 [7/10]: Where should we save your documentation?`
 
-The default path is `.aigne/doc-smith/docs`. You can accept this or provide a different path.
+The default path is `.aigne/doc-smith/docs`. You can accept this default or provide a different path.
 
-### Step 9: Specify Content Sources
+### Step 8: Specify Content Sources
 
-Indicate which files and folders the tool should analyze to generate documentation. You can add multiple paths and use glob patterns for advanced filtering.
+Indicate which files and folders the tool should analyze to generate documentation. You can add multiple paths and use glob patterns for more specific file matching.
+
+**Prompt:** `🔍 [8/10]: Content Sources`
+
+You will be prompted to enter file paths, folder paths, or glob patterns (e.g., `src/**/*.js`). If no paths are provided, the tool will analyze the entire project directory by default.
+
+### Step 9: Provide Custom Rules
+
+This optional step allows you to provide specific instructions or constraints for the AI to follow during content generation.
 
-**Prompt:** `🔍 [9/9]: Content Sources`
+**Prompt:** `📋 [9/10]: Any custom rules or requirements for your documentation? (Optional, press Enter to skip)`
 
-You will be prompted to enter file paths, folder paths, or glob patterns (e.g., `src/**/*.js`). If you do not provide any paths, the tool will analyze the entire project directory by default.
+You can input any requirements, such as tone, style, or content to exclude. For example: "Focus on technical accuracy and avoid marketing terminology."
 
-## Generated Configuration File
+### Step 10: Configure Media Settings
 
-After completing the questionnaire, DocSmith saves your responses to a configuration file named `config.yaml` in the `.aigne/doc-smith/` directory. This file serves as the blueprint for all future documentation generation and can be manually edited at any time.
+Set a minimum width for images to be included in the documentation. This helps filter out low-resolution images or icons.
 
-Here is an example of a generated `config.yaml` file:
+**Prompt:** `🖼️ [10/10]: Minimum image width (in pixels) to include in documentation:`
 
-```yaml config.yaml title="config.yaml"
+The default value is `800`. You can enter a different positive number to adjust the filter.
+
+## The `config.yaml` File
+
+After you answer all the questions, DocSmith saves your responses to a configuration file named `config.yaml`, located in the `.aigne/doc-smith/` directory of your project. This file acts as the blueprint for all future documentation generation and can be manually edited at any time.
+
+Below is an example of a generated `config.yaml` file:
+
+```yaml config.yaml icon=logos:yaml
 # Project information for documentation publishing
 projectName: AIGNE DocSmith
 projectDesc: AIGNE DocSmith is a powerful, AI-driven documentation generation tool...
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
+projectLogo: ../assets/screenshots/9645caf64b4232699982c4d940b03b90.svg
 
 # =============================================================================
 # Documentation Configuration
@@ -154,7 +162,7 @@ documentationDepth: comprehensive
 
 # Custom Rules: Define specific documentation generation rules and requirements
 rules: |
-  Avoid using vague or empty words...
+  Avoid using vague or empty words that don't provide measurable or specific details...
 
 # Target Audience: Describe your specific target audience and their characteristics
 targetAudience: |
@@ -163,17 +171,28 @@ targetAudience: |
 locale: en
 translateLanguages:
   - zh
+  - zh-TW
   - ja
 
-# Directory and source path configurations
+# Paths
 docsDir: ./docs  # Directory to save generated documentation
 sourcesPath:  # Source code paths to analyze
   - ./README.md
   - ./agents
+
+# =============================================================================
+# Media Settings
+# =============================================================================
+media:
+  minImageWidth: 800
 ```
 
-## Next Steps
+## Summary and Next Steps
+
+Once the setup is complete, you will see a confirmation message.
+
+![Setup Complete](../assets/screenshots/doc-complete-setup.png)
 
-With your initial configuration complete, you are now ready to create your documentation.
+With your initial configuration saved, you are now prepared to create your documentation.
 
-*   Proceed to the [Generating Documentation](./guides-generating-documentation.md) guide to learn how to run the generation process.
+*   To proceed, consult the [Generating Documentation](./guides-generating-documentation.md) guide for instructions on running the generation process.

package/docs/configuration.ja.md

@@ -1,96 +1,69 @@
 # 設定
 
-適切な設定は、プロジェクト固有のニーズに合わせてドキュメント生成プロセスを調整するために不可欠です。AIGNE DocSmithは、主要な設定ファイルとコマンドラインインターフェースを使用して設定を管理します。このセットアップにより、生成されるドキュメントがプロジェクトの目標、対象読者、構造的要件を正確に反映することが保証されます。
+適切な設定は、AIGNE DocSmith ツールがプロジェクト固有のニーズに合ったドキュメントを生成するための基本です。このプロセスでは、中央の設定ファイルでプロジェクトレベルの設定を定義し、個人の設定を管理して生成プロセスを微調整します。
 
-このセクションでは、ツールの設定方法の概要を説明します。ステップバイステップの手順については、以下の詳細なガイドを参照してください。
+このセクションでは、ツールの設定方法の概要を説明します。詳細な手順については、以下の各ガイドを参照してください。
 
-<x-cards>
-  <x-card data-title="初期設定" data-icon="lucide:settings-2" data-href="/configuration/initial-setup">対話式セットアップを実行して `config.yaml` ファイルを作成する方法を学びます。これは、新しいプロジェクトで推奨される最初のステップです。</x-card>
-  <x-card data-title="設定の管理" data-icon="lucide:list-checks" data-href="/configuration/managing-preferences">保存された設定を表示、有効化、無効化、または削除する方法を理解し、時間とともにドキュメント生成プロセスを洗練させます。</x-card>
+<x-cards data-columns="2">
+  <x-card data-title="初期設定" data-icon="lucide:settings-2" data-href="/configuration/initial-setup">
+    対話式のセットアップガイドに従って、主要な `config.yaml` ファイルを作成します。これは、新しいドキュメントプロジェクトに不可欠な最初のステップです。
+  </x-card>
+  <x-card data-title="設定の管理" data-icon="lucide:user-cog" data-href="/configuration/managing-preferences">
+    個人の設定を表示、有効化、無効化、または削除する方法を学びます。これにより、主要なプロジェクト設定を補完する特定のルールを適用できます。
+  </x-card>
 </x-cards>
 
-## `config.yaml` ファイル
-
-すべてのプロジェクトレベルの設定は、プロジェクト内の `.aigne/doc-smith/` ディレクトリにある `config.yaml` という名前のファイルに保存されます。`aigne doc init` コマンドは、対話的なプロセスを通じてこのファイルを作成します。また、いつでもテキストエディタでこのファイルを手動で変更して設定を調整することもできます。
-
-以下は `config.yaml` ファイルの例で、各セクションを説明するコメントが付いています。
-
-```yaml Example config.yaml icon=logos:yaml
-# ドキュメント公開のためのプロジェクト情報
-projectName: AIGNE DocSmith
-projectDesc: AIGNE DocSmithは、AIGNEフレームワーク上に構築された強力なAI駆動のドキュメント生成ツールです。ソースコードから直接、詳細で構造化された多言語のドキュメント作成を自動化します。
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
-
-# =============================================================================
-# ドキュメント設定
-# =============================================================================
-
-# 目的: 読者に達成してもらいたい主な成果は何ですか？
-# 利用可能なオプション（必要に応じてコメントを解除し、変更してください）：
-#   getStarted       - 迅速な開始：新規ユーザーが30分未満でゼロから作業を開始できるように支援します
-#   completeTasks    - 特定のタスクの完了：一般的なワークフローとユースケースを通じてユーザーをガイドします
-#   findAnswers      - 迅速な回答の検索：すべての機能とAPIに対して検索可能なリファレンスを提供します
-#   understandSystem - システムの理解：システムの仕組み、設計上の決定理由を説明します
-#   solveProblems    - 問題の解決：ユーザーのトラブルシューティングと問題修正を支援します
-#   mixedPurpose     - 上記の混合：複数のニーズをカバーする包括的なドキュメント
-documentPurpose:
-  - getStarted
-  - completeTasks
-
-# 対象読者: 主に誰がこれを読みますか？
-# 利用可能なオプション（必要に応じてコメントを解除し、変更してください）：
-#   endUsers         - エンドユーザー（非技術者）：製品を使用するがコーディングはしない人々
-#   developers       - 統合開発者：これを自分のプロジェクトに追加するエンジニア
-#   devops           - DevOps/インフラストラクチャ：システムをデプロイ、監視、維持するチーム
-#   decisionMakers   - 技術的な意思決定者：実装を評価または計画するアーキテクト、リーダー
-#   supportTeams     - サポートチーム：他者が製品を使用するのを助ける人々
-#   mixedTechnical   - 混合技術者層：開発者、DevOps、および技術ユーザー
-targetAudienceTypes:
-  - endUsers
-
-# 読者の知識レベル: 読者が訪れたときに通常何を知っていますか？
-# 利用可能なオプション（必要に応じてコメントを解除し、変更してください）：
-#   completeBeginners    - 完全な初心者：この分野/技術に全く新しい人々
-#   domainFamiliar       - 分野に精通、ツールは初めて：問題領域は知っているが、この特定のソリューションは初めて
-#   experiencedUsers     - 経験豊富なユーザー：リファレンス/高度なトピックを必要とする通常のユーザー
-#   emergencyTroubleshooting - 緊急/トラブルシューティング：何かが壊れており、迅速に修正する必要がある
-#   exploringEvaluating  - 探索/評価：これが自分のニーズに合うかどうかを理解しようとしている
-readerKnowledgeLevel: completeBeginners
-
-# ドキュメントの深さ: ドキュメントはどの程度包括的であるべきですか？
-# 利用可能なオプション（必要に応じてコメントを解除し、変更してください）：
-#   essentialOnly      - 必須事項のみ：80%のユースケースをカバーし、簡潔に保つ
-#   balancedCoverage   - バランスの取れたカバレッジ：実践的な例を伴う適切な深さ [推奨]
-#   comprehensive      - 包括的：すべての機能、エッジケース、および高度なシナリオをカバーする
-#   aiDecide           - AIに決定させる：コードの複雑さを分析し、適切な深さを提案する
-documentationDepth: comprehensive
-
-# カスタムルール: 特定のドキュメント生成ルールと要件を定義します
-rules: |
-  Avoid using vague or empty words that don't provide measurable or specific details, such as 'intelligently', 'seamlessly', 'comprehensive', or 'high-quality'. Focus on concrete, verifiable facts and information.
-  Focus on concrete, verifiable facts and information.
-  Must cover all subcommands of DocSmith
-
-# 対象読者: 特定の対象読者とその特徴を記述します
-targetAudience: |
-
-locale: en
-translateLanguages:
-  - zh
-  - zh-TW
-  - ja
-docsDir: ./docs  # 生成されたドキュメントを保存するディレクトリ
-sourcesPath:  # 分析するソースコードのパス
-  - ./README.md
-  - ./CHANGELOG.md
-  - ./aigne.yaml
-  - ./agents
-  - ./media.md
-  - ./.aigne/doc-smith/config.yaml
-```
+## `config.yaml` ファイルについて
+
+`config.yaml` ファイルは、ドキュメントプロジェクトにおける信頼できる唯一の情報源（source of truth）として機能します。このファイルは初期設定プロセスで生成され、AI がソースコードを分析してコンテンツを生成するために使用するすべてのコアディレクティブを含んでいます。正しく設定されたファイルにより、意図した読者、目的、スタイルに合わせた出力が保証されます。
+
+以下に、`config.yaml` ファイルに含まれる主要なパラメータの内訳を示します。
+
+### コア設定パラメータ
+
+<x-field-group>
+  <x-field data-name="projectName" data-type="string" data-required="true">
+    <x-field-desc markdown>プロジェクトの正式名称。ドキュメント全体のタイトルやその他のメタデータで使用されます。</x-field-desc>
+  </x-field>
+  <x-field data-name="projectDesc" data-type="string" data-required="true">
+    <x-field-desc markdown>プロジェクトの目的と機能を簡潔に一句で説明します。</x-field-desc>
+  </x-field>
+  <x-field data-name="projectLogo" data-type="string" data-required="false">
+    <x-field-desc markdown>プロジェクトのロゴ画像を指す URL。公開されるドキュメントサイトのブランディングに使用されます。</x-field-desc>
+  </x-field>
+  <x-field data-name="documentPurpose" data-type="array" data-required="true">
+    <x-field-desc markdown>ドキュメントの主要な目標を定義します。例として、オンボーディングガイドのための `getStarted` や、手順を説明するための `completeTasks` があります。</x-field-desc>
+  </x-field>
+  <x-field data-name="targetAudienceTypes" data-type="array" data-required="true">
+    <x-field-desc markdown>対象読者を指定します。例として、技術者ではない一般ユーザー向けの `endUsers` や、エンジニア向けの `developers` があります。</x-field-desc>
+  </x-field>
+  <x-field data-name="readerKnowledgeLevel" data-type="string" data-required="true">
+    <x-field-desc markdown>対象読者に想定される技術知識と背景を記述します。例：`completeBeginners`。</x-field-desc>
+  </x-field>
+  <x-field data-name="documentationDepth" data-type="string" data-required="true">
+    <x-field-desc markdown>生成されるコンテンツの詳細度を制御します。オプションは `essentialOnly` から `comprehensive` まであります。</x-field-desc>
+  </x-field>
+  <x-field data-name="rules" data-type="string" data-required="false">
+    <x-field-desc markdown>コンテンツ生成プロセス中に AI が従うべきカスタム指示、ガイドライン、または制約のセットです。</x-field-desc>
+  </x-field>
+  <x-field data-name="locale" data-type="string" data-required="true">
+    <x-field-desc markdown>ドキュメントの主要な言語コード。例：英語の場合は `en`。</x-field-desc>
+  </x-field>
+  <x-field data-name="translateLanguages" data-type="array" data-required="false">
+    <x-field-desc markdown>主要なドキュメントを翻訳する先の言語コードのリスト。例：`zh`（中国語）や `ja`（日本語）。</x-field-desc>
+  </x-field>
+  <x-field data-name="docsDir" data-type="string" data-required="true">
+    <x-field-desc markdown>生成されたドキュメントファイルが保存されるローカルディレクトリのパス。</x-field-desc>
+  </x-field>
+  <x-field data-name="sourcesPath" data-type="array" data-required="true">
+    <x-field-desc markdown>ツールがドキュメントを生成するために分析するソースファイル、ディレクトリ、または glob パターンのリスト。</x-field-desc>
+  </x-field>
+</x-field-group>
 
 ## まとめ
 
-設定が完了すると、ツールはプロジェクト、対象読者、ドキュメントの目標を明確に理解し、より正確で関連性の高いコンテンツが生成されます。
+明確に定義された設定は、正確で、関連性が高く、効果的なドキュメントを作成するために不可欠です。初期設定を完了し、`config.yaml` ファイルを理解することで、すべてのドキュメント作成タスクの強固な基盤を築くことができます。
 
-プロジェクトの設定を開始するには、[初期設定](./configuration-initial-setup.md) ガイドに進んでください。
+プロジェクトの設定を進めるには、以下のガイドを参照してください：
+*   **[初期設定](./configuration-initial-setup.md)**：プロジェクトの `config.yaml` ファイルを作成します。
+*   **[設定の管理](./configuration-managing-preferences.md)**：個人のルールでツールの動作をカスタマイズします。

package/docs/configuration.md

@@ -1,96 +1,69 @@
 # Configuration
 
-Proper configuration is essential for tailoring the documentation generation process to your project's specific needs. AIGNE DocSmith uses a primary configuration file and a command-line interface to manage your settings. This setup ensures that the generated documentation accurately reflects your project's goals, target audience, and structural requirements.
+Proper configuration is fundamental to guiding the AIGNE DocSmith tool in generating documentation that aligns with your project's specific needs. This process involves defining project-level settings through a central configuration file and managing personal preferences for fine-tuning the generation process.
 
-This section provides an overview of how to configure the tool. For step-by-step instructions, please refer to the following detailed guides:
+This section provides an overview of how to configure the tool. For detailed, step-by-step instructions, please refer to the specific guides linked below.
 
-<x-cards>
-  <x-card data-title="Initial Setup" data-icon="lucide:settings-2" data-href="/configuration/initial-setup">Learn how to run the interactive setup to create your config.yaml file. This is the recommended first step for any new project.</x-card>
-  <x-card data-title="Managing Preferences" data-icon="lucide:list-checks" data-href="/configuration/managing-preferences">Understand how to view, enable, disable, or delete saved preferences to refine the documentation generation process over time.</x-card>
+<x-cards data-columns="2">
+  <x-card data-title="Initial Setup" data-icon="lucide:settings-2" data-href="/configuration/initial-setup">
+    Follow the interactive setup guide to create the main `config.yaml` file. This is the essential first step for any new documentation project.
+  </x-card>
+  <x-card data-title="Managing Preferences" data-icon="lucide:user-cog" data-href="/configuration/managing-preferences">
+    Learn how to view, enable, disable, or delete personal preferences. These allow you to apply specific rules that can supplement the main project configuration.
+  </x-card>
 </x-cards>
 
-## The `config.yaml` File
-
-All project-level settings are stored in a file named `config.yaml`, located in the `.aigne/doc-smith/` directory within your project. The `aigne doc init` command creates this file for you through an interactive process. You can also modify this file manually with a text editor to adjust settings at any time.
-
-Below is an example of a `config.yaml` file, with comments explaining each section.
-
-```yaml Example config.yaml icon=logos:yaml
-# Project information for documentation publishing
-projectName: AIGNE DocSmith
-projectDesc: AIGNE DocSmith is a powerful, AI-driven documentation generation tool built on the AIGNE Framework. It automates the creation of detailed, structured, and multi-language documentation directly from your source code.
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
-
-# =============================================================================
-# Documentation Configuration
-# =============================================================================
-
-# Purpose: What's the main outcome you want readers to achieve?
-# Available options (uncomment and modify as needed):
-#   getStarted       - Get started quickly: Help new users go from zero to working in <30 minutes
-#   completeTasks    - Complete specific tasks: Guide users through common workflows and use cases
-#   findAnswers      - Find answers fast: Provide searchable reference for all features and APIs
-#   understandSystem - Understand the system: Explain how it works, why design decisions were made
-#   solveProblems    - Solve problems: Help users troubleshoot and fix issues
-#   mixedPurpose     - Mix of above: Comprehensive documentation covering multiple needs
-documentPurpose:
-  - getStarted
-  - completeTasks
-
-# Target Audience: Who will be reading this most often?
-# Available options (uncomment and modify as needed):
-#   endUsers         - End users (non-technical): People who use the product but don't code
-#   developers       - Developers integrating: Engineers adding this to their projects
-#   devops           - DevOps/Infrastructure: Teams deploying, monitoring, maintaining systems
-#   decisionMakers   - Technical decision makers: Architects, leads evaluating or planning implementation
-#   supportTeams     - Support teams: People helping others use the product
-#   mixedTechnical   - Mixed technical audience: Developers, DevOps, and technical users
-targetAudienceTypes:
-  - endUsers
-
-# Reader Knowledge Level: What do readers typically know when they arrive?
-# Available options (uncomment and modify as needed):
-#   completeBeginners    - Complete beginners: New to this domain/technology entirely
-#   domainFamiliar       - Domain-familiar, tool-new: Know the problem space, new to this specific solution
-#   experiencedUsers     - Experienced users: Regular users needing reference/advanced topics
-#   emergencyTroubleshooting - Emergency/troubleshooting: Something's broken, need to fix it quickly
-#   exploringEvaluating  - Exploring/evaluating: Trying to understand if this fits their needs
-readerKnowledgeLevel: completeBeginners
-
-# Documentation Depth: How comprehensive should the documentation be?
-# Available options (uncomment and modify as needed):
-#   essentialOnly      - Essential only: Cover the 80% use cases, keep it concise
-#   balancedCoverage   - Balanced coverage: Good depth with practical examples [RECOMMENDED]
-#   comprehensive      - Comprehensive: Cover all features, edge cases, and advanced scenarios
-#   aiDecide           - Let AI decide: Analyze code complexity and suggest appropriate depth
-documentationDepth: comprehensive
-
-# Custom Rules: Define specific documentation generation rules and requirements
-rules: |
-  Avoid using vague or empty words that don't provide measurable or specific details, such as 'intelligently', 'seamlessly', 'comprehensive', or 'high-quality'. Focus on concrete, verifiable facts and information.
-  Focus on concrete, verifiable facts and information.
-  Must cover all subcommands of DocSmith
-
-# Target Audience: Describe your specific target audience and their characteristics
-targetAudience: |
-
-locale: en
-translateLanguages:
-  - zh
-  - zh-TW
-  - ja
-docsDir: ./docs  # Directory to save generated documentation
-sourcesPath:  # Source code paths to analyze
-  - ./README.md
-  - ./CHANGELOG.md
-  - ./aigne.yaml
-  - ./agents
-  - ./media.md
-  - ./.aigne/doc-smith/config.yaml
-```
+## Understanding the `config.yaml` File
+
+The `config.yaml` file serves as the primary source of truth for your documentation project. It is generated during the initial setup process and contains all the core directives that the AI uses to analyze your source code and generate content. A correctly configured file ensures that the output is tailored to your intended audience, purpose, and style.
+
+Below is a breakdown of the key parameters you will find in the `config.yaml` file.
+
+### Core Configuration Parameters
+
+<x-field-group>
+  <x-field data-name="projectName" data-type="string" data-required="true">
+    <x-field-desc markdown>The official name of your project. This will be used in titles and other metadata throughout the documentation.</x-field-desc>
+  </x-field>
+  <x-field data-name="projectDesc" data-type="string" data-required="true">
+    <x-field-desc markdown>A concise, one-sentence description of your project's purpose and functionality.</x-field-desc>
+  </x-field>
+  <x-field data-name="projectLogo" data-type="string" data-required="false">
+    <x-field-desc markdown>A URL pointing to your project's logo image. This will be used for branding the published documentation site.</x-field-desc>
+  </x-field>
+  <x-field data-name="documentPurpose" data-type="array" data-required="true">
+    <x-field-desc markdown>Defines the primary goals of the documentation. Examples include `getStarted` for onboarding guides or `completeTasks` for procedural instructions.</x-field-desc>
+  </x-field>
+  <x-field data-name="targetAudienceTypes" data-type="array" data-required="true">
+    <x-field-desc markdown>Specifies the intended readers. Examples include `endUsers` for non-technical individuals or `developers` for engineers.</x-field-desc>
+  </x-field>
+  <x-field data-name="readerKnowledgeLevel" data-type="string" data-required="true">
+    <x-field-desc markdown>Describes the assumed technical knowledge and background of the target audience, such as `completeBeginners`.</x-field-desc>
+  </x-field>
+  <x-field data-name="documentationDepth" data-type="string" data-required="true">
+    <x-field-desc markdown>Controls the level of detail in the generated content. Options range from `essentialOnly` to `comprehensive`.</x-field-desc>
+  </x-field>
+  <x-field data-name="rules" data-type="string" data-required="false">
+    <x-field-desc markdown>A set of custom instructions, guidelines, or constraints for the AI to follow during the content generation process.</x-field-desc>
+  </x-field>
+  <x-field data-name="locale" data-type="string" data-required="true">
+    <x-field-desc markdown>The primary language code for the documentation, such as `en` for English.</x-field-desc>
+  </x-field>
+  <x-field data-name="translateLanguages" data-type="array" data-required="false">
+    <x-field-desc markdown>A list of language codes into which the primary documentation should be translated, for example, `zh` (Chinese) or `ja` (Japanese).</x-field-desc>
+  </x-field>
+  <x-field data-name="docsDir" data-type="string" data-required="true">
+    <x-field-desc markdown>The local directory path where the generated documentation files will be saved.</x-field-desc>
+  </x-field>
+  <x-field data-name="sourcesPath" data-type="array" data-required="true">
+    <x-field-desc markdown>A list of source files, directories, or glob patterns that the tool should analyze to generate documentation.</x-field-desc>
+  </x-field>
+</x-field-group>
 
 ## Summary
 
-With your configuration in place, the tool will have a clear understanding of your project, audience, and documentation goals, resulting in more accurate and relevant content.
+A well-defined configuration is essential for producing accurate, relevant, and effective documentation. By completing the initial setup and understanding the `config.yaml` file, you establish a solid foundation for all documentation tasks.
 
-To begin setting up your project, proceed to the [Initial Setup](./configuration-initial-setup.md) guide.
+To proceed with configuring your project, please refer to the following guides:
+*   **[Initial Setup](./configuration-initial-setup.md)**: Create your project's `config.yaml` file.
+*   **[Managing Preferences](./configuration-managing-preferences.md)**: Customize the tool's behavior with personal rules.