@aigne/doc-smith 0.8.10-beta → 0.8.10-beta.1

package/docs/configuration-llm-setup.md

@@ -1,17 +1,18 @@
 # LLM Setup
 
-AIGNE DocSmith uses Large Language Models (LLMs) to generate documentation content. The tool provides two primary methods for configuring your AI model provider: using the integrated AIGNE Hub for a streamlined experience, or connecting your own custom API keys for direct provider access.
+AIGNE DocSmith uses Large Language Models (LLMs) to generate documentation content. You can configure the AI model provider in two ways: using the integrated AIGNE Hub, or by connecting your own custom API keys.
 
 ## AIGNE Hub (Recommended)
 
-The simplest way to get started is with AIGNE Hub. It acts as a gateway to multiple LLM providers, offering two key advantages:
+The most direct way to start is with AIGNE Hub. It functions as a gateway to multiple LLM providers, offering two main benefits:
 
-- **No API Key Required:** Generate documents without needing to manage your own API keys or service subscriptions.
-- **Easy Model Switching:** Change the AI model for any command using a simple flag.
+- **No API Key Required:** You can generate documents without managing your own API keys or service subscriptions.
+- **Easy Model Switching:** You can change the AI model for any command by using the `--model` flag.
 
 To use a specific model through AIGNE Hub, add the `--model` flag to your command. Here are a few examples:
 
-```bash Use Google's Gemini 2.5 Flash model
+```bash Using Different Models via AIGNE Hub icon=mdi:code-braces
+# Use Google's Gemini 2.5 Flash model
 aigne doc generate --model google:gemini-2.5-flash
 
 # Use Anthropic's Claude 3.5 Sonnet model
@@ -21,33 +22,33 @@ aigne doc generate --model claude:claude-3-5-sonnet
 aigne doc generate --model openai:gpt-4o
 ```
 
-If you don't specify a model, DocSmith will use the default model defined in your project's configuration.
+If you do not specify a model, DocSmith will use the default model defined in your project's configuration.
 
 ## Using Custom API Keys
 
-If you prefer to use your own accounts with providers like OpenAI or Anthropic, you can configure DocSmith with your personal API keys. This gives you direct control over API usage and billing.
+If you prefer to use your own accounts with providers like OpenAI or Anthropic, you can configure DocSmith with your personal API keys. This method gives you direct control over API usage and billing.
 
-Configuration is handled through an interactive wizard. To launch it, run:
+Configuration is handled through an interactive wizard. To launch it, run the following command:
 
 ```bash
 aigne doc init
 ```
 
-The wizard will prompt you to select your provider and enter your credentials. For a complete guide, please see the [Interactive Setup](./configuration-interactive-setup.md) documentation.
+The wizard will prompt you to select your provider and enter your credentials. For a complete guide, refer to the [Interactive Setup](./configuration-interactive-setup.md) documentation.
 
 ## Setting a Default Model
 
-To ensure consistency across all documentation generation tasks, you can set a default LLM in your project's `aigne.yaml` configuration file. This model will be used automatically unless you override it with the `--model` flag.
+To maintain consistency across all documentation generation tasks, you can set a default LLM in your project's `aigne.yaml` configuration file. This model will be used for any command that does not include the `--model` flag.
 
-```yaml aigne.yaml icon=mdi:file-document
+```yaml aigne.yaml icon=mdi:file-code
 chat_model:
   provider: google
   name: gemini-2.5-pro
   temperature: 0.8
 ```
 
-In this configuration, DocSmith defaults to using Google's `gemini-2.5-pro` model with a `temperature` of `0.8` for all generation tasks.
+In this example, DocSmith is configured to use Google's `gemini-2.5-pro` model with a `temperature` setting of `0.8` by default.
 
 ---
 
-Now that your LLM provider is configured, you can explore how to manage translations for your documentation. Proceed to the [Language Support](./configuration-language-support.md) guide to see the full list of supported languages and learn how to enable them.
+With your LLM provider configured, you are ready to manage language settings for your documentation. Proceed to the [Language Support](./configuration-language-support.md) guide to see the full list of supported languages and learn how to enable them.

package/docs/configuration-llm-setup.zh.md

