@aigne/doc-smith 0.8.3 → 0.8.5

package/docs/configuration-llm-setup.md

@@ -1,90 +1,53 @@
----
-labels: ["Reference"]
----
-
 # LLM Setup
 
-AIGNE DocSmith leverages Large Language Models (LLMs) to generate high-quality documentation. You can configure DocSmith to use different AI models through two primary methods: the recommended AIGNE Hub service or by providing your own custom API keys.
-
-This guide will walk you through both options.
-
-## Using AIGNE Hub (Recommended)
+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.
 
-The most straightforward way to use LLMs with DocSmith is through AIGNE Hub. This approach offers significant advantages:
+## AIGNE Hub (Recommended)
 
-- **No API Key Required:** You don't need to sign up for separate AI services or manage your own API keys.
-- **Easy Model Switching:** You can switch between different state-of-the-art models from providers like Google, Anthropic, and OpenAI with a simple command-line flag.
+The simplest way to get started is with AIGNE Hub. It acts as a gateway to multiple LLM providers, offering two key advantages:
 
-To specify a model, use the `--model` flag with the `generate` command. DocSmith will handle the API requests through the AIGNE Hub.
+- **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.
 
-### Examples
+To use a specific model through AIGNE Hub, add the `--model` flag to your command. Here are a few examples:
 
-Here are some examples of how to generate documentation using different models available via AIGNE Hub:
-
-**Using Google's Gemini 1.5 Flash:**
-```bash
+```bash Use Google's Gemini 2.5 Flash model
 aigne doc generate --model google:gemini-2.5-flash
-```
 
-**Using Anthropic's Claude 3.5 Sonnet:**
-```bash
+# Use Anthropic's Claude 3.5 Sonnet model
 aigne doc generate --model claude:claude-3-5-sonnet
-```
 
-**Using OpenAI's GPT-4o:**
-```bash
+# Use OpenAI's GPT-4o model
 aigne doc generate --model openai:gpt-4o
 ```
 
-## Configuring Custom API Keys
+If you don't 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 API keys for providers like OpenAI or Anthropic, you can configure them using the interactive setup wizard.
+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.
 
-Run the `init` command to launch the wizard, which will guide you through setting up your LLM provider and credentials, among other project settings.
+Configuration is handled through an interactive wizard. To launch it, run:
 
 ```bash
-# Launch the interactive configuration wizard
 aigne doc init
 ```
 
-This process ensures your keys are stored correctly for all subsequent documentation generation and update tasks.
-
-## How It Works
-
-The following diagram illustrates how DocSmith processes requests with different LLM configurations.
-
-```d2
-direction: down
+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.
 
-User: {
-  shape: person
-  label: "Developer"
-}
+## Setting a Default Model
 
-CLI: "`aigne doc generate`"
-
-DocSmith: {
-  shape: package
-  "Configuration Check": {
-    "AIGNE Hub (Default)": "No API Key Needed"
-    "Custom Provider": "User API Key Found"
-  }
-}
-
-LLM_Providers: {
-  label: "LLM Providers"
-  shape: cloud
-  "AIGNE Hub": "Manages access to multiple models"
-  "Direct API (e.g., OpenAI)": "Uses custom key"
-}
-
-User -> CLI: "Runs command"
-CLI -> DocSmith: "Initiates process"
-DocSmith."Configuration Check"."AIGNE Hub (Default)" -> LLM_Providers."AIGNE Hub" : "Routes request via Hub"
-DocSmith."Configuration Check"."Custom Provider" -> LLM_Providers."Direct API (e.g., OpenAI)" : "Routes request with user's key"
+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.
 
