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

package/docs/configuration.zh.md

@@ -1,96 +0,0 @@
-# 配置
-
-合理的配置对于根据项目的具体需求定制文档生成过程至关重要。AIGNE DocSmith 使用一个主配置文件和命令行界面来管理您的设置。这种设置确保了生成的文档能够准确反映您的项目目标、目标受众和结构要求。
-
-本节概述了如何配置该工具。有关分步说明，请参阅以下详细指南：
-
-<x-cards>
-  <x-card data-title="初始设置" data-icon="lucide:settings-2" data-href="/configuration/initial-setup">了解如何运行交互式设置来创建您的 config.yaml 文件。这是任何新项目的推荐第一步。</x-card>
-  <x-card data-title="管理偏好设置" data-icon="lucide:list-checks" data-href="/configuration/managing-preferences">了解如何查看、启用、禁用或删除已保存的偏好设置，以便随着时间的推移优化文档生成过程。</x-card>
-</x-cards>
-
-## `config.yaml` 文件
-
-所有项目级别的设置都存储在名为 `config.yaml` 的文件中，该文件位于您项目中的 `.aigne/doc-smith/` 目录内。`aigne doc init` 命令通过一个交互式过程为您创建此文件。您也可以随时使用文本编辑器手动修改此文件以调整设置。
-
-以下是一个 `config.yaml` 文件的示例，其中包含解释每个部分的注释。
-
-```yaml Example config.yaml icon=logos:yaml
-# 用于文档发布的项目信息
-projectName: AIGNE DocSmith
-projectDesc: AIGNE DocSmith 是一款功能强大、由 AI 驱动的文档生成工具，构建于 AIGNE 框架之上。它可以直接从您的源代码中自动创建详细、结构化和多语言的文档。
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
-
-# =============================================================================
-# 文档配置
-# =============================================================================
-
-# 目的：您希望读者实现的主要成果是什么？
-# 可用选项（取消注释并根据需要修改）：
-#   getStarted       - 快速入门：帮助新用户在 30 分钟内从零开始上手
-#   completeTasks    - 完成特定任务：引导用户了解常见工作流程和用例
-#   findAnswers      - 快速查找答案：为所有功能和 API 提供可搜索的参考
-#   understandSystem - 理解系统：解释其工作原理以及做出设计决策的原因
-#   solveProblems    - 解决问题：帮助用户排查和修复问题
-#   mixedPurpose     - 多种目的混合：涵盖多种需求的综合文档
-documentPurpose:
-  - getStarted
-  - completeTasks
-
-# 目标受众：谁会最常阅读这些文档？
-# 可用选项（取消注释并根据需要修改）：
-#   endUsers         - 最终用户（非技术人员）：使用产品但不编码的人
-#   developers       - 集成开发者：将此添加到其项目中的工程师
-#   devops           - DevOps/基础设施：部署、监控、维护系统的团队
-#   decisionMakers   - 技术决策者：评估或规划实施的架构师、负责人
-#   supportTeams     - 支持团队：帮助他人使用产品的人
-#   mixedTechnical   - 混合技术受众：开发者、DevOps 和技术用户
-targetAudienceTypes:
-  - endUsers
-
-# 读者知识水平：读者通常具备哪些知识？
-# 可用选项（取消注释并根据需要修改）：
-#   completeBeginners    - 完全初学者：完全不熟悉该领域/技术
-#   domainFamiliar       - 熟悉领域，但工具是新的：了解问题领域，但对这个特定解决方案不熟悉
-#   experiencedUsers     - 经验丰富的用户：需要参考/高级主题的常规用户
-#   emergencyTroubleshooting - 紧急/故障排除：出现问题，需要快速修复
-#   exploringEvaluating  - 探索/评估：试图了解这是否满足他们的需求
-readerKnowledgeLevel: completeBeginners
-
-# 文档深度：文档应有多全面？
-# 可用选项（取消注释并根据需要修改）：
-#   essentialOnly      - 仅包含基本内容：覆盖 80% 的用例，保持简洁
-#   balancedCoverage   - 平衡覆盖：具有适当深度和实际示例 [推荐]
-#   comprehensive      - 全面：覆盖所有功能、边缘情况和高级场景
-#   aiDecide           - 让 AI 决定：分析代码复杂性并建议适当的深度
-documentationDepth: comprehensive
-
-# 自定义规则：定义具体的文档生成规则和要求
-rules: |
-  避免使用模糊或空洞的词语，这些词语无法提供可衡量或具体的细节，例如‘智能地’、‘无缝地’、‘全面地’或‘高质量地’。专注于具体、可验证的事实和信息。
-  专注于具体、可验证的事实和信息。
-  必须覆盖 DocSmith 的所有子命令
-
-# 目标受众：描述您的具体目标受众及其特征
-targetAudience: |
-
-locale: en
-translateLanguages:
-  - zh
-  - zh-TW
-  - ja
-docsDir: ./docs  # 保存生成文档的目录
-sourcesPath:  # 要分析的源代码路径
-  - ./README.md
-  - ./CHANGELOG.md
-  - ./aigne.yaml
-  - ./agents
-  - ./media.md
-  - ./.aigne/doc-smith/config.yaml
-```
-
-## 总结
-
-完成配置后，该工具将清楚地了解您的项目、受众和文档目标，从而生成更准确、更相关的内容。
-
-要开始设置您的项目，请继续阅读[初始设置](./configuration-initial-setup.md)指南。

