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

package/docs/configuration.ja.md

@@ -1,212 +1,96 @@
-# 設定ガイド
+# 設定
 
-AIGNE DocSmith の動作は、中央設定ファイル `.aigne/doc-smith/config.yaml` によって制御されます。このファイルを使用して、ドキュメントのスタイル、対象読者、言語、構造を特定のニーズに合わせてカスタマイズできます。
+適切な設定は、プロジェクト固有のニーズに合わせてドキュメント生成プロセスを調整するために不可欠です。AIGNE DocSmithは、主要な設定ファイルとコマンドラインインターフェースを使用して設定を管理します。このセットアップにより、生成されるドキュメントがプロジェクトの目標、対象読者、構造的要件を正確に反映することが保証されます。
 
-`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">
-    APIキーが不要な組み込みのAIGNEハブの使用を含む、さまざまなAIモデルの接続方法を発見します。
-  </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">
-    DocSmithがフィードバックを使用して永続的なルールを作成する方法と、CLIを介してそれらを管理する方法を理解します。
-  </x-card>
+<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>
 
-## パラメータリファレンス
-
-`config.yaml` ファイルには、ドキュメントの出力を制御するいくつかのキーと値のペアが含まれています。以下は、各パラメータの詳細なリファレンスです。
-
-### プロジェクト情報
-
-これらの設定は、プロジェクトに関する基本的なコンテキストを提供し、ドキュメントを公開する際に使用されます。
-
-| パラメータ | 説明 |
-|---|---|
-| `projectName` | プロジェクトの名前。`package.json` があればそこから検出されます。 |
-| `projectDesc` | プロジェクトの短い説明。`package.json` から検出されます。 |
-| `projectLogo` | プロジェクトのロゴ画像へのパスまたは URL。 |
-
-### ドキュメンテーション戦略
-
-これらのパラメータは、生成されるコンテンツのトーン、スタイル、深さを定義します。
-
-#### `documentPurpose`
-読者に達成してもらいたい主な成果を定義します。この設定は、ドキュメントの全体的な構造と焦点に影響を与えます。
-
-| オプション | 名前 | 説明 |
-|---|---|---|
-| `getStarted` | 迅速な開始 | 新規ユーザーが30分未満でゼロから作業を開始できるように支援します。 |
-| `completeTasks` | 特定のタスクを完了する | 一般的なワークフローとユースケースを通じてユーザーをガイドします。 |
-| `findAnswers` | 迅速に答えを見つける | すべての機能とAPIの検索可能なリファレンスを提供します。 |
-| `understandSystem`| システムを理解する | それがどのように機能し、なぜ設計上の決定がなされたかを説明します。 |
-| `solveProblems` | 一般的な問題のトラブルシューティング | ユーザーが問題をトラブルシューティングし、修正するのを助けます。 |
-| `mixedPurpose` | 複数の目的を果たす | 複数のニーズをカバーするドキュメント。 |
+## `config.yaml` ファイル
 
-#### `targetAudienceTypes`
-このドキュメントを最も頻繁に読むであろう人物を定義します。この選択は、ライティングスタイルと例に影響を与えます。
+すべてのプロジェクトレベルの設定は、プロジェクト内の `.aigne/doc-smith/` ディレクトリにある `config.yaml` という名前のファイルに保存されます。`aigne doc init` コマンドは、対話的なプロセスを通じてこのファイルを作成します。また、いつでもテキストエディタでこのファイルを手動で変更して設定を調整することもできます。
 
-| オプション | 名前 | 説明 |
-|---|---|---|
-| `endUsers` | エンドユーザー（非技術者） | 製品を使用するがコーディングはしない人々。 |
-| `developers` | 製品/APIを統合する開発者 | これを自分のプロジェクトに追加するエンジニア。 |
-| `devops` | DevOps / SRE / インフラストラクチャチーム | システムの展開、監視、保守を行うチーム。 |
-| `decisionMakers`| 技術的な意思決定者 | 実装を評価または計画するアーキテクトやリード。 |
-| `supportTeams` | サポートチーム | 他の人が製品を使用するのを助ける人々。 |
-| `mixedTechnical`| 混合技術オーディエンス | 開発者、DevOps、その他の技術ユーザー。 |
+以下は `config.yaml` ファイルの例で、各セクションを説明するコメントが付いています。
 
-#### `readerKnowledgeLevel`
-読者が通常、到着時に何を知っているかを定義します。これにより、どれだけの基礎知識が前提とされるかが調整されます。
-
-| オプション | 名前 | 説明 |
-|---|---|---|
-| `completeBeginners` | 完全な初心者で、ゼロから始める | このドメイン/テクノロジーに全く新しい。 |
-| `domainFamiliar` | 以前に類似のツールを使用したことがある | 問題領域は知っているが、この特定の解決策には新しい。 |
-| `experiencedUsers` | 特定のことをしようとしている専門家 | リファレンスや高度なトピックを必要とする通常のユーザー。 |
-| `emergencyTroubleshooting`| 緊急/トラブルシューティング | 何かが壊れており、迅速に修正する必要がある。 |
-| `exploringEvaluating` | このツールを他と比較評価している | これが自分のニーズに合うかどうかを理解しようとしている。 |
-
-#### `documentationDepth`
-ドキュメントがどれだけ包括的であるべきかを定義します。
-
-| オプション | 名前 | 説明 |
-|---|---|---|
-| `essentialOnly` | 不可欠なもののみ | 80%のユースケースをカバーし、簡潔に保ちます。 |
-| `balancedCoverage`| バランスの取れたカバレッジ | 実用的な例を含む適切な深さ [推奨]。 |
-| `comprehensive` | 包括的 | すべての機能、エッジケース、高度なシナリオをカバーします。 |
-| `aiDecide` | AIに決定させる | コードの複雑さを分析し、適切な深さを提案します。 |
-
-### カスタムディレクティブ
-
-より詳細な制御のために、自由形式の指示を提供できます。
-
-| パラメータ | 説明 |
-|---|---|
-| `rules` | 特定のドキュメント生成ルール（例：「常にパフォーマンスベンチマークを含める」）を定義できる複数行の文字列。 |
-| `targetAudience`| プリセットで許容されるよりも詳細に特定のターゲットオーディエンスを記述するための複数行の文字列。 |
-
-### 言語とパスの設定
-
-これらの設定は、ローカライゼーションとファイルの場所を制御します。
-
-| パラメータ | 説明 |
-|---|---|
-| `locale` | ドキュメントの主要言語（例：`en`、`zh`）。 |
-| `translateLanguages` | ドキュメントを翻訳する言語コードのリスト（例：`[ja, fr, es]`）。 |
-| `docsDir` | 生成されたドキュメントファイルが保存されるディレクトリ。 |
-| `sourcesPath` | DocSmithが分析するソースコードのパスまたはグロブパターンのリスト（例：`['./src', './lib/**/*.js']`）。 |
-| `glossary` | 一貫した翻訳を保証するために、プロジェクト固有の用語を含むマークダウンファイル（`@glossary.md`）へのパス。 |
-
-## config.yaml の例
-
-以下は、完全な設定ファイルの例です。このファイルを直接編集して、いつでも設定を変更できます。
-
-```yaml config.yaml の例 icon=logos:yaml
+```yaml Example config.yaml icon=logos:yaml
 # ドキュメント公開のためのプロジェクト情報
 projectName: AIGNE DocSmith
-projectDesc: AI駆動のドキュメント生成ツール。
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
+projectDesc: AIGNE DocSmithは、AIGNEフレームワーク上に構築された強力なAI駆動のドキュメント生成ツールです。ソースコードから直接、詳細で構造化された多言語のドキュメント作成を自動化します。
+projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
 
 # =============================================================================
 # ドキュメント設定
 # =============================================================================
 
-# 目的: 読者に達成してもらいたい主な成果は何か？
-# オプション: getStarted, completeTasks, findAnswers, understandSystem, solveProblems, mixedPurpose
+# 目的: 読者に達成してもらいたい主な成果は何ですか？
+# 利用可能なオプション（必要に応じてコメントを解除し、変更してください）：
+#   getStarted       - 迅速な開始：新規ユーザーが30分未満でゼロから作業を開始できるように支援します
+#   completeTasks    - 特定のタスクの完了：一般的なワークフローとユースケースを通じてユーザーをガイドします
+#   findAnswers      - 迅速な回答の検索：すべての機能とAPIに対して検索可能なリファレンスを提供します
+#   understandSystem - システムの理解：システムの仕組み、設計上の決定理由を説明します
+#   solveProblems    - 問題の解決：ユーザーのトラブルシューティングと問題修正を支援します
+#   mixedPurpose     - 上記の混合：複数のニーズをカバーする包括的なドキュメント
 documentPurpose:
+  - getStarted
   - completeTasks
-  - findAnswers
 
-# 対象読者: これを最も頻繁に読むのは誰か？
-# オプション: endUsers, developers, devops, decisionMakers, supportTeams, mixedTechnical
+# 対象読者: 主に誰がこれを読みますか？
+# 利用可能なオプション（必要に応じてコメントを解除し、変更してください）：
+#   endUsers         - エンドユーザー（非技術者）：製品を使用するがコーディングはしない人々
+#   developers       - 統合開発者：これを自分のプロジェクトに追加するエンジニア
+#   devops           - DevOps/インフラストラクチャ：システムをデプロイ、監視、維持するチーム
+#   decisionMakers   - 技術的な意思決定者：実装を評価または計画するアーキテクト、リーダー
+#   supportTeams     - サポートチーム：他者が製品を使用するのを助ける人々
+#   mixedTechnical   - 混合技術者層：開発者、DevOps、および技術ユーザー
 targetAudienceTypes:
-  - developers
-
-# 読者の知識レベル: 読者は通常、到着時に何を知っているか？
-# オプション: completeBeginners, domainFamiliar, experiencedUsers, emergencyTroubleshooting, exploringEvaluating
-readerKnowledgeLevel: domainFamiliar
-
-# ドキュメントの深さ: ドキュメントはどれだけ包括的であるべきか？
-# オプション: essentialOnly, balancedCoverage, comprehensive, aiDecide
-documentationDepth: balancedCoverage
+  - endUsers
+
+# 読者の知識レベル: 読者が訪れたときに通常何を知っていますか？
+# 利用可能なオプション（必要に応じてコメントを解除し、変更してください）：
+#   completeBeginners    - 完全な初心者：この分野/技術に全く新しい人々
+#   domainFamiliar       - 分野に精通、ツールは初めて：問題領域は知っているが、この特定のソリューションは初めて
+#   experiencedUsers     - 経験豊富なユーザー：リファレンス/高度なトピックを必要とする通常のユーザー
+#   emergencyTroubleshooting - 緊急/トラブルシューティング：何かが壊れており、迅速に修正する必要がある
+#   exploringEvaluating  - 探索/評価：これが自分のニーズに合うかどうかを理解しようとしている
+readerKnowledgeLevel: completeBeginners
+
+# ドキュメントの深さ: ドキュメントはどの程度包括的であるべきですか？
+# 利用可能なオプション（必要に応じてコメントを解除し、変更してください）：
+#   essentialOnly      - 必須事項のみ：80%のユースケースをカバーし、簡潔に保つ
+#   balancedCoverage   - バランスの取れたカバレッジ：実践的な例を伴う適切な深さ [推奨]
+#   comprehensive      - 包括的：すべての機能、エッジケース、および高度なシナリオをカバーする
+#   aiDecide           - AIに決定させる：コードの複雑さを分析し、適切な深さを提案する
+documentationDepth: comprehensive
 
 # カスタムルール: 特定のドキュメント生成ルールと要件を定義します
-rules: |+
-  
+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: |+
-  
-
-# 用語集: プロジェクト固有の用語と定義を含むマークダウンファイルへのパス
-# glossary: "@glossary.md"
+targetAudience: |
 
-# ドキュメントの主要言語
 locale: en
-
-# ドキュメントを翻訳する言語のリスト
-# translateLanguages:
-#   - zh
-#   - fr
-
-# 生成されたドキュメントを保存するディレクトリ
-docsDir: .aigne/doc-smith/docs
-
-# 分析するソースコードのパス
-sourcesPath:
-  - ./
+translateLanguages:
+  - zh
+  - zh-TW
+  - ja
+docsDir: ./docs  # 生成されたドキュメントを保存するディレクトリ
+sourcesPath:  # 分析するソースコードのパス
+  - ./README.md
+  - ./CHANGELOG.md
+  - ./aigne.yaml
+  - ./agents
+  - ./media.md
+  - ./.aigne/doc-smith/config.yaml
 ```
 
