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

package/docs/configuration-managing-preferences.md

@@ -1,100 +0,0 @@
-# Managing Preferences
-
-When you generate or update documentation, you can provide feedback using the `--feedback` flag. This feedback is saved as a "preference" to be reused in future sessions, ensuring the AI maintains consistency with your previous instructions. The `aigne doc prefs` command provides a direct way to manage these saved preferences.
-
-This guide details how to list, remove, and toggle the active status of your saved preferences.
-
-## Viewing Saved Preferences
-
-To review all saved preferences, use the `--list` flag. This command displays each preference with its status, scope, unique ID, and content.
-
-```bash
-aigne doc prefs --list
-```
-
-### Understanding the Output
-
-The list is formatted to provide clear information about each preference rule:
-
-*   **Status**: Indicates if a preference is active or inactive.
-    *   `🟢`: Active. The rule will be applied during documentation generation.
-    *   `⚪`: Inactive. The rule is saved but will be ignored.
-*   **Scope**: The context in which the preference applies (e.g., `global`, `document`).
-*   **ID**: A unique identifier for the preference, used for removing or toggling.
-*   **Paths**: If the preference applies only to specific files, their paths are listed here.
-*   **Rule Content**: The text of the preference rule itself.
-
-**Example Output:**
-
-```
-# User Preferences
-
-**Format explanation:**
-- 🟢 = Active preference, ⚪ = Inactive preference
-- [scope] = Preference scope (global, structure, document, translation)
-- ID = Unique preference identifier
-- Paths = Specific file paths (if applicable)
-
-🟢 [document] 2af5c | Paths: /guides/generating-documentation.md
-   Focus on concrete, verifiable facts and information. Avoid using vague or empty words that don't provide measurable or specific d...
-
-⚪ [global] 8b1e2
-   Use a formal and academic tone throughout the documentation.
-
-```
-
-## Removing Preferences
-
-When a preference is no longer needed, you can permanently delete it using the `--remove` flag. You can remove preferences either by specifying their IDs or through an interactive menu.
-
-### Interactive Mode
-
-To select preferences from a list, run the command without any IDs. This will open an interactive prompt where you can check the items you wish to delete.
-
-```bash
-aigne doc prefs --remove
-```
-
-A checklist will appear, allowing you to select one or more preferences. This is the recommended method for ensuring you remove the correct items.
-
-### Direct Mode
-
-If you already know the unique IDs of the preferences you want to remove, you can specify them using the `--id` flag. This is faster if you are certain about which items to delete.
-
-```bash
-# Remove a single preference
-aigne doc prefs --remove --id 2af5c
-
-# Remove multiple preferences
-aigne doc prefs --remove --id 2af5c --id 8b1e2
-```
-
-## Toggling Preferences
-
-Instead of permanently deleting a preference, you can temporarily enable or disable it. This is useful when you want to suspend a rule for a specific task without losing it. Use the `--toggle` flag to change a preference's active status.
-
-### Interactive Mode
-
-Running the command without IDs will launch an interactive checklist, similar to the remove command.
-
-```bash
-aigne doc prefs --toggle
-```
-
-You can select the preferences you wish to activate or deactivate. The status icon (`🟢`/`⚪`) will update to reflect the new state.
-
-### Direct Mode
-
-To toggle specific preferences directly, use the `--id` flag.
-
-```bash
-# Toggle a single preference
-aigne doc prefs --toggle --id 2af5c
-
-# Toggle multiple preferences
-aigne doc prefs --toggle --id 2af5c --id 8b1e2
-```
-
----
-
-By managing your preferences, you can maintain fine-grained control over the documentation generation process, ensuring that the output consistently aligns with your project's specific requirements and style.

package/docs/configuration-managing-preferences.zh-TW.md