@@ -1,17 +1,18 @@
 # LLM 设置
 
-AIGNE DocSmith 使用大型语言模型 (LLMs) 生成文档内容。该工具提供两种配置 AI 模型提供商的主要方法：使用集成的 AIGNE Hub 以获得简化的体验，或连接你自己的自定义 API 密钥以直接访问提供商。
+AIGNE DocSmith 使用大语言模型 (LLM) 生成文档内容。你可以通过两种方式配置 AI 模型提供商：使用集成的 AIGNE Hub，或连接你自己的自定义 API 密钥。
 
-## AIGNE Hub (推荐)
+## AIGNE Hub（推荐）
 
-最简单的入门方法是使用 AIGNE Hub。它充当多个 LLM 提供商的网关，提供两大关键优势：
+最直接的入门方式是使用 AIGNE Hub。它作为一个通往多个 LLM 提供商的网关，提供两大主要优势：
 
-- **无需 API 密钥：** 无需管理自己的 API 密钥或服务订阅即可生成文档。
-- **轻松切换模型：** 使用一个简单的标志即可为任何命令更改 AI 模型。
+- **无需 API 密钥：** 你无需管理自己的 API 密钥或服务订阅即可生成文档。
+- **轻松切换模型：** 你可以通过使用 `--model` 标志为任何命令更改 AI 模型。
 
-要通过 AIGNE Hub 使用特定模型，请在命令中添加 `--model` 标志。以下是一些示例：
+要通过 AIGNE Hub 使用特定模型，请在命令中添加 `--model` 标志。以下是几个示例：
 
-```bash 使用 Google 的 Gemini 2.5 Flash 模型
+```bash 通过 AIGNE Hub 使用不同模型 icon=mdi:code-braces
+# 使用 Google 的 Gemini 2.5 Flash 模型
 aigne doc generate --model google:gemini-2.5-flash
 
 # 使用 Anthropic 的 Claude 3.5 Sonnet 模型
@@ -21,33 +22,33 @@ aigne doc generate --model claude:claude-3-5-sonnet
 aigne doc generate --model openai:gpt-4o
 ```
 
-如果不指定模型，DocSmith 将使用项目配置中定义的默认模型。
+如果你未指定模型，DocSmith 将使用项目配置中定义的默认模型。
 
 ## 使用自定义 API 密钥
 
-如果你更喜欢使用自己在 OpenAI 或 Anthropic 等提供商处的账户，可以用个人 API 密钥来配置 DocSmith。这样你就可以直接控制 API 的使用和计费。
+如果你更喜欢使用自己在 OpenAI 或 Anthropic 等提供商处的账户，可以用你的个人 API 密钥来配置 DocSmith。这种方法让你能够直接控制 API 的使用和计费。
 
-配置通过交互式向导完成。运行以下命令以启动它：
+配置通过一个交互式向导进行处理。要启动它，请运行以下命令：
 
 ```bash
 aigne doc init
 ```
 
-该向导将提示你选择提供商并输入凭据。有关完整指南，请参阅 [交互式设置](./configuration-interactive-setup.md) 文档。
+向导将提示你选择提供商并输入凭据。有关完整指南，请参阅 [交互式设置](./configuration-interactive-setup.md) 文档。
 
 ## 设置默认模型
 
-为确保所有文档生成任务的一致性，你可以在项目的 `aigne.yaml` 配置文件中设置默认的 LLM。除非使用 `--model` 标志覆盖，否则将自动使用此模型。
+为了在所有文档生成任务中保持一致性，你可以在项目的 `aigne.yaml` 配置文件中设置一个默认的 LLM。任何不包含 `--model` 标志的命令都将使用此模型。
 
-```yaml aigne.yaml icon=mdi:file-document
+```yaml aigne.yaml icon=mdi:file-code
 chat_model:
   provider: google
   name: gemini-2.5-pro
   temperature: 0.8
 ```
 
-在此配置中，DocSmith 默认对所有生成任务使用 Google 的 `gemini-2.5-pro` 模型，并将 `temperature` 设置为 `0.8`。
+在此示例中，DocSmith 被配置为默认使用 Google 的 `gemini-2.5-pro` 模型，并将 `temperature` 设置为 `0.8`。
 
 ---
 