+```yaml aigne.yaml icon=mdi:file-document
+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.
+
 ---
 
-With your LLM provider configured, you are ready to customize language settings for your documentation. Learn more in the [Language Support](./configuration-language-support.md) guide.
+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.

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

@@ -1,90 +1,53 @@
----
-labels: ["Reference"]
----
-
 # LLM 设置
 
-AIGNE DocSmith 利用大型语言模型 (LLMs) 生成高质量的文档。你可以通过两种主要方法配置 DocSmith 以使用不同的 AI 模型：推荐的 AIGNE Hub 服务，或提供你自己的自定义 API 密钥。
-
-本指南将引导你了解这两种选项。
-
-## 使用 AIGNE Hub (推荐)
+AIGNE DocSmith 使用大型语言模型 (LLMs) 生成文档内容。该工具提供两种配置 AI 模型提供商的主要方法：使用集成的 AIGNE Hub 以获得简化的体验，或连接你自己的自定义 API 密钥以直接访问提供商。
 
-通过 AIGNE Hub 是将 DocSmith 与 LLMs 结合使用的最直接方法。该方法具有以下显著优势：
+## AIGNE Hub (推荐)
 
-- **无需 API 密钥：** 你无需注册单独的 AI 服务或管理自己的 API 密钥。
-- **轻松切换模型：** 你可以通过一个简单的命令行标志，在 Google、Anthropic 和 OpenAI 等提供商提供的不同顶尖模型之间进行切换。
+最简单的入门方法是使用 AIGNE Hub。它充当多个 LLM 提供商的网关，提供两大关键优势：
 
-要指定模型，请在 `generate` 命令中使用 `--model` 标志。DocSmith 将通过 AIGNE Hub 处理 API 请求。
+- **无需 API 密钥：** 无需管理自己的 API 密钥或服务订阅即可生成文档。
+- **轻松切换模型：** 使用一个简单的标志即可为任何命令更改 AI 模型。
 
-### 示例
+要通过 AIGNE Hub 使用特定模型，请在命令中添加 `--model` 标志。以下是一些示例：
 
-以下示例展示了如何通过 AIGNE Hub 使用不同的模型生成文档：
-
-**使用 Google 的 Gemini 1.5 Flash：**
-```bash
+```bash 使用 Google 的 Gemini 2.5 Flash 模型
 aigne doc generate --model google:gemini-2.5-flash
-```
 
-**使用 Anthropic 的 Claude 3.5 Sonnet：**
-```bash
+# 使用 Anthropic 的 Claude 3.5 Sonnet 模型
 aigne doc generate --model claude:claude-3-5-sonnet
-```
 
-**使用 OpenAI 的 GPT-4o：**
-```bash
+# 使用 OpenAI 的 GPT-4o 模型
 aigne doc generate --model openai:gpt-4o
 ```
 
-## 配置自定义 API 密钥
+如果不指定模型，DocSmith 将使用项目配置中定义的默认模型。
+
+## 使用自定义 API 密钥
 
-如果你希望为 OpenAI 或 Anthropic 等提供商使用自己的 API 密钥，可以通过交互式设置向导进行配置。
+如果你更喜欢使用自己在 OpenAI 或 Anthropic 等提供商处的账户，可以用个人 API 密钥来配置 DocSmith。这样你就可以直接控制 API 的使用和计费。
 
-运行 `init` 命令启动向导，它将指导你完成 LLM 提供商、凭据以及其他项目设置。
+配置通过交互式向导完成。运行以下命令以启动它：
 
 ```bash
-# 启动交互式配置向导
 aigne doc init
 ```
 
-该过程可确保你的密钥被正确存储，以便用于所有后续的文档生成和更新任务。
-
-## 工作原理
-
-下图说明了 DocSmith 在不同 LLM 配置下处理请求的流程。
-
-```d2
-direction: down
+该向导将提示你选择提供商并输入凭据。有关完整指南，请参阅 [交互式设置](./configuration-interactive-setup.md) 文档。
 
-User: {
-  shape: person
-  label: "开发者"
-}
+## 设置默认模型
 
-CLI: "`aigne doc generate`"
-
-DocSmith: {
-  shape: package
-  "配置检查": {
-    "AIGNE Hub (默认)": "无需 API 密钥"
-    "自定义提供商": "找到用户 API 密钥"
-  }
-}
-
-LLM_Providers: {
-  label: "LLM 提供商"
-  shape: cloud
-  "AIGNE Hub": "管理对多个模型的访问"
-  "直接 API (例如 OpenAI)": "使用自定义密钥"
-}
-
-User -> CLI: "运行命令"
-CLI -> DocSmith: "启动流程"
-DocSmith."配置检查"."AIGNE Hub (默认)" -> LLM_Providers."AIGNE Hub" : "通过 Hub 路由请求"
-DocSmith."配置检查"."自定义提供商" -> LLM_Providers."直接 API (例如 OpenAI)" : "使用用户密钥路由请求"
+为确保所有文档生成任务的一致性，你可以在项目的 `aigne.yaml` 配置文件中设置默认的 LLM。除非使用 `--model` 标志覆盖，否则将自动使用此模型。
 
+```yaml aigne.yaml icon=mdi:file-document
+chat_model:
+  provider: google
+  name: 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