@@ -1,100 +0,0 @@
-# 管理偏好設定
-
-當您生成或更新文件時，可以使用 `--feedback` 旗標提供回饋。此回饋會儲存為「偏好設定」，以便在未來的會話中重複使用，確保 AI 與您先前的指示保持一致。`aigne doc prefs` 指令提供了一種直接管理這些已儲存偏好設定的方法。
-
-本指南詳細說明如何列出、移除以及切換您已儲存偏好設定的啟用狀態。
-
-## 檢視已儲存的偏好設定
-
-若要檢視所有已儲存的偏好設定，請使用 `--list` 旗標。此指令會顯示每個偏好設定的狀態、範圍、唯一 ID 和內容。
-
-```bash
-aigne doc prefs --list
-```
-
-### 理解輸出內容
-
-列表經過格式化，以提供關於每個偏好設定規則的清晰資訊：
-
-*   **Status**：指示偏好設定為啟用或停用。
-    *   `🟢`：啟用。此規則將在文件生成期間應用。
-    *   `⚪`：停用。此規則已儲存但將被忽略。
-*   **Scope**：偏好設定應用的情境（例如：`global`、`document`）。
-*   **ID**：偏好設定的唯一識別碼，用於移除或切換狀態。
-*   **Paths**：如果偏好設定僅適用於特定檔案，其路徑會在此列出。
-*   **Rule Content**：偏好設定規則本身的文字。
-
-**輸出範例：**
-
-```
-# 使用者偏好設定
-
-**格式說明：**
-- 🟢 = 啟用中的偏好設定，⚪ = 停用中的偏好設定
-- [scope] = 偏好設定範圍 (global, structure, document, translation)
-- ID = 唯一的偏好設定識別碼
-- Paths = 特定檔案路徑（如果適用）
-
-🟢 [document] 2af5c | Paths: /guides/generating-documentation.md
-   Focus on concrete, verifiable facts and information. Avoid using vague or empty words that don't provide measurable or specific d...
-
-⚪ [global] 8b1e2
-   Use a formal and academic tone throughout the documentation.
-
-```
-
-## 移除偏好設定
-
-當不再需要某個偏好設定時，您可以使用 `--remove` 旗標將其永久刪除。您可以透過指定其 ID 或透過互動式選單來移除偏好設定。
-
-### 互動模式
-
-若要從列表中選擇偏好設定，請執行不含任何 ID 的指令。這將開啟一個互動式提示，您可以在其中勾選您希望刪除的項目。
-
-```bash
-aigne doc prefs --remove
-```
-
-會出現一個清單，讓您選擇一個或多個偏好設定。這是確保您移除正確項目的建議方法。
-
-### 直接模式
-
-如果您已經知道要移除的偏好設定的唯一 ID，您可以使用 `--id` 旗標來指定它們。如果您確定要刪除哪些項目，這種方式會更快。
-
-```bash
-# 移除單一偏好設定
-aigne doc prefs --remove --id 2af5c
-
-# 移除多個偏好設定
-aigne doc prefs --remove --id 2af5c --id 8b1e2
-```
-
-## 切換偏好設定
-
-您可以暫時啟用或停用偏好設定，而不是永久刪除它。當您想為特定任務暫停某個規則而不想失去它時，這非常有用。使用 `--toggle` 旗標來變更偏好設定的啟用狀態。
-
-### 互動模式
-
-執行不含 ID 的指令將會啟動一個互動式清單，類似於移除指令。
-
-```bash
-aigne doc prefs --toggle
-```
-
-您可以選擇您希望啟用或停用的偏好設定。狀態圖示 (`🟢`/`⚪`) 將會更新以反映新的狀態。
-
-### 直接模式
-
-若要直接切換特定偏好設定，請使用 `--id` 旗標。
-
-```bash
-# 切換單一偏好設定
-aigne doc prefs --toggle --id 2af5c
-
-# 切換多個偏好設定
-aigne doc prefs --toggle --id 2af5c --id 8b1e2
-```
-
----
-
-透過管理您的偏好設定，您可以對文件生成過程進行細緻的控制，確保輸出結果能持續符合您專案的特定要求和風格。

package/docs/configuration-managing-preferences.zh.md