-設定が完了したら、プロジェクトのニーズに合ったドキュメントを作成する準備ができました。次のステップは、生成コマンドを実行することです。
+## まとめ
+
+設定が完了すると、ツールはプロジェクト、対象読者、ドキュメントの目標を明確に理解し、より正確で関連性の高いコンテンツが生成されます。
 
-➡️ **次へ:** [ドキュメントの生成](./features-generate-documentation.md)
+プロジェクトの設定を開始するには、[初期設定](./configuration-initial-setup.md) ガイドに進んでください。

package/docs/configuration.md

@@ -1,212 +1,96 @@
-# Configuration Guide
+# Configuration
 
-AIGNE DocSmith's behavior is controlled by a central configuration file, `.aigne/doc-smith/config.yaml`. This file allows you to customize the style, target audience, languages, and structure of your documentation to meet your specific needs.
+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.
 
-You can create and manage this file using the interactive setup wizard by running `aigne doc init`. For a step-by-step walkthrough, please refer to the [Interactive Setup](./configuration-interactive-setup.md) guide. Alternatively, you can edit the file directly for more granular control.
+This section provides an overview of how to configure the tool. For step-by-step instructions, please refer to the following detailed guides:
 
-The following diagram illustrates the configuration workflow:
-
-```d2 Configuration Workflow
-direction: down
-
-User: {
-  shape: person
-}
-
-CLI: {
-  label: "Run Command\n'aigne doc init'"
-  shape: rectangle
-}
-
-Setup-Wizard: {
-  label: "Interactive Setup Wizard"
-  shape: rectangle
-}
-
-Config-File: {
-  label: ".aigne/doc-smith/config.yaml"
-  shape: rectangle
-}
-
-AIGNE-DocSmith-Engine: {
-  label: "AIGNE DocSmith Engine"
-}
-
-# Path 1: Interactive Setup (Recommended)
-User -> CLI: "Recommended Path"
-CLI -> Setup-Wizard: "Launches"
-Setup-Wizard -> Config-File: "Creates / Modifies"
-
-# Path 2: Manual Editing
-User -> Config-File: "Alternative Path:\nDirectly Edits"
-
-# Final Step
-Config-File -> AIGNE-DocSmith-Engine: "Configures"
-```
-
-## Core Configuration Areas
-
-Your documentation is shaped by several key areas of configuration. Explore these guides to understand how to fine-tune each aspect of the generation process.
-
-<x-cards data-columns="2">
-  <x-card data-title="Interactive Setup" data-icon="lucide:wand-2" data-href="/configuration/interactive-setup">
-    Learn about the guided wizard that helps you configure your documentation project, including setting recommendations and conflict detection.
-  </x-card>
-  <x-card data-title="LLM Setup" data-icon="lucide:brain-circuit" data-href="/configuration/llm-setup">
-    Discover how to connect different AI models, including using the built-in AIGNE Hub which requires no API keys.
-  </x-card>
-  <x-card data-title="Language Support" data-icon="lucide:languages" data-href="/configuration/language-support">
-    See the full list of supported languages and learn how to set a primary language and enable automatic translations.
-  </x-card>
-  <x-card data-title="Managing Preferences" data-icon="lucide:sliders-horizontal" data-href="/configuration/preferences">
-    Understand how DocSmith uses your feedback to create persistent rules and how to manage them via the CLI.
-  </x-card>
+<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>
 