@@ -1,60 +1,86 @@
----
-labels: ["Reference"]
----
-
 # Managing Preferences
 
-DocSmith is designed to learn from your feedback. When you refine documents and provide corrections, the system can convert that feedback into persistent, reusable rules called "preferences". This ensures that your stylistic choices, structural conventions, and specific instructions are remembered and applied consistently in future operations.
+AIGNE DocSmith is designed to learn from your feedback. When you refine or correct generated content, DocSmith can convert that feedback into persistent rules, called preferences. These rules ensure that your specific style, structural requirements, and content policies are applied consistently in future documentation tasks. All preferences are stored in a human-readable YAML file located at `.aigne/doc-smith/preferences.yml` in your project root.
 
-All preferences are stored in a human-readable YAML file located at `.aigne/doc-smith/preferences.yml` in your project root. While you can view this file, it's recommended to manage your preferences using the dedicated `aigne doc prefs` command-line interface.
+## The Preference Lifecycle
 
-## How Preferences Are Created
+The following diagram illustrates how your feedback becomes a reusable rule that can be applied to future tasks and managed via the command line.
 
-Preferences are automatically generated during the feedback cycle of commands like `aigne doc refine`. The process works as follows:
+```d2 The Preference Lifecycle
+direction: down
 
-```d2
-direction: right
+feedback: {
+  label: "1. User provides feedback\nduring 'refine' or 'translate'"
+  shape: rectangle
+}
 