-既然你的 LLM 提供商已配置完毕，你可以探索如何管理文档的翻译。请继续阅读 [语言支持](./configuration-language-support.md) 指南，查看支持的语言完整列表并了解如何启用它们。
+配置好 LLM 提供商后，你就可以管理文档的语言设置了。请继续阅读 [语言支持](./configuration-language-support.md) 指南，查看支持的语言完整列表并了解如何启用它们。

package/docs/configuration-preferences.md

@@ -4,7 +4,7 @@ AIGNE DocSmith is designed to learn from your feedback. When you refine or corre
 
 ## The Preference Lifecycle
 
-The following diagram illustrates how your feedback becomes a reusable rule that can be applied to future tasks and managed via the command line.
+The following diagram illustrates how your feedback becomes a reusable rule that can be applied to future tasks and managed from the command line.
 
 ```d2 The Preference Lifecycle
 direction: down
@@ -48,23 +48,23 @@ cli <-> pref_file: "Manages"
 
 ```
 
-### How DocSmith Learns from Feedback
+### How Preferences are Created
 
-When you provide feedback during the `refine` or `translate` stages, an internal agent called the 'Feedback Refiner' analyzes your input. Its goal is to distinguish between a one-time fix (e.g., correcting a typo) and a reusable policy (e.g., "always write code comments in English"). If it determines the feedback represents a lasting instruction, it creates a new preference rule.
+When you provide feedback during the `refine` or `translate` stages, an internal agent analyzes your input. It determines if the feedback is a one-time fix (e.g., correcting a typo) or a reusable policy (e.g., "always write code comments in English"). If it represents a lasting instruction, it creates a new preference rule.
 
-Each rule has several key properties that define its behavior:
+### Rule Properties
 
-| Property | Description |
-|---|---|
-| **id** | A unique identifier for the rule (e.g., `pref_a1b2c3d4`). |
-| **active** | A boolean (`true`/`false`) indicating if the rule is currently enabled. |
-| **scope** | Defines when the rule should be applied: `global`, `structure`, `document`, or `translation`. |
-| **rule** | The instruction that will be passed to the AI in future tasks. |
-| **feedback** | The original natural language feedback you provided. |
-| **createdAt** | The ISO 8601 timestamp of when the rule was created. |
-| **paths** | An optional list of file paths. If present, the rule only applies to content generated for those specific paths. |
+Each rule saved in `preferences.yml` has the following structure:
 
-## Managing Preferences via the CLI
+<x-field data-name="id" data-type="string" data-desc="A unique, randomly generated identifier for the rule (e.g., pref_a1b2c3d4e5f6g7h8)."></x-field>
+<x-field data-name="active" data-type="boolean" data-desc="Indicates if the rule is currently enabled. Inactive rules are ignored during generation tasks."></x-field>
+<x-field data-name="scope" data-type="string" data-desc="Defines when the rule should be applied. Valid scopes are 'global', 'structure', 'document', or 'translation'."></x-field>
+<x-field data-name="rule" data-type="string" data-desc="The specific, distilled instruction that will be passed to the AI in future tasks."></x-field>
+<x-field data-name="feedback" data-type="string" data-desc="The original, natural language feedback provided by the user, preserved for reference."></x-field>
+<x-field data-name="createdAt" data-type="string" data-desc="The ISO 8601 timestamp indicating when the rule was created."></x-field>
+<x-field data-name="paths" data-type="string[]" data-required="false" data-desc="An optional list of file paths. If present, the rule only applies to content generated for these specific source files."></x-field>
+
+## Managing Preferences with the CLI
 
 You can view and manage all your saved preferences using the `aigne doc prefs` command. This allows you to list, activate, deactivate, or permanently remove rules.
 
@@ -76,9 +76,7 @@ To see all saved preferences, both active and inactive, use the `--list` flag.
 aigne doc prefs --list
 ```
 
-The command displays a formatted list explaining the status, scope, ID, and any path limitations for each rule.
-
-**Example Output:**
+The command displays a formatted list showing the status, scope, ID, and any path limitations for each rule.
 
 ```text Example Output icon=lucide:clipboard-list
 # User Preferences