-## Parameter Reference
-
-The `config.yaml` file contains several key-value pairs that control the documentation output. Below is a detailed reference for each parameter.
-
-### Project Information
-
-These settings provide basic context about your project, which is used when publishing the documentation.
-
-| Parameter | Description |
-|---|---|
-| `projectName` | The name of your project. Detected from `package.json` if available. |
-| `projectDesc` | A short description of your project. Detected from `package.json`. |
-| `projectLogo` | A path or URL to your project's logo image. |
-
-### Documentation Strategy
-
-These parameters define the tone, style, and depth of the generated content.
-
-#### `documentPurpose`
-Defines the main outcome you want readers to achieve. This setting influences the overall structure and focus of the documentation.
+## The `config.yaml` File
 
-| 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. |
-| `understandSystem`| Understand the system | Explain how it works and why design decisions were made. |
-| `solveProblems` | Troubleshoot common issues | Help users troubleshoot and fix issues. |
-| `mixedPurpose` | Serve multiple purposes | Documentation covering multiple needs. |
+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.
 
-#### `targetAudienceTypes`
-Defines who will be reading this documentation most often. This choice affects the writing style and examples.
-
-| Option | Name | Description |
-|---|---|---|
-| `endUsers` | End users (non-technical) | People who use the product but don't code. |
-| `developers` | Developers integrating your product/API | Engineers adding this to their projects. |
-| `devops` | DevOps / SRE / Infrastructure teams | Teams deploying, monitoring, and maintaining systems. |
-| `decisionMakers`| Technical decision makers | Architects or leads evaluating or planning implementation. |
-| `supportTeams` | Support teams | People helping others use the product. |
-| `mixedTechnical`| Mixed technical audience | Developers, DevOps, and other technical users. |
-
-#### `readerKnowledgeLevel`
-Defines what readers typically know when they arrive. This adjusts how much foundational knowledge is assumed.
-
-| Option | Name | Description |
-|---|---|---|
-| `completeBeginners` | Is a total beginner, starting from scratch | New to this domain/technology entirely. |
-| `domainFamiliar` | Has used similar tools before | Knows the problem space, but new to this specific solution. |
-| `experiencedUsers` | Is an expert trying to do something specific | Regular users needing reference or advanced topics. |
-| `emergencyTroubleshooting`| Emergency/troubleshooting | Something is broken and needs to be fixed quickly. |
-| `exploringEvaluating` | Is evaluating this tool against others | Trying to understand if this fits their needs. |
-
-#### `documentationDepth`
-Defines how comprehensive the documentation should be.
-
-| Option | Name | Description |
-|---|---|---|
-| `essentialOnly` | Essential only | Cover the 80% use cases, keeping 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. |
-
-### Custom Directives
-
-For more granular control, you can provide free-text instructions.
-
-| Parameter | Description |
-|---|---|
-| `rules` | A multi-line string where you can define specific documentation generation rules (e.g., "Always include performance benchmarks"). |
-| `targetAudience`| A multi-line string to describe your specific target audience in more detail than the presets allow. |
-
-### Language and Path Configuration
-
-These settings control localization and file locations.
-
-| Parameter | Description |
-|---|---|
-| `locale` | The primary language for the documentation (e.g., `en`, `zh`). |
-| `translateLanguages` | A list of language codes to translate the documentation into (e.g., `[ja, fr, es]`). |
-| `docsDir` | The directory where generated documentation files will be saved. |
-| `sourcesPath` | A list of source code paths or glob patterns for DocSmith to analyze (e.g., `['./src', './lib/**/*.js']`). |
-| `glossary` | Path to a markdown file (`@glossary.md`) containing project-specific terms to ensure consistent translations. |
-
-## Example `config.yaml`
-
-Here is an example of a complete configuration file. You can edit this file directly to change 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: An AI-driven documentation generation tool.
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
+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 is the main outcome you want readers to achieve?
-# Options: getStarted, completeTasks, findAnswers, understandSystem, solveProblems, mixedPurpose
+# 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
-  - findAnswers
 
 # Target Audience: Who will be reading this most often?