-User: {
-  shape: person
+refiner: {
+  label: "2. Feedback Refiner Agent\nAnalyzes feedback"
+  shape: rectangle
 }
 
-Refine: "`aigne doc refine` command"
+decision: {
+  label: "Is it a reusable policy?"
+  shape: diamond
+}
 
-FeedbackRefiner: "Feedback→Rule Converter"
+pref_file: {
+  label: "3. preferences.yml\nRule is saved"
+  shape: cylinder
+}
 
-PreferencesFile: "preferences.yml" {
-  shape: document
+future_tasks: {
+  label: "4. Future Tasks\nSaved rules are applied"
+  shape: rectangle
 }
 
-User -> Refine: "Provide feedback, e.g., 'Don't translate variable names'"
-Refine -> FeedbackRefiner: "Sends feedback for analysis"
-FeedbackRefiner -> PreferencesFile: "Saves new, reusable rule" {
-  style.animated: true
+cli: {
+  label: "5. CLI Management\n('aigne doc prefs')"
+  shape: rectangle
 }
 
+feedback -> refiner: "Input"
+refiner -> decision: "Analyzes"
+decision -> pref_file: "Yes"
+decision -> "Discard (One-time fix)": "No"
+pref_file -> future_tasks: "Applies to"
+cli <-> pref_file: "Manages"
+
 ```
 
-1.  **Feedback Input**: You provide natural language feedback during a refinement session.
-2.  **Rule Generation**: An internal agent analyzes your feedback to determine if it represents a reusable policy rather than a one-time fix.
-3.  **Rule Creation**: If deemed reusable, it creates a structured rule with a specific scope (e.g., `document`, `translation`), a unique ID, and the instruction itself.
-4.  **Persistence**: The new rule is saved to the `preferences.yml` file, making it active for future tasks.
+### How DocSmith Learns from Feedback
+
+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.
+
+Each rule has several key properties that define its behavior:
+
+| 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. |
 
-## Managing Preferences via CLI
+## Managing Preferences via the CLI
 
-The `aigne doc prefs` command is your primary tool for viewing and managing all saved preferences.
+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.
 
-### List All Preferences
+### Listing All Preferences
 
-To see a formatted list of all your preferences, use the `--list` flag.
+To see all saved preferences, both active and inactive, use the `--list` flag.
 
-```bash
+```bash List all preferences icon=lucide:terminal
 aigne doc prefs --list
 ```
 
-The output provides a clear overview of each rule:
+The command displays a formatted list explaining the status, scope, ID, and any path limitations for each rule.
 
-```text
+**Example Output:**
+
+```text Example Output icon=lucide:clipboard-list
 # User Preferences
 
 **Format explanation:**
@@ -63,60 +89,46 @@ The output provides a clear overview of each rule:
 - ID = Unique preference identifier
 - Paths = Specific file paths (if applicable)
 
-🟢 [translation] pref_1a2b3c4d
-   Keep code and identifiers unchanged during translation, must not translate them.
-
-⚪ [structure] pref_5e6f7g8h | Paths: overview.md, tutorials.md
-   Add 'Next Steps' section at the end of overview and tutorial documents with 2-3 links within the repository.
+🟢 [structure] pref_a1b2c3d4e5f6g7h8 | Paths: overview.md
+   Add a 'Next Steps' section at the end of overview documents.
+ 
+⚪ [document] pref_i9j0k1l2m3n4o5p6
+   Code comments must be written in English.
+ 
 ```
 
-- **Status (🟢 / ⚪)**: Shows whether a rule is currently active or inactive.
-- **Scope**: Indicates where the rule applies (e.g., `translation`, `structure`).
-- **ID**: A unique identifier used to manage the rule.
-- **Paths**: If a rule is limited to specific files, they will be listed here.
-
-### Toggle Preference Status
-
-You can activate or deactivate preferences using the `--toggle` flag. This is useful for temporarily disabling a rule without deleting it permanently.
+### Toggling Preference Status
 
-**Interactive Mode**
+If you want to temporarily disable a rule without deleting it, you can toggle its active status. Use the `--toggle` flag.
 
-If you run the command without specifying an ID, an interactive prompt will appear, allowing you to select multiple rules to toggle.
+Running the command without an ID will launch an interactive mode, allowing you to select one or more preferences to toggle:
 
-```bash
+```bash Toggle preferences interactively icon=lucide:terminal
 aigne doc prefs --toggle
 ```
 
-**By ID**
+To toggle specific rules directly, provide their IDs using the `--id` flag:
 
-To toggle specific rules, provide their IDs using the `--id` option.
-
-```bash
-aigne doc prefs --toggle --id pref_5e6f7g8h
+```bash Toggle a specific preference icon=lucide:terminal
+aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
 ```
 
-### Remove Preferences
-
-To permanently delete one or more preferences, use the `--remove` flag.
+### Removing Preferences
 
-**Interactive Mode**
+To permanently delete one or more preferences, use the `--remove` flag. This action cannot be undone.
 
-Running the command without an ID will launch an interactive selection prompt.
+For an interactive selection prompt, run the command without an ID:
 
-```bash
+```bash Remove preferences interactively icon=lucide:terminal
 aigne doc prefs --remove
 ```
 
-**By ID**
+To remove specific rules directly by their ID, use the `--id` flag:
 
-To remove a specific rule, pass its ID.
-
-```bash
-aigne doc prefs --remove --id pref_1a2b3c4d
+```bash Remove a specific preference icon=lucide:terminal
+aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
 ```
 
-This action is irreversible, so use it with care.
-
----
+## Next Steps
 
-By managing your preferences, you can fine-tune DocSmith's behavior over time, making the documentation process increasingly automated and aligned with your project's specific needs. To see how feedback is provided, you can learn more in the [Update and Refine](./features-update-and-refine.md) guide.
+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,123 +1,134 @@
----
-labels: ["Reference"]
----
-
 # 管理偏好
 
-DocSmith 旨在通过您的反馈进行学习。当您优化文档并提供更正时，系统可以将这些反馈转化为称为“偏好”的持久、可重用的规则。这确保了您的风格选择、结构约定和具体指令在未来的操作中能够被记住并一致地应用。
+AIGNE DocSmith 旨在从您的反馈中学习。当您优化或更正生成的内容时，DocSmith 可以将这些反馈转化为持久性规则，即偏好。这些规则确保您特定的风格、结构要求和内容策略在未来的文档任务中得到一致应用。所有偏好都存储在项目根目录下 `.aigne/doc-smith/preferences.yml` 文件中，该文件为人类可读的 YAML 格式。
 
-所有偏好都存储在项目根目录下名为 `.aigne/doc-smith/preferences.yml` 的人类可读 YAML 文件中。虽然您可以查看此文件，但建议使用专用的 `aigne doc prefs` 命令行界面来管理您的偏好。
+## 偏好生命周期
 
-## 偏好是如何创建的
+下图说明了您的反馈如何成为一个可重用的规则，该规则可应用于未来的任务，并通过命令行进行管理。
 
-偏好在 `aigne doc refine` 等命令的反馈周期中自动生成。其过程如下：
+```d2 偏好生命周期
+direction: down
 
-```d2
-direction: right
+feedback: {
+  label: "1. 用户在 'refine' 或 'translate' 期间\n提供反馈"
+  shape: rectangle
+}
 
-User: {
-  shape: person
-  label: "用户"
+refiner: {
+  label: "2. Feedback Refiner Agent\n分析反馈"
+  shape: rectangle
 }
 
-Refine: "`aigne doc refine` 命令"
+decision: {
+  label: "这是一个可重用的策略吗？"
+  shape: diamond
+}
 
-FeedbackRefiner: "反馈→规则转换器"
+pref_file: {
+  label: "3. preferences.yml\n规则已保存"
+  shape: cylinder
+}
 
-PreferencesFile: "preferences.yml" {
-  shape: document
+future_tasks: {
+  label: "4. 未来的任务\n应用已保存的规则"
+  shape: rectangle
 }
 
-User -> Refine: "提供反馈，例如‘不要翻译变量名’"
-Refine -> FeedbackRefiner: "发送反馈进行分析"
-FeedbackRefiner -> PreferencesFile: "保存新的可重用规则" {
-  style.animated: true
+cli: {
+  label: "5. CLI 管理\n('aigne doc prefs')"
+  shape: rectangle
 }
 
+feedback -> refiner: "输入"
+refiner -> decision: "分析"
+decision -> pref_file: "是"
+decision -> "丢弃（一次性修复）": "否"
+pref_file -> future_tasks: "应用于"
+cli <-> pref_file: "管理"
+
 ```
 
-1.  **反馈输入**：您在优化会话期间提供自然语言反馈。
-2.  **规则生成**：一个内部 Agent 会分析您的反馈，以确定它代表的是可重用策略还是一次性修复。
-3.  **规则创建**：如果被认为是可重用的，它会创建一个结构化规则，包含特定的作用域（例如，`document`、`translation`）、唯一的 ID 以及指令本身。
-4.  **持久化**：新规则被保存到 `preferences.yml` 文件中，使其在未来的任务中生效。
+### DocSmith 如何从反馈中学习
+
+当您在 `refine` 或 `translate` 阶段提供反馈时，一个名为 'Feedback Refiner' 的内部 Agent 会分析您的输入。其目标是区分一次性修复（例如，更正拼写错误）和可重用策略（例如，“始终用英语编写代码注释”）。如果它确定反馈代表一个持久性指令，就会创建一个新的偏好规则。
+
+每个规则都有几个关键属性来定义其行为：
+
+| 属性 | 描述 |
+|---|---|
+| **id** | 规则的唯一标识符（例如，`pref_a1b2c3d4`）。 |
+| **active** | 一个布尔值（`true`/`false`），指示规则当前是否已启用。 |
+| **scope** | 定义规则的应用时机：`global`、`structure`、`document` 或 `translation`。 |
+| **rule** | 将在未来任务中传递给 AI 的指令。 |
+| **feedback** | 您提供的原始自然语言反馈。 |
+| **createdAt** | 规则创建时的 ISO 8601 时间戳。 |
+| **paths** | 一个可选的文件路径列表。如果存在，该规则仅适用于为这些特定路径生成的内容。 |
 
 ## 通过 CLI 管理偏好
 
-`aigne doc prefs` 命令是您查看和管理所有已保存偏好的主要工具。
+您可以使用 `aigne doc prefs` 命令查看和管理所有已保存的偏好。这允许您列出、激活、停用或永久删除规则。
 
 ### 列出所有偏好
 
-要查看所有偏好的格式化列表，请使用 `--list` 标志。
+要查看所有已保存的偏好（包括活动和非活动的），请使用 `--list` 标志。
 
-```bash
+```bash 列出所有偏好 icon=lucide:terminal
 aigne doc prefs --list
 ```
 
-输出清晰地展示了每个规则的概览：
+该命令会显示一个格式化列表，解释每个规则的状态、范围、ID 以及任何路径限制。
 
-```text
+**示例输出：**
+
+```text 示例输出 icon=lucide:clipboard-list
 # 用户偏好
 
 **格式说明：**
 - 🟢 = 活动偏好, ⚪ = 非活动偏好
-- [scope] = 偏好作用域 (global, structure, document, translation)
-- ID = 唯一偏好标识符
+- [scope] = 偏好范围 (global, structure, document, translation)
+- ID = 偏好唯一标识符
 - Paths = 特定文件路径 (如果适用)
 
-🟢 [translation] pref_1a2b3c4d
-   在翻译期间保持代码和标识符不变，不得翻译它们。
-
-⚪ [structure] pref_5e6f7g8h | 路径：overview.md, tutorials.md
-   在概述和教程文档末尾添加“后续步骤”部分，并附上 2-3 个仓库内的链接。
+🟢 [structure] pref_a1b2c3d4e5f6g7h8 | Paths: overview.md
+   在概览文档末尾添加一个 'Next Steps' 部分。
+ 
+⚪ [document] pref_i9j0k1l2m3n4o5p6
+   代码注释必须用英语编写。
+ 
 ```
 
-- **状态 (🟢 / ⚪)**：显示规则当前是活动还是非活动状态。
-- **作用域**：指明规则的应用范围（例如，`translation`、`structure`）。
-- **ID**：用于管理规则的唯一标识符。
-- **路径**：如果规则仅限于特定文件，这些文件将在此处列出。
-
 ### 切换偏好状态
 
-您可以使用 `--toggle` 标志来激活或停用偏好。这在临时禁用某个规则而不想永久删除它时非常有用。
-
-**交互模式**
+如果您想临时禁用某个规则而不删除它，可以切换其活动状态。请使用 `--toggle` 标志。
 
-如果您在运行命令时未指定 ID，将会出现一个交互式提示，允许您选择多个规则进行切换。
+不带 ID 运行该命令将启动交互模式，允许您选择一个或多个要切换的偏好：
 
-```bash
+```bash 以交互方式切换偏好 icon=lucide:terminal
 aigne doc prefs --toggle
 ```
 
-**按 ID 操作**
+要直接切换特定规则，请使用 `--id` 标志提供其 ID：
 
-要切换特定规则的状态，请使用 `--id` 选项提供其 ID。
-
-```bash
-aigne doc prefs --toggle --id pref_5e6f7g8h
+```bash 切换特定偏好 icon=lucide:terminal
+aigne doc prefs --toggle --id pref_i9j0k1l2m3n4o5p6
 ```
 
-### 删除偏好
-
-要永久删除一个或多个偏好，请使用 `--remove` 标志。
+### 移除偏好
 
-**交互模式**
+要永久删除一个或多个偏好，请使用 `--remove` 标志。此操作无法撤销。
 
-在不带 ID 的情况下运行该命令将启动一个交互式选择提示。
+要进入交互式选择提示，请不带 ID 运行该命令：
 
-```bash
+```bash 以交互方式移除偏好 icon=lucide:terminal
 aigne doc prefs --remove
 ```
 
-**按 ID 操作**
+要通过 ID 直接移除特定规则，请使用 `--id` 标志：
 
-要删除特定规则，请传递其 ID。
-
-```bash
-aigne doc prefs --remove --id pref_1a2b3c4d
+```bash 移除特定偏好 icon=lucide:terminal
+aigne doc prefs --remove --id pref_a1b2c3d4e5f6g7h8
 ```
 
-此操作不可逆，请谨慎使用。
-
----
+## 后续步骤
 
-通过管理您的偏好，您可以随着时间的推移微调 DocSmith 的行为，使文档处理过程越来越自动化，并与您项目的特定需求保持一致。要了解如何提供反馈，您可以在 [更新与优化](./features-update-and-refine.md) 指南中了解更多信息。
+管理偏好是根据项目特定需求定制 DocSmith 的关键部分。要了解更多自定义选项，请查阅主要的[配置指南](./configuration.md)。