@@ -1,100 +0,0 @@
-# 管理偏好设置
-
-在生成或更新文档时，您可以使用 `--feedback` 标志提供反馈。此反馈将作为“偏好设置”保存，以便在未来的会话中重复使用，确保 AI 与您之前的指令保持一致。`aigne doc prefs` 命令提供了一种直接管理这些已保存偏好设置的方法。
-
-本指南详细介绍了如何列出、删除和切换已保存偏好设置的活动状态。
-
-## 查看已保存的偏好设置
-
-要查看所有已保存的偏好设置，请使用 `--list` 标志。此命令会显示每个偏好设置的状态、范围、唯一 ID 和内容。
-
-```bash
-aigne doc prefs --list
-```
-
-### 理解输出
-
-列表经过格式化，以提供关于每个偏好规则的清晰信息：
-
-*   **状态**：指示偏好设置是活动还是非活动状态。
-    *   `🟢`：活动。该规则将在文档生成期间应用。
-    *   `⚪`：非活动。该规则已保存但将被忽略。
-*   **范围**：偏好设置适用的上下文（例如，`global`、`document`）。
-*   **ID**：偏好设置的唯一标识符，用于删除或切换状态。
-*   **路径**：如果偏好设置仅适用于特定文件，其路径会在此处列出。
-*   **规则内容**：偏好规则本身的文本。
-
-**输出示例：**
-
-```
-# 用户偏好设置
-
-**格式说明：**
-- 🟢 = 活动偏好，⚪ = 非活动偏好
-- [scope] = 偏好范围 (global, structure, document, translation)
-- ID = 唯一偏好标识符
-- Paths = 特定文件路径（如适用）
-
-🟢 [document] 2af5c | Paths: /guides/generating-documentation.md
-   Focus on concrete, verifiable facts and information. Avoid using vague or empty words that don't provide measurable or specific d...
-
-⚪ [global] 8b1e2
-   Use a formal and academic tone throughout the documentation.
-
-```
-
-## 删除偏好设置
-
-当不再需要某个偏好设置时，您可以使用 `--remove` 标志将其永久删除。您可以通过指定其 ID 或通过交互式菜单来删除偏好设置。
-
-### 交互模式
-
-要从列表中选择偏好设置，请在不带任何 ID 的情况下运行该命令。这将打开一个交互式提示，您可以在其中勾选要删除的项目。
-
-```bash
-aigne doc prefs --remove
-```
-
-将出现一个清单，允许您选择一个或多个偏好设置。这是确保您删除正确项目的推荐方法。
-
-### 直接模式
-
-如果您已经知道要删除的偏好设置的唯一 ID，可以使用 `--id` 标志来指定它们。如果您确定要删除哪些项目，这种方式会更快。
-
-```bash
-# 删除单个偏好设置
-aigne doc prefs --remove --id 2af5c
-
-# 删除多个偏好设置
-aigne doc prefs --remove --id 2af5c --id 8b1e2
-```
-
-## 切换偏好设置
-
-除了永久删除偏好设置，您还可以临时启用或禁用它。当您想为特定任务暂停某条规则但又不想丢失它时，这非常有用。使用 `--toggle` 标志来更改偏好设置的活动状态。
-
-### 交互模式
-
-在不带 ID 的情况下运行该命令将启动一个交互式清单，类似于删除命令。
-
-```bash
-aigne doc prefs --toggle
-```
-
-您可以选择希望激活或停用的偏好设置。状态图标（`🟢`/`⚪`）将更新以反映新状态。
-
-### 直接模式
-
-要直接切换特定偏好设置，请使用 `--id` 标志。
-
-```bash
-# 切换单个偏好设置
-aigne doc prefs --toggle --id 2af5c
-
-# 切换多个偏好设置
-aigne doc prefs --toggle --id 2af5c --id 8b1e2
-```
-
----
-
-通过管理您的偏好设置，您可以对文档生成过程进行精细控制，确保输出始终符合您项目的特定要求和风格。

package/docs/configuration.ja.md

@@ -1,69 +0,0 @@
-# 設定
-
-適切な設定は、AIGNE DocSmith ツールがプロジェクト固有のニーズに合ったドキュメントを生成するための基本です。このプロセスでは、中央の設定ファイルでプロジェクトレベルの設定を定義し、個人の設定を管理して生成プロセスを微調整します。
-
-このセクションでは、ツールの設定方法の概要を説明します。詳細な手順については、以下の各ガイドを参照してください。
-
-<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` ファイルについて
-
-`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)**：プロジェクトの `config.yaml` ファイルを作成します。
-*   **[設定の管理](./configuration-managing-preferences.md)**：個人のルールでツールの動作をカスタマイズします。

package/docs/configuration.md

@@ -1,69 +0,0 @@
-# Configuration
-
-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 detailed, step-by-step instructions, please refer to the specific guides linked below.
-
-<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>
-
-## 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
-
-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 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.

package/docs/configuration.zh-TW.md

@@ -1,69 +0,0 @@
-# 設定
-
-正確的設定是引導 AIGNE DocSmith 工具產生符合您專案特定需求文件的基礎。此過程涉及透過一個中央設定檔來定義專案層級的設定，並管理個人偏好設定以微調產生過程。
-
-本節將概覽如何設定此工具。有關詳細的逐步說明，請參考下方連結的具體指南。
-
-<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` 檔案
-
-`config.yaml` 檔案是您文件專案的唯一可信來源。它在初始設定過程中產生，並包含 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)**：建立您專案的 `config.yaml` 檔案。
-*   **[管理偏好設定](./configuration-managing-preferences.md)**：使用個人規則自訂工具的行為。

package/docs/configuration.zh.md

@@ -1,69 +0,0 @@
-# 配置
-
-正确的配置是指导 AIGNE DocSmith 工具生成符合项目特定需求的文档的基础。该过程涉及通过中央配置文件定义项目级设置，以及管理个人偏好以微调生成过程。
-
-本节概述了如何配置该工具。有关详细的分步说明，请参阅下面链接的具体指南。
-
-<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` 文件
-
-`config.yaml` 文件是您文档项目的主要可信来源。它在初始设置过程中生成，包含了 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。该 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)**：创建您项目的 `config.yaml` 文件。
-*   **[管理偏好设置](./configuration-managing-preferences.md)**：使用个人规则自定义工具的行为。