-# Options: endUsers, developers, devops, decisionMakers, supportTeams, mixedTechnical
+# 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:
-  - developers
+  - endUsers
 
 # Reader Knowledge Level: What do readers typically know when they arrive?
-# Options: completeBeginners, domainFamiliar, experiencedUsers, emergencyTroubleshooting, exploringEvaluating
-readerKnowledgeLevel: domainFamiliar
+# 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?
-# Options: essentialOnly, balancedCoverage, comprehensive, aiDecide
-documentationDepth: balancedCoverage
+# 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: |+
-  
+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: |+
-  
-
-# Glossary: Path to markdown file containing project-specific terms and definitions
-# glossary: "@glossary.md"
+targetAudience: |
 
-# Primary language for the documentation
 locale: en
-
-# List of languages to translate the documentation into
-# translateLanguages:
-#   - zh
-#   - fr
-
-# Directory to save generated documentation
-docsDir: .aigne/doc-smith/docs
-
-# Source code paths to analyze
-sourcesPath:
-  - ./
+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
 ```
 
-With your configuration set, you are ready to create documentation that matches your project's needs. The next step is to run the generation command.
+## 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.
 
-➡️ **Next:** [Generate Documentation](./features-generate-documentation.md)
+To begin setting up your project, proceed to the [Initial Setup](./configuration-initial-setup.md) guide.