package/docs/getting-started.ja.md

@@ -1,88 +0,0 @@
-# はじめに
-
-このガイドでは、AIGNE DocSmithをインストールし、最初のドキュメントセットを生成するためのステップバイステップの手順を説明します。このプロセスは分かりやすく設計されており、短時間で完了できます。
-
-## 前提条件
-
-インストールを進める前に、お使いのシステムが以下の要件を満たしていることを確認してください。
-
-*   **Node.js**: バージョン20以降が必要です。DocSmithはNode.jsのインストールに含まれているNode Package Manager (npm) を使用してインストールされます。Node.jsをインストールするには、公式の[Node.jsウェブサイト](https://nodejs.org/)にアクセスし、お使いのオペレーティングシステムの手順に従ってください。ターミナルを開き、`node -v`と`npm -v`を実行することでインストールを確認できます。
-
-*   **APIキー**: 開始にあたりAPIキーは不要です。デフォルトでは、DocSmithはAIによる生成のためにAIGNE Hubサービスを使用します。これにより、直接的な設定なしで様々な大規模言語モデルを利用できます。
-
-## インストール
-
-このツールは、AIGNEコマンドラインインターフェース(CLI)の一部として配布されています。
-
-### ステップ1：AIGNE CLIをインストールする
-
-システムにAIGNE CLIをグローバルにインストールするには、ターミナルで以下のコマンドを実行します。
-
-```bash title="AIGNE CLIのインストール" icon=logos:npm-icon
-npm install -g @aigne/cli
-```
-
-このコマンドはパッケージをダウンロードしてインストールし、どのディレクトリからでも`aigne`コマンドを利用できるようにします。
-
-### ステップ2：インストールを確認する
-
-インストールが完了したら、ドキュメンテーションツールのヘルプコマンドを実行して確認します。
-
-```bash title="インストールの確認"
-aigne doc --help
-```
-
-このコマンドにより、利用可能なDocSmithのコマンドとオプションのリストが表示され、インストールが成功したことを確認できます。
-
-## 最初のドキュメントを生成する
-
-以下の手順に従って、プロジェクトを分析し、完全なドキュメントセットを生成します。
-
-### ステップ1：プロジェクトディレクトリに移動する
-
-ターミナルを開き、`cd`コマンドを使用して、ドキュメントを作成したいプロジェクトのルートにカレントディレクトリを変更します。
-
-```bash title="ディレクトリの変更" icon=mdi:folder-open
-cd /path/to/your/project
-```
-
-### ステップ2：生成コマンドを実行する
-
-主要な`generate`コマンドを実行します。この単一のコマンドが、ドキュメント作成プロセス全体を処理します。
-
-```bash title="生成コマンドの実行"
-aigne doc generate
-```
-
-### ステップ3：対話式セットアップを完了する
-
-プロジェクトで初めて`generate`コマンドを実行すると、DocSmithは1回限りの対話式セットアッププロセスを開始します。ドキュメントの主な目的、対象読者、言語など、ドキュメントの設定に関する一連の質問が表示されます。設定を保存するために、`.aigne/doc-smith`ディレクトリに`config.yaml`ファイルが作成されます。
-
-### ステップ4：生成を待つ
-
-セットアップが完了すると、DocSmithは自動的に以下のアクションを実行します。
-
-1.  **コードベースの分析**: ソースファイルをスキャンして、プロジェクトの構造とロジックを理解します。
-2.  **構造の計画**: セクションやトピックを含む、ドキュメントの論理的な計画を作成します。
-3.  **コンテンツの生成**: 分析と設定に基づいてドキュメントのコンテンツを記述します。
-
-完了すると確認メッセージが表示され、生成されたファイルはセットアップ時に指定された出力ディレクトリ（例：`.aigne/doc-smith/docs`）に配置されます。
-
-## 次のステップ
-
-最初のドキュメントセットの生成が成功しました。ドキュメントを管理し、強化するための一般的な次のステップは以下の通りです。
-
-<x-cards data-columns="2">
-  <x-card data-title="ドキュメントの更新" data-icon="lucide:refresh-cw" data-href="/guides/updating-documentation">
-    コードの変更や新しい要件に基づいて、ドキュメントの特定の部分を修正または再生成します。
-  </x-card>
-  <x-card data-title="ドキュメントの翻訳" data-icon="lucide:languages" data-href="/guides/translating-documentation">
-    ドキュメントを中国語、スペイン語、ドイツ語など、サポートされている12言語のいずれかに翻訳します。
-  </x-card>
-  <x-card data-title="ドキュメントの公開" data-icon="lucide:rocket" data-href="/guides/publishing-your-docs">
-    ドキュメントをオンラインで公開し、チームや一般の人が利用できるようにします。
-  </x-card>
-  <x-card data-title="設定の確認" data-icon="lucide:settings" data-href="/configuration/initial-setup">
-    初期セットアップ時に作成されたconfig.yamlファイルを確認・修正して、設定を調整します。
-  </x-card>
-</x-cards>

package/docs/getting-started.md

@@ -1,88 +0,0 @@
-# Getting Started
-
-This guide provides a step-by-step procedure for installing AIGNE DocSmith and generating your first set of documentation. The process is designed to be straightforward and can be completed quickly.
-
-## Prerequisites
-
-Before proceeding with the installation, ensure your system meets the following requirements:
-
-*   **Node.js**: Version 20 or newer is required. DocSmith is installed using the Node Package Manager (npm), which is included with the Node.js installation. To install Node.js, visit the official [Node.js website](https://nodejs.org/) and follow the instructions for your operating system. You can verify the installation by opening your terminal and running `node -v` and `npm -v`.
-
-*   **API Keys**: No API keys are required to start. By default, DocSmith uses the AIGNE Hub service for AI-powered generation, which allows you to use various large language models without direct configuration.
-
-## Installation
-
-The tool is distributed as part of the AIGNE command-line interface (CLI).
-
-### Step 1: Install the AIGNE CLI
-
-To install the AIGNE CLI globally on your system, execute the following command in your terminal:
-
-```bash title="Install AIGNE CLI" icon=logos:npm-icon
-npm install -g @aigne/cli
-```
-
-This command downloads and installs the package, making the `aigne` command available from any directory.
-
-### Step 2: Verify the Installation
-
-After the installation is complete, verify it by running the help command for the documentation tool:
-
-```bash title="Verify Installation"
-aigne doc --help
-```
-
-This command should display a list of available DocSmith commands and options, confirming that the installation was successful.
-
-## Generating Your First Documents
-
-Follow these steps to analyze your project and generate a complete set of documentation.
-
-### Step 1: Navigate to Your Project Directory
-
-Open your terminal and use the `cd` command to change the current directory to the root of the project you wish to document.
-
-```bash title="Change Directory" icon=mdi:folder-open
-cd /path/to/your/project
-```
-
-### Step 2: Run the Generate Command
-
-Execute the primary `generate` command. This single command handles the entire documentation creation process.
-
-```bash title="Run Generate Command"
-aigne doc generate
-```
-
-### Step 3: Complete the Interactive Setup
-
-The first time you run the `generate` command in a project, DocSmith will initiate a one-time interactive setup process. You will be asked a series of questions to configure your documentation preferences, such as its primary purpose, target audience, and language. A `config.yaml` file will be created in the `.aigne/doc-smith` directory to store your settings.
-
-### Step 4: Await Generation
-
-Once the setup is complete, DocSmith will perform the following actions automatically:
-
-1.  **Analyze Codebase**: It scans your source files to understand the project's structure and logic.
-2.  **Plan Structure**: It creates a logical plan for the documentation, including sections and topics.
-3.  **Generate Content**: It writes the documentation content based on the analysis and your configuration.
-
-Upon completion, a confirmation message will appear, and the generated files will be located in the output directory specified during setup (e.g., `.aigne/doc-smith/docs`).
-
-## What's Next?
-
-You have successfully generated your first set of documents. Here are the common next steps to manage and enhance your documentation:
-
-<x-cards data-columns="2">
-  <x-card data-title="Update Documentation" data-icon="lucide:refresh-cw" data-href="/guides/updating-documentation">
-    Modify or regenerate specific sections of your documentation based on code changes or new requirements.
-  </x-card>
-  <x-card data-title="Translate Documentation" data-icon="lucide:languages" data-href="/guides/translating-documentation">
-    Translate your documents into any of the 12 supported languages, such as Chinese, Spanish, or German.
-  </x-card>
-  <x-card data-title="Publish Your Docs" data-icon="lucide:rocket" data-href="/guides/publishing-your-docs">
-    Make your documentation available online for your team or the public.
-  </x-card>
-  <x-card data-title="Review Configuration" data-icon="lucide:settings" data-href="/configuration/initial-setup">
-    Review and modify the config.yaml file that was created during the initial setup to adjust your preferences.
-  </x-card>
-</x-cards>

package/docs/getting-started.zh-TW.md

@@ -1,88 +0,0 @@
-# 開始使用
-
-本指南提供安裝 AIGNE DocSmith 並產生第一份文件的逐步流程。整個過程設計得簡單明瞭，可以快速完成。
-
-## 前提條件
-
-在進行安裝之前，請確保您的系統符合以下要求：
-
-*   **Node.js**：需要 20 或更新版本。DocSmith 使用 Node Package Manager (npm) 安裝，npm 包含在 Node.js 的安裝中。若要安裝 Node.js，請造訪官方 [Node.js 網站](https://nodejs.org/) 並按照您作業系統的說明進行操作。您可以透過開啟終端機並執行 `node -v` 和 `npm -v` 來驗證安裝。
-
-*   **API 金鑰**：開始時不需要任何 API 金鑰。預設情況下，DocSmith 使用 AIGNE Hub 服務進行 AI 驅動的生成，讓您無需直接設定即可使用各種大型語言模型。
-
-## 安裝
-
-此工具作為 AIGNE 命令列介面 (CLI) 的一部分進行分發。
-
-### 步驟 1：安裝 AIGNE CLI
-
-若要在您的系統上全域安裝 AIGNE CLI，請在終端機中執行以下指令：
-
-```bash title="安裝 AIGNE CLI" icon=logos:npm-icon
-npm install -g @aigne/cli
-```
-
-此指令會下載並安裝套件，使 `aigne` 指令在任何目錄下都可用。
-
-### 步驟 2：驗證安裝
-
-安裝完成後，請執行文件工具的說明指令來進行驗證：
-
-```bash title="驗證安裝"
-aigne doc --help
-```
-
-此指令應會顯示可用的 DocSmith 指令與選項列表，確認安裝成功。
-
-## 產生您的第一份文件
-
-請依照以下步驟分析您的專案並產生一套完整的文件。
-
-### 步驟 1：導覽至您的專案目錄
-
-開啟您的終端機，並使用 `cd` 指令將目前目錄切換到您想要建立文件的專案根目錄。
-
-```bash title="切換目錄" icon=mdi:folder-open
-cd /path/to/your/project
-```
-
-### 步驟 2：執行產生指令
-
-執行主要的 `generate` 指令。這個單一指令會處理整個文件建立過程。
-
-```bash title="執行產生指令"
-aigne doc generate
-```
-
-### 步驟 3：完成互動式設定
-
-當您第一次在專案中執行 `generate` 指令時，DocSmith 將啟動一次性的互動式設定流程。系統會詢問您一系列問題來設定您的文件偏好，例如其主要目的、目標受眾和語言。設定完成後，將會在 `.aigne/doc-smith` 目錄中建立一個 `config.yaml` 檔案來儲存您的設定。
-
-### 步驟 4：等待產生
-
-設定完成後，DocSmith 將自動執行以下操作：
-
-1.  **分析程式碼庫**：掃描您的原始檔案以了解專案的結構和邏輯。
-2.  **規劃結構**：為文件建立一個邏輯計畫，包含章節和主題。
-3.  **產生內容**：根據分析和您的設定撰寫文件內容。
-
-完成後，將會出現一則確認訊息，且產生的檔案將位於設定時指定的輸出目錄中（例如 `.aigne/doc-smith/docs`）。
-
-## 接下來呢？
-
-您已成功產生第一份文件。以下是管理和強化文件的常見後續步驟：
-
-<x-cards data-columns="2">
-  <x-card data-title="更新文件" data-icon="lucide:refresh-cw" data-href="/guides/updating-documentation">
-    根據程式碼變更或新需求，修改或重新產生文件的特定部分。
-  </x-card>
-  <x-card data-title="翻譯文件" data-icon="lucide:languages" data-href="/guides/translating-documentation">
-    將您的文件翻譯成 12 種支援的語言之一，例如中文、西班牙文或德文。
-  </x-card>
-  <x-card data-title="發布您的文件" data-icon="lucide:rocket" data-href="/guides/publishing-your-docs">
-    將您的文件發布到網路上，供您的團隊或大眾使用。
-  </x-card>
-  <x-card data-title="檢視設定" data-icon="lucide:settings" data-href="/configuration/initial-setup">
-    檢視並修改在初始設定期間建立的 config.yaml 檔案，以調整您的偏好設定。
-  </x-card>
-</x-cards>

package/docs/getting-started.zh.md

@@ -1,88 +0,0 @@
-# 快速入门
-
-本指南提供了安装 AIGNE DocSmith 并生成您的第一套文档的分步流程。该过程设计得非常简单，可以快速完成。
-
-## 前置要求
-
-在继续安装之前，请确保您的系统满足以下要求：
-
-*   **Node.js**：需要 20 或更高版本。DocSmith 使用 Node.js 包管理器（npm）进行安装，该管理器包含在 Node.js 的安装包中。要安装 Node.js，请访问 [Node.js 官方网站](https://nodejs.org/) 并按照适用于您操作系统的说明进行操作。您可以通过打开终端并运行 `node -v` 和 `npm -v` 来验证安装。
-
-*   **API 密钥**：开始时不需要任何 API 密钥。默认情况下，DocSmith 使用 AIGNE Hub 服务进行 AI 驱动的生成，这使您无需直接配置即可使用各种大型语言模型。
-
-## 安装
-
-该工具作为 AIGNE 命令行界面（CLI）的一部分进行分发。
-
-### 第 1 步：安装 AIGNE CLI
-
-要在您的系统上全局安装 AIGNE CLI，请在终端中执行以下命令：
-
-```bash title="安装 AIGNE CLI" icon=logos:npm-icon
-npm install -g @aigne/cli
-```
-
-该命令会下载并安装软件包，使 `aigne` 命令在任何目录下都可用。
-
-### 第 2 步：验证安装
-
-安装完成后，通过运行文档工具的帮助命令来验证安装：
-
-```bash title="验证安装"
-aigne doc --help
-```
-
-该命令应显示 DocSmith 的可用命令和选项列表，以确认安装成功。
-
-## 生成您的第一份文档
-
-请按照以下步骤分析您的项目并生成一套完整的文档。
-
-### 第 1 步：导航到您的项目目录
-
-打开您的终端，使用 `cd` 命令将当前目录更改为您希望记录的项目的根目录。
-
-```bash title="更改目录" icon=mdi:folder-open
-cd /path/to/your/project
-```
-
-### 第 2 步：运行生成命令
-
-执行主要的 `generate` 命令。这个单一的命令会处理整个文档创建过程。
-
-```bash title="运行生成命令"
-aigne doc generate
-```
-
-### 第 3 步：完成交互式设置
-
-当您首次在项目中运行 `generate` 命令时，DocSmith 将启动一次性的交互式设置过程。系统会询问您一系列问题，以配置您的文档偏好，例如其主要目的、目标受众和语言。系统将在 `.aigne/doc-smith` 目录中创建一个 `config.yaml` 文件来存储您的设置。
-
-### 第 4 步：等待生成
-
-设置完成后，DocSmith 将自动执行以下操作：
-
-1.  **分析代码库**：它会扫描您的源文件以理解项目的结构和逻辑。
-2.  **规划结构**：它会为文档创建一个逻辑计划，包括章节和主题。
-3.  **生成内容**：它会根据分析和您的配置来编写文档内容。
-
-完成后，将显示一条确认消息，生成的文件将位于设置期间指定的输出目录中（例如 `.aigne/doc-smith/docs`）。
-
-## 后续步骤
-
-您已成功生成第一套文档。以下是管理和增强文档的常见后续步骤：
-
-<x-cards data-columns="2">
-  <x-card data-title="更新文档" data-icon="lucide:refresh-cw" data-href="/guides/updating-documentation">
-    根据代码更改或新要求，修改或重新生成文档的特定部分。
-  </x-card>
-  <x-card data-title="翻译文档" data-icon="lucide:languages" data-href="/guides/translating-documentation">
-    将您的文档翻译成 12 种支持的语言中的任意一种，例如中文、西班牙语或德语。
-  </x-card>
-  <x-card data-title="发布您的文档" data-icon="lucide:rocket" data-href="/guides/publishing-your-docs">
-    将您的文档在线发布，供您的团队或公众使用。
-  </x-card>
-  <x-card data-title="审查配置" data-icon="lucide:settings" data-href="/configuration/initial-setup">
-    审查并修改在初始设置期间创建的 config.yaml 文件，以调整您的偏好。
-  </x-card>
-</x-cards>

package/docs/guides-cleaning-up.ja.md

@@ -1,51 +0,0 @@
-# クリーンアップ
-
-`aigne doc clear` コマンドは、生成されたファイル、キャッシュデータ、設定を削除するための簡単な方法を提供します。これは、ドキュメントプロジェクトをリセットしたり、クリーンな状態から開始したり、古くなったファイルや破損したファイルに関連する問題をトラブルシューティングしたりする場合に役立ちます。
-
-## 対話的なクリーンアップ
-
-このコマンドを使用する最も簡単な方法は、引数なしで実行することです：
-
-```bash
-aigne doc clear
-```
-
-このコマンドを実行すると対話型のプロンプトが起動し、削除したい項目を正確に選択できます。各オプションについて明確な説明が提供され、偶発的なデータ損失を防ぐことができるため、ほとんどのユースケースでこのアプローチが推奨されます。
-
-## クリーンアップ対象
-
-`clear` コマンドは、いくつかの異なる種類のデータを削除できます。次の表は、利用可能な各ターゲット、その機能、および影響を受ける特定のファイルやディレクトリについて詳しく説明しています。
-
-| Target | 説明 | 影響を受けるファイルとディレクトリ |
-| :--- | :--- | :--- |
-| `generatedDocs` | 出力ディレクトリ内の生成されたすべてのドキュメントを削除しますが、ドキュメント構造計画は保持します。 | 設定で指定された `docsDir` ディレクトリ。 |
-| `documentStructure` | 生成されたすべてのドキュメントとドキュメント構造計画を削除し、ドキュメントコンテンツを効果的にリセットします。 | `.aigne/doc-smith/output/structure-plan.json` ファイルと `docsDir` ディレクトリ。 |
-| `documentConfig` | プロジェクトの設定ファイルを削除します。この操作の後、再度 `aigne doc init` を実行する必要があります。 | `.aigne/doc-smith/config.yaml` ファイル。 |
-| `authTokens` | 公開サイト用に保存された認証トークンを削除します。どのサイトをクリアするか選択するよう求められます。 | ホームディレクトリにある `~/.aigne/doc-smith-connected.yaml` ファイル。 |
-| `deploymentConfig` | 設定ファイルから `appUrl` を削除します。 | `.aigne/doc-smith/config.yaml` ファイル。 |
-
-## 非対話的なクリーンアップ
-
-自動化スクリプトやコマンドラインを好むユーザーのために、`--targets` フラグを使用してクリアする1つ以上のターゲットを直接指定できます。これにより、対話型のプロンプトがバイパスされます。
-
-### 単一ターゲットのクリア
-
-生成されたドキュメントのみをクリアするには、次のコマンドを使用します：
-
-```bash
-aigne doc clear --targets generatedDocs
-```
-
-### 複数ターゲットのクリア
-
-複数のターゲット名を指定して、一度に複数の項目をクリアできます。例えば、ドキュメント設定とドキュメント構造の両方を削除するには、次のように実行します：
-
-```bash
-aigne doc clear --targets documentConfig documentStructure
-```
-
-設定をクリアした後、再度セットアッププロセスを実行して新たに開始できます。
-
----
-
-初期設定に関する詳細については、[初期設定](./configuration-initial-setup.md) ガイドを参照してください。

package/docs/guides-cleaning-up.md

@@ -1,51 +0,0 @@
-# Cleaning Up
-
-The `aigne doc clear` command provides a straightforward method for removing generated files, cached data, and configuration settings. This is useful when you want to reset your documentation project, start from a clean state, or troubleshoot issues related to outdated or corrupted files.
-
-## Interactive Cleaning
-
-The simplest way to use the command is to run it without any arguments:
-
-```bash
-aigne doc clear
-```
-
-Executing this command will launch an interactive prompt, allowing you to select precisely which items you want to remove. This is the recommended approach for most use cases as it provides clear descriptions for each option and prevents accidental data loss.
-
-## Cleanup Targets
-
-The `clear` command can remove several distinct types of data. The following table details each available target, what it does, and the specific files or directories it affects.
-
-| Target | Description | Files and Directories Affected |
-| :--- | :--- | :--- |
-| `generatedDocs` | Deletes all generated documents in your output directory, but keeps the documentation structure plan. | The directory specified by `docsDir` in your configuration. |
-| `documentStructure` | Deletes all generated documents and the documentation structure plan, effectively resetting your documentation content. | The `.aigne/doc-smith/output/structure-plan.json` file and the `docsDir` directory. |
-| `documentConfig` | Deletes the project's configuration file. You will need to run `aigne doc init` again after this. | The `.aigne/doc-smith/config.yaml` file. |
-| `authTokens` | Removes saved authorization tokens for publishing sites. You will be prompted to select which sites to clear. | The `~/.aigne/doc-smith-connected.yaml` file in your home directory. |
-| `deploymentConfig` | Deletes the `appUrl` from your configuration file. | The `.aigne/doc-smith/config.yaml` file. |
-
-## Non-Interactive Cleaning
-
-For automated scripts or users who prefer the command line, you can specify one or more targets to clear directly using the `--targets` flag. This will bypass the interactive prompt.
-
-### Clear a Single Target
-
-To clear only the generated documents, use the following command:
-
-```bash
-aigne doc clear --targets generatedDocs
-```
-
-### Clear Multiple Targets
-
-You can provide multiple target names to clear several items at once. For example, to remove both the document configuration and the documentation structure, run:
-
-```bash
-aigne doc clear --targets documentConfig documentStructure
-```
-
-After clearing your configuration, you can start fresh by running the setup process again.
-
----
-
-For more information on the initial setup, refer to the [Initial Setup](./configuration-initial-setup.md) guide.

package/docs/guides-cleaning-up.zh-TW.md

@@ -1,51 +0,0 @@
-# 清理
-
-`aigne doc clear` 指令提供了一個直接的方法來移除生成的檔案、快取資料和配置設定。當您想要重設您的文件專案、從乾淨的狀態開始，或解決與過時或損壞檔案相關的問題時，這個指令非常有用。
-
-## 互動式清理
-
-使用此指令最簡單的方法是不帶任何參數直接執行：
-
-```bash
-aigne doc clear
-```
-
-執行此指令將啟動一個互動式提示，讓您精確選擇要移除的項目。這是大多數使用情境下的建議方法，因為它為每個選項提供了清晰的說明，並能防止意外的資料遺失。
-
-## 清理目標
-
-`clear` 指令可以移除幾種不同類型的資料。下表詳細說明了每個可用的目標、其功能以及它所影響的特定檔案或目錄。
-
-| Target | 說明 | 受影響的檔案與目錄 |
-| :--- | :--- | :--- |
-| `generatedDocs` | 刪除您輸出目錄中所有已生成的檔案，但保留文件結構計畫。 | 您設定中 `docsDir` 所指定的目錄。 |
-| `documentStructure` | 刪除所有已生成的檔案和文件結構計畫，有效地重設您的文件內容。 | `.aigne/doc-smith/output/structure-plan.json` 檔案和 `docsDir` 目錄。 |
-| `documentConfig` | 刪除專案的設定檔。此操作後，您將需要重新執行 `aigne doc init`。 | `.aigne/doc-smith/config.yaml` 檔案。 |
-| `authTokens` | 移除已儲存的發布網站授權權杖。系統將提示您選擇要清除哪些網站。 | 您家目錄中的 `~/.aigne/doc-smith-connected.yaml` 檔案。 |
-| `deploymentConfig` | 從您的設定檔中刪除 `appUrl`。 | `.aigne/doc-smith/config.yaml` 檔案。 |
-
-## 非互動式清理
-
-對於自動化腳本或偏好使用命令列的使用者，您可以使用 `--targets` 旗標直接指定一個或多個要清除的目標。這將繞過互動式提示。
-
-### 清除單一目標
-
-若要僅清除已生成的檔案，請使用以下指令：
-
-```bash
-aigne doc clear --targets generatedDocs
-```
-
-### 清除多個目標
-
-您可以提供多個目標名稱來一次清除多個項目。例如，若要同時移除文件設定和文件結構，請執行：
-
-```bash
-aigne doc clear --targets documentConfig documentStructure
-```
-
-清除您的設定後，您可以再次執行設定流程以重新開始。
-
----
-
-有關初始設定的更多資訊，請參閱 [初始設定](./configuration-initial-setup.md) 指南。

package/docs/guides-cleaning-up.zh.md

@@ -1,51 +0,0 @@
-# 清理
-
-`aigne doc clear` 命令提供了一种简单直接的方法来移除生成的文件、缓存数据和配置设置。当您想要重置文档项目、从干净的状态开始或排查与过时或损坏文件相关的问题时，这个命令非常有用。
-
-## 交互式清理
-
-使用该命令最简单的方法是不带任何参数运行它：
-
-```bash
-aigne doc clear
-```
-
-执行此命令将启动一个交互式提示，让您能够精确选择要移除的项目。这是大多数用例的推荐方法，因为它为每个选项提供了清晰的描述，并能防止意外的数据丢失。
-
-## 清理目标
-
-`clear` 命令可以移除几种不同类型的数据。下表详细说明了每个可用的目标、其功能以及所影响的具体文件或目录。
-
-| Target | Description | Files and Directories Affected |
-| :--- | :--- | :--- |
-| `generatedDocs` | 删除输出目录中所有生成的文档，但保留文档结构计划。 | 您配置中由 `docsDir` 指定的目录。 |
-| `documentStructure` | 删除所有生成的文档和文档结构计划，从而有效重置您的文档内容。 | `.aigne/doc-smith/output/structure-plan.json` 文件和 `docsDir` 目录。 |
-| `documentConfig` | 删除项目的配置文件。执行此操作后，您需要重新运行 `aigne doc init`。 | `.aigne/doc-smith/config.yaml` 文件。 |
-| `authTokens` | 移除已保存的用于发布站点的授权令牌。系统将提示您选择要清除哪些站点。 | 您主目录下的 `~/.aigne/doc-smith-connected.yaml` 文件。 |
-| `deploymentConfig` | 从您的配置文件中删除 `appUrl`。 | `.aigne/doc-smith/config.yaml` 文件。 |
-
-## 非交互式清理
-
-对于自动化脚本或偏好使用命令行的用户，您可以使用 `--targets` 标志直接指定一个或多个要清理的目标。这将绕过交互式提示。
-
-### 清理单个目标
-
-要仅清理生成的文档，请使用以下命令：
-
-```bash
-aigne doc clear --targets generatedDocs
-```
-
-### 清理多个目标
-
-您可以提供多个目标名称以一次性清理多个项目。例如，要同时移除文档配置和文档结构，请运行：
-
-```bash
-aigne doc clear --targets documentConfig documentStructure
-```
-
-清理配置后，您可以通过再次运行设置过程来重新开始。
-
----
-
-有关初始设置的更多信息，请参阅 [初始设置](./configuration-initial-setup.md) 指南。