@@ -94,20 +92,17 @@ The command displays a formatted list explaining the status, scope, ID, and any
  
 ⚪ [document] pref_i9j0k1l2m3n4o5p6
    Code comments must be written in English.
- 
 ```
 
-### Toggling Preference Status
-
-If you want to temporarily disable a rule without deleting it, you can toggle its active status. Use the `--toggle` flag.
+### Deactivating and Reactivating Preferences
 
-Running the command without an ID will launch an interactive mode, allowing you to select one or more preferences to toggle:
+If you want to temporarily disable a rule without deleting it, you can toggle its active status using the `--toggle` flag. Running the command without an ID will launch an interactive mode, allowing you to select one or more preferences to toggle.
 
 ```bash Toggle preferences interactively icon=lucide:terminal
 aigne doc prefs --toggle
 ```
 
-To toggle specific rules directly, provide their IDs using the `--id` flag:
+To toggle a specific rule directly, provide its ID using the `--id` flag. This corresponds to the `deactivateRule` function, which sets the rule's `active` property to `false`.
 
 ```bash Toggle a specific preference icon=lucide:terminal
 aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
@@ -115,15 +110,15 @@ aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
 
 ### Removing Preferences
 
-To permanently delete one or more preferences, use the `--remove` flag. This action cannot be undone.
+To permanently delete one or more preferences, use the `--remove` flag. This action, which corresponds to the `removeRule` function, cannot be undone.
 
-For an interactive selection prompt, run the command without an ID:
+For an interactive selection prompt, run the command without an ID.
 
 ```bash Remove preferences interactively icon=lucide:terminal
 aigne doc prefs --remove
 ```
 
-To remove specific rules directly by their ID, use the `--id` flag:
+To remove a specific rule directly by its ID, use the `--id` flag.
 
 ```bash Remove a specific preference icon=lucide:terminal
 aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
@@ -131,4 +126,4 @@ aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
 
 ## Next Steps
 
-Managing preferences is a key part of tailoring DocSmith to your project's specific needs. For more customization options, explore the main [Configuration Guide](./configuration.md).
+Managing preferences is a key part of tailoring DocSmith to your project's specific needs. For more customization options, explore the main [Configuration Guide](./configuration.md).

package/docs/configuration-preferences.zh.md

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

package/docs/configuration.md

@@ -1,6 +1,6 @@
 # Configuration Guide
 
-AIGNE DocSmith's behavior is controlled by a central file, `config.yaml`, typically located at `.aigne/doc-smith/config.yaml`. This file dictates the style, target audience, languages, and structure of your documentation.
+AIGNE DocSmith's behavior is controlled by a central file, `config.yaml`, located at `.aigne/doc-smith/config.yaml`. This file dictates the style, target audience, languages, and structure of your documentation.
 
 You can create and manage this file using the interactive setup wizard by running `aigne doc init`. For a step-by-step walkthrough, see the [Interactive Setup](./configuration-interactive-setup.md) guide.
 
@@ -10,7 +10,7 @@ Your documentation is shaped by several key areas of configuration. Explore thes
 
 <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 from scratch, including setting recommendations.
+    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.
@@ -33,8 +33,8 @@ These settings provide basic context about your project, which is used when publ
 
 | Parameter | Description |
 |---|---|
-| `projectName` | The name of your project. Automatically detected from `package.json` if available. |
-| `projectDesc` | A short description of your project. Automatically detected from `package.json`. |
+| `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
@@ -42,7 +42,7 @@ These settings provide basic context about your project, which is used when publ
 These parameters define the tone, style, and depth of the generated content.
 
 #### `documentPurpose`
-What is the main outcome you want readers to achieve? This setting influences the overall structure and focus of the documentation.
+Defines the main outcome you want readers to achieve. This setting influences the overall structure and focus of the documentation.
 
 | Option | Name | Description |
 |---|---|---|
@@ -54,7 +54,7 @@ What is the main outcome you want readers to achieve? This setting influences th
 | `mixedPurpose` | Serve multiple purposes | Documentation covering multiple needs. |
 
 #### `targetAudienceTypes`
-Who will be reading this documentation most often? This choice affects the writing style and examples.
+Defines who will be reading this documentation most often. This choice affects the writing style and examples.
 
 | Option | Name | Description |
 |---|---|---|
@@ -66,7 +66,7 @@ Who will be reading this documentation most often? This choice affects the writi
 | `mixedTechnical`| Mixed technical audience | Developers, DevOps, and other technical users. |
 
 #### `readerKnowledgeLevel`
-What do readers typically know when they arrive? This adjusts how much foundational knowledge is assumed.
+Defines what readers typically know when they arrive. This adjusts how much foundational knowledge is assumed.
 
 | Option | Name | Description |
 |---|---|---|
@@ -77,7 +77,7 @@ What do readers typically know when they arrive? This adjusts how much foundatio
 | `exploringEvaluating` | Is evaluating this tool against others | Trying to understand if this fits their needs. |
 
 #### `documentationDepth`
-How comprehensive should the documentation be?
+Defines how comprehensive the documentation should be.
 
 | Option | Name | Description |
 |---|---|---|
@@ -92,8 +92,8 @@ 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 and requirements (e.g., "Always include performance benchmarks"). |
-| `targetAudience`| A multi-line string to describe your specific target audience and their characteristics in more detail than the presets allow. |
+| `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
 
@@ -109,56 +109,35 @@ These settings control localization and file locations.
 
 ## Example `config.yaml`
 
-Here is an example of a complete configuration file with comments explaining each section. You can edit this file directly to change settings at any time.
+Here is an example of a complete configuration file. You can edit this file directly to change settings at any time.
 
 ```yaml Example config.yaml icon=logos:yaml
 # Project information for documentation publishing
 projectName: AIGNE DocSmith
-projectDesc: A powerful, AI-driven documentation generation tool.
+projectDesc: An AI-driven documentation generation tool.
 projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
 
 # =============================================================================
 # 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    - Troubleshoot common issues: Help users troubleshoot and fix issues
-#   mixedPurpose     - Serve multiple purposes: Comprehensive documentation covering multiple needs
+# Purpose: What is the main outcome you want readers to achieve?
+# Options: getStarted, completeTasks, findAnswers, understandSystem, solveProblems, mixedPurpose
 documentPurpose:
   - completeTasks
   - findAnswers
 
 # 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 your product/API: Engineers adding this to their projects
-#   devops           - DevOps / SRE / Infrastructure teams: 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
+# Options: endUsers, developers, devops, decisionMakers, supportTeams, mixedTechnical
 targetAudienceTypes:
   - developers
 
 # Reader Knowledge Level: What do readers typically know when they arrive?
-# Available options (uncomment and modify as needed):
-#   completeBeginners    - Is a total beginner, starting from scratch: New to this domain/technology entirely
-#   domainFamiliar       - Has used similar tools before: Know the problem space, new to this specific solution
-#   experiencedUsers     - Is an expert trying to do something specific: Regular users needing reference/advanced topics
-#   emergencyTroubleshooting - Emergency/troubleshooting: Something's broken, need to fix it quickly
-#   exploringEvaluating  - Is evaluating this tool against others: Trying to understand if this fits their needs
+# Options: completeBeginners, domainFamiliar, experiencedUsers, emergencyTroubleshooting, exploringEvaluating
 readerKnowledgeLevel: domainFamiliar
 
 # 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
+# Options: essentialOnly, balancedCoverage, comprehensive, aiDecide
 documentationDepth: balancedCoverage
 
 # Custom Rules: Define specific documentation generation rules and requirements
@@ -169,15 +148,22 @@ rules: |+
 targetAudience: |+
   
 
-# Glossary: Define project-specific terms and definitions
-# glossary: "@glossary.md"  # Path to markdown file containing glossary definitions
+# Glossary: Path to markdown file containing project-specific terms and definitions
+# glossary: "@glossary.md"
 
+# Primary language for the documentation
 locale: en
-# translateLanguages:  # List of languages to translate the documentation to
-#   - zh  # Example: Chinese translation
-#   - fr  # Example: French translation
-docsDir: .aigne/doc-smith/docs  # Directory to save generated documentation
-sourcesPath:  # Source code paths to analyze
+
+# 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:
   - ./
 ```