@aigne/doc-smith 0.8.12-beta.3 → 0.8.12-beta.5

package/docs/features-publish-your-docs.zh.md

@@ -1,130 +0,0 @@
-# 发布您的文档
-
-生成文档后，`aigne doc publish` 命令会上传您的文件，并通过一个可共享的链接使其可访问。本指南提供了将文档发布到 AIGNE 官方平台或自托管实例的详细步骤。
-
-## 发布流程
-
-`aigne doc publish` 命令会启动一个交互式工作流程。当您首次发布到特定目标时，CLI 将打开浏览器引导您完成一次性身份验证过程。对于后续的发布，它将使用存储在 `~/.aigne/doc-smith-connected.yaml` 中的已保存凭据。
-
-```d2 发布工作流程 icon=lucide:upload-cloud
-shape: sequence_diagram
-
-User: {
-  label: "开发者 / CI-CD"
-  shape: c4-person
-}
-
-CLI: {
-  label: "CLI\n(aigne doc publish)"
-}
-
-Local-Config: {
-  label: "本地配置\n(~/.aigne/...)"
-  shape: cylinder
-}
-
-Browser
-
-Platform: {
-  label: "平台\n(官方或自托管)"
-}
-
-User -> CLI: "运行命令"
-
-alt "交互模式" {
-  CLI -> Local-Config: "检查凭据"
-  opt "未找到凭据（首次）" {
-    CLI -> User: "提示选择平台"
-    User -> CLI: "已选择平台"
-    CLI -> Browser: "打开认证 URL"
-    User -> Browser: "登录并授权"
-    Browser -> Platform: "请求令牌"
-    Platform -> Browser: "返回令牌"
-    Browser -> CLI: "发送令牌至 CLI"
-    CLI -> Local-Config: "保存凭据"
-  }
-  CLI -> Platform: "上传文档"
-  Platform -> CLI: "确认成功"
-  CLI -> User: "显示成功消息"
-}
-
-alt "CI/CD 模式" {
-  note over CLI: "从环境变量读取令牌"
-  CLI -> Platform: "上传文档"
-  Platform -> CLI: "确认成功"
-  CLI -> User: "返回成功状态"
-}
-```
-
-## 发布选项
-
-您可以选择以下两个主要目标之一来托管您的文档：
-
-<x-cards data-columns="2">
-  <x-card data-title="官方平台" data-icon="lucide:globe">
-    发布到由 AIGNE 运营的服务 docsmith.aigne.io。对于开源项目或希望快速公开分享文档的用户来说，这是一个简单直接的选择。
-  </x-card>
-  <x-card data-title="自托管实例" data-icon="lucide:server">
-    发布到您自己的 Discuss Kit 实例，以完全控制品牌、访问权限和数据隐私。这是内部或私有文档的推荐选项。您可以按照官方文档中的说明运行自己的 Discuss Kit 实例。
-  </x-card>
-</x-cards>
-
-## 分步指南
-
-请按照以下步骤发布您的文档。
-
-### 1. 运行发布命令
-
-导航到您项目的根目录并执行以下命令：
-
-```bash 终端 icon=lucide:terminal
-aigne doc publish
-```
-
-### 2. 选择您的平台
-
-如果这是您第一次发布，系统将提示您选择一个目标。请选择符合您需求的选项。
-
-![将文档发布到官方平台或自托管平台](../assets/screenshots/doc-publish.png)
-
-如果您选择自托管实例，系统将要求您输入其 URL。
-
-### 3. 验证您的账户
-
-对于初次连接，浏览器窗口将自动打开，以便您登录并授权 CLI。此步骤每个平台仅需执行一次。访问令牌将保存在本地以供将来使用。
-
-### 4. 确认
-
-上传完成后，您的终端将显示一条成功消息，确认文档已上线。
-
-```
-✅ Documentation Published Successfully!
-```
-
-## 在 CI/CD 环境中发布
-
-要在 CI/CD 流水线等自动化工作流程中使用发布命令，您可以通过参数和环境变量提供必要信息，以绕过交互式提示。
-
-| 方法 | 名称 | 描述 |
-|---|---|---|
-| **参数** | `--appUrl` | 指定您的 Discuss Kit 实例的 URL。 |
-| **环境变量** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | 提供访问令牌以跳过交互式登录过程。 |
-
-以下是一个适用于 CI/CD 脚本的非交互式发布命令示例：
-
-```bash CI/CD 示例 icon=lucide:workflow
-export DOC_DISCUSS_KIT_ACCESS_TOKEN="your_access_token_here"
-aigne doc publish --appUrl https://docs.mycompany.com
-```
-
-## 问题排查
-
-如果在发布过程中遇到问题，可能是由以下常见问题之一引起的。
-
-- **连接错误**：CLI 可能会返回类似 `Unable to connect to: <URL>` 的错误消息。这可能是由网络问题、服务器暂时不可用或 URL不正确引起的。请验证 URL 是否正确以及服务器是否可达。
-
-- **无效的网站 URL**：该命令可能会失败，并显示消息 `The provided URL is not a valid website on ArcBlock platform`。目标 URL 必须是构建在 ArcBlock 平台上的网站。要托管您的文档，您可以运行自己的 Discuss Kit 实例。
-
-- **缺少必需组件**：错误消息 `This website does not have required components for publishing` 表明目标网站未安装 Discuss Kit 组件。请参考 Discuss Kit 文档，为您的站点添加必要的组件。
-
-有关命令和选项的完整列表，请参阅 [CLI 命令参考](./cli-reference.md)。

package/docs/features-translate-documentation.ja.md

@@ -1,90 +0,0 @@
-# ドキュメントの翻訳
-
-AIGNE DocSmithは、ドキュメントを英語、中国語、スペイン語など12の異なる言語に翻訳でき、プロジェクトを世界中のオーディエンスにアクセス可能にします。このツールは、ガイド付きセットアップのための対話モードと、正確な制御と自動化のためのコマンドライン引数の2つの方法で翻訳を管理します。
-
-## 対話型翻訳
-
-ガイド付きの体験をしたい場合は、引数なしで `translate` コマンドを実行してください。この方法は、ステップバイステップのプロセスを好むユーザーに最適です。
-
-```bash
-aigne doc translate
-```
-
-このコマンドは対話型ウィザードを起動し、プロセスをガイドします：
-
-1.  **翻訳するドキュメントの選択：** 既存のドキュメントのリストが表示されます。スペースバーを使用して翻訳したいものを選択します。
-
-    ![翻訳するドキュメントを選択](../assets/screenshots/doc-translate.png)
-
-2.  **ターゲット言語の選択：** ドキュメントを選択した後、サポートされているオプションのリストから1つ以上のターゲット言語を選びます。
-
-    ![翻訳先の言語を選択](../assets/screenshots/doc-translate-langs.png)
-
-3.  **確認と実行：** DocSmithは翻訳を処理し、選択した各言語に対して選択されたファイルの新しいバージョンを生成します。
-
-## コマンドライン翻訳
-
-スクリプトやCI/CDパイプラインでの自動化のために、コマンドラインフラグを使用して翻訳プロセスを制御します。この方法は、開発者や上級ユーザーにとってより高い柔軟性を提供します。
-
-### コマンドパラメータ
-
-<x-field-group>
-  <x-field data-name="--langs" data-type="string" data-required="false" data-desc="ターゲット言語を1つ指定します。このフラグは複数回使用して、複数の言語を含めることができます（例：--langs zh --langs ja）。"></x-field>
-  <x-field data-name="--docs" data-type="string" data-required="false" data-desc="翻訳するドキュメントのパスを指定します。これもバッチ翻訳のために複数回使用できます。"></x-field>
-  <x-field data-name="--feedback" data-type="string" data-required="false" data-desc="AIに提案を提供して翻訳品質をガイドします（例：--feedback &quot;フォーマルなトーンを使用してください&quot;）。"></x-field>
-  <x-field data-name="--glossary" data-type="string" data-required="false" data-desc="Markdown形式の用語集ファイルを使用して、特定の用語の一貫性を確保します（例：--glossary @path/to/glossary.md）。"></x-field>
-  <x-field data-name="--model" data-type="string" data-required="false" data-desc="使用する翻訳モデルを指定します。例：'openai:gpt-4o' または 'google:gemini-2.5-pro'。"></x-field>
-</x-field-group>
-
-### 例
-
-#### 特定のドキュメントの翻訳
-
-`overview.md` と `examples.md` を中国語と日本語に翻訳するには、次のコマンドを実行します：
-
-```bash
-aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
-```
-
-#### 用語集とフィードバックの使用
-
-ブランド名や技術用語が正しく翻訳されるように、用語集ファイルを提供できます。また、翻訳スタイルを洗練させるためのフィードバックも提供できます。
-
-```bash
-aigne doc translate --glossary @path/to/glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
-```
-
-#### 翻訳モデルの指定
-
-翻訳タスクに特定のAIモデルを使用するには、`--model` フラグを使用します。
-
-```bash
-aigne doc translate --docs overview.md --langs fr --model openai:gpt-4o
-```
-
-## サポートされている言語
-
-DocSmithは、以下の12言語の自動翻訳をサポートしています：
-
-| 言語             | コード    |
-| -------------------- | ------- |
-| 英語              | `en`    |
-| 簡体字中国語   | `zh-CN` |
-| 繁体字中国語  | `zh-TW` |
-| 日本語             | `ja`    |
-| 韓国語               | `ko`    |
-| スペイン語              | `es`    |
-| フランス語              | `fr`    |
-| ドイツ語              | `de`    |
-| ポルトガル語           | `pt-BR` |
-| ロシア語              | `ru`    |
-| イタリア語              | `it`    |
-| アラビア語               | `ar`    |
-
----
-
-ドキュメントが翻訳されたら、世界と共有する準備が整いました。
-
-<x-card data-title="次へ：ドキュメントの公開" data-icon="lucide:upload-cloud" data-href="/features/publish-your-docs" data-cta="続きを読む">
-  ドキュメントを公開プラットフォームや独自のプライベートウェブサイトに簡単に公開する方法についてのガイド。
-</x-card>

package/docs/features-translate-documentation.md

@@ -1,90 +0,0 @@
-# Translate Documentation
-
-AIGNE DocSmith can translate your documentation into 12 different languages, including English, Chinese, and Spanish, making your project accessible to a global audience. The tool provides two ways to manage translations: an interactive mode for a guided setup and command-line arguments for precise control and automation.
-
-## Interactive Translation
-
-For a guided experience, run the `translate` command without any arguments. This method is ideal for users who prefer a step-by-step process.
-
-```bash
-aigne doc translate
-```
-
-This command launches an interactive wizard that guides you through the process:
-
-1.  **Select Documents to Translate:** You will be presented with a list of your existing documents. Use the spacebar to select the ones you want to translate.
-
-    ![Select documents to translate](../assets/screenshots/doc-translate.png)
-
-2.  **Choose Target Languages:** After selecting your documents, pick one or more target languages from the list of supported options.
-
-    ![Select languages to translate into](../assets/screenshots/doc-translate-langs.png)
-
-3.  **Confirm and Run:** DocSmith will then process the translation, generating new versions of your selected files for each chosen language.
-
-## Command-Line Translation
-
-For automation in scripts or CI/CD pipelines, use command-line flags to control the translation process. This method provides greater flexibility for developers and advanced users.
-
-### Command Parameters
-
-<x-field-group>
-  <x-field data-name="--langs" data-type="string" data-required="false" data-desc="Specify one target language. This flag can be used multiple times to include several languages (e.g., --langs zh --langs ja)."></x-field>
-  <x-field data-name="--docs" data-type="string" data-required="false" data-desc="Specify the path of a document to translate. This can also be used multiple times for batch translation."></x-field>
-  <x-field data-name="--feedback" data-type="string" data-required="false" data-desc="Provide suggestions to the AI to guide the translation quality (e.g., --feedback &quot;Use a formal tone&quot;)."></x-field>
-  <x-field data-name="--glossary" data-type="string" data-required="false" data-desc="Use a glossary file in Markdown format to ensure consistent terminology for specific terms (e.g., --glossary @path/to/glossary.md)."></x-field>
-  <x-field data-name="--model" data-type="string" data-required="false" data-desc="Specify the translation model to use, for example, 'openai:gpt-4o' or 'google:gemini-2.5-pro'."></x-field>
-</x-field-group>
-
-### Examples
-
-#### Translating Specific Documents
-
-To translate `overview.md` and `examples.md` into Chinese and Japanese, run the following command:
-
-```bash
-aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
-```
-
-#### Using a Glossary and Feedback
-
-To ensure brand names and technical terms are translated correctly, you can provide a glossary file. You can also give feedback to refine the translation style.
-
-```bash
-aigne doc translate --glossary @path/to/glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
-```
-
-#### Specifying a Translation Model
-
-To use a specific AI model for the translation task, use the `--model` flag.
-
-```bash
-aigne doc translate --docs overview.md --langs fr --model openai:gpt-4o
-```
-
-## Supported Languages
-
-DocSmith supports automatic translation for the following 12 languages:
-
-| Language             | Code    |
-| -------------------- | ------- |
-| English              | `en`    |
-| Simplified Chinese   | `zh-CN` |
-| Traditional Chinese  | `zh-TW` |
-| Japanese             | `ja`    |
-| Korean               | `ko`    |
-| Spanish              | `es`    |
-| French               | `fr`    |
-| German               | `de`    |
-| Portuguese           | `pt-BR` |
-| Russian              | `ru`    |
-| Italian              | `it`    |
-| Arabic               | `ar`    |
-
----
-
-Once your documentation is translated, you are ready to share it with the world.
-
-<x-card data-title="Next: Publish Your Docs" data-icon="lucide:upload-cloud" data-href="/features/publish-your-docs" data-cta="Read More">
-  A guide on how to easily publish your documentation to a public platform or your own private website.
-</x-card>

package/docs/features-translate-documentation.zh-TW.md

@@ -1,90 +0,0 @@
-# 翻譯文件
-
-AIGNE DocSmith 可以將您的文件翻譯成 12 種不同的語言，包括英文、中文和西班牙文，讓您的專案能觸及全球受眾。該工具提供兩種管理翻譯的方式：用於引導式設定的互動模式，以及用於精確控制和自動化的命令列參數。
-
-## 互動式翻譯
-
-若要獲得引導式體驗，請執行不含任何參數的 `translate` 命令。此方法非常適合偏好逐步操作的使用者。
-
-```bash
-aigne doc translate
-```
-
-此命令會啟動一個互動式精靈，引導您完成整個過程：
-
-1.  **選擇要翻譯的文件：** 系統會顯示您現有文件的列表。使用空格鍵選擇您要翻譯的文件。
-
-    ![選擇要翻譯的文件](../assets/screenshots/doc-translate.png)
-
-2.  **選擇目標語言：** 選擇文件後，從支援的選項列表中選擇一種或多種目標語言。
-
-    ![選擇要翻譯成的語言](../assets/screenshots/doc-translate-langs.png)
-
-3.  **確認並執行：** DocSmith 隨後會處理翻譯，為您選擇的每個檔案生成對應各種語言的新版本。
-
-## 命令列翻譯
-
-對於在腳本或 CI/CD 流程中進行自動化，請使用命令列旗標來控制翻譯過程。此方法為開發人員和進階使用者提供了更大的靈活性。
-
-### 命令參數
-
-<x-field-group>
-  <x-field data-name="--langs" data-type="string" data-required="false" data-desc="指定一種目標語言。此旗標可多次使用以包含多種語言（例如，--langs zh --langs ja）。"></x-field>
-  <x-field data-name="--docs" data-type="string" data-required="false" data-desc="指定要翻譯的文件路徑。此旗標也可多次使用以進行批次翻譯。"></x-field>
-  <x-field data-name="--feedback" data-type="string" data-required="false" data-desc="向 AI 提供建議以引導翻譯品質（例如，--feedback &quot;使用正式語氣&quot;）。"></x-field>
-  <x-field data-name="--glossary" data-type="string" data-required="false" data-desc="使用 Markdown 格式的詞彙表檔案，以確保特定術語的一致性（例如，--glossary @path/to/glossary.md）。"></x-field>
-  <x-field data-name="--model" data-type="string" data-required="false" data-desc="指定要使用的翻譯模型，例如 'openai:gpt-4o' 或 'google:gemini-2.5-pro'。"></x-field>
-</x-field-group>
-
-### 範例
-
-#### 翻譯特定文件
-
-若要將 `overview.md` 和 `examples.md` 翻譯成中文和日文，請執行以下命令：
-
-```bash
-aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
-```
-
-#### 使用詞彙表和回饋
-
-為確保品牌名稱和技術術語翻譯正確，您可以提供一個詞彙表檔案。您也可以提供回饋來改善翻譯風格。
-
-```bash
-aigne doc translate --glossary @path/to/glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
-```
-
-#### 指定翻譯模型
-
-若要使用特定的 AI 模型執行翻譯任務，請使用 `--model` 旗標。
-
-```bash
-aigne doc translate --docs overview.md --langs fr --model openai:gpt-4o
-```
-
-## 支援的語言
-
-DocSmith 支援以下 12 種語言的自動翻譯：
-
-| 語言               | 代碼    |
-| -------------------- | ------- |
-| 英文                 | `en`    |
-| 簡體中文             | `zh-CN` |
-| 繁體中文             | `zh-TW` |
-| 日文                 | `ja`    |
-| 韓文                 | `ko`    |
-| 西班牙文             | `es`    |
-| 法文                 | `fr`    |
-| 德文                 | `de`    |
-| 葡萄牙文             | `pt-BR` |
-| 俄文                 | `ru`    |
-| 義大利文             | `it`    |
-| 阿拉伯文             | `ar`    |
-
----
-
-文件翻譯完成後，您就可以與全世界分享了。
-
-<x-card data-title="下一步：發佈您的文件" data-icon="lucide:upload-cloud" data-href="/features/publish-your-docs" data-cta="閱讀更多">
-  關於如何輕鬆將您的文件發佈到公共平台或您自己的私人網站的指南。
-</x-card>

package/docs/features-translate-documentation.zh.md

@@ -1,90 +0,0 @@
-# 翻译文档
-
-AIGNE DocSmith 可以将您的文档翻译成 12 种不同的语言，包括英语、中文和西班牙语，让您的项目触达全球受众。该工具提供两种管理翻译的方式：用于引导式设置的交互模式和用于精确控制和自动化的命令行参数。
-
-## 交互式翻译
-
-要获得引导式体验，请在不带任何参数的情况下运行 `translate` 命令。此方法非常适合偏好分步操作的用户。
-
-```bash
-aigne doc translate
-```
-
-此命令会启动一个交互式向导，引导您完成整个过程：
-
-1.  **选择要翻译的文档：** 您将看到一个现有文档的列表。使用空格键选择您想要翻译的文档。
-
-    ![选择要翻译的文档](../assets/screenshots/doc-translate.png)
-
-2.  **选择目标语言：** 选择文档后，从支持的选项列表中选择一种或多种目标语言。
-
-    ![选择要翻译成的语言](../assets/screenshots/doc-translate-langs.png)
-
-3.  **确认并运行：** DocSmith 随后将处理翻译，为每个选定的语言生成所选文件的新版本。
-
-## 命令行翻译
-
-要在脚本或 CI/CD 管道中实现自动化，请使用命令行标志来控制翻译过程。此方法为开发人员和高级用户提供了更大的灵活性。
-
-### 命令参数
-
-<x-field-group>
-  <x-field data-name="--langs" data-type="string" data-required="false" data-desc="指定一个目标语言。此标志可以多次使用以包含多种语言（例如，--langs zh --langs ja）。"></x-field>
-  <x-field data-name="--docs" data-type="string" data-required="false" data-desc="指定要翻译的文档路径。此标志也可以多次使用以进行批量翻译。"></x-field>
-  <x-field data-name="--feedback" data-type="string" data-required="false" data-desc="向 AI 提供建议以指导翻译质量（例如，--feedback &quot;使用正式语气&quot;）。"></x-field>
-  <x-field data-name="--glossary" data-type="string" data-required="false" data-desc="使用 Markdown 格式的术语表文件，以确保特定术语的用词一致（例如，--glossary @path/to/glossary.md）。"></x-field>
-  <x-field data-name="--model" data-type="string" data-required="false" data-desc="指定要使用的翻译模型，例如 'openai:gpt-4o' 或 'google:gemini-2.5-pro'。"></x-field>
-</x-field-group>
-
-### 示例
-
-#### 翻译特定文档
-
-要将 `overview.md` 和 `examples.md` 翻译成中文和日文，请运行以下命令：
-
-```bash
-aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
-```
-
-#### 使用术语表和反馈
-
-为确保品牌名称和技术术语翻译正确，您可以提供一个术语表文件。您还可以提供反馈以改进翻译风格。
-
-```bash
-aigne doc translate --glossary @path/to/glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
-```
-
-#### 指定翻译模型
-
-要使用特定的 AI 模型执行翻译任务，请使用 `--model` 标志。
-
-```bash
-aigne doc translate --docs overview.md --langs fr --model openai:gpt-4o
-```
-
-## 支持的语言
-
-DocSmith 支持以下 12 种语言的自动翻译：
-
-| 语言 | 代码 |
-| -------------------- | ------- |
-| 英语 | `en` |
-| 简体中文 | `zh-CN` |
-| 繁体中文 | `zh-TW` |
-| 日语 | `ja` |
-| 韩语 | `ko` |
-| 西班牙语 | `es` |
-| 法语 | `fr` |
-| 德语 | `de` |
-| 葡萄牙语 | `pt-BR` |
-| 俄语 | `ru` |
-| 意大利语 | `it` |
-| 阿拉伯语 | `ar` |
-
----
-
-文档翻译完成后，您就可以与全世界分享了。
-
-<x-card data-title="下一步：发布您的文档" data-icon="lucide:upload-cloud" data-href="/features/publish-your-docs" data-cta="阅读更多">
-  一份关于如何轻松将您的文档发布到公共平台或您自己的私人网站的指南。
-</x-card>

package/docs/features-update-and-refine.ja.md

@@ -1,142 +0,0 @@
-# 更新と改良
-
-進化するコードベースとドキュメントを同期させることは、系統的なプロセスです。AIGNE DocSmith は、コードの変更に基づく自動更新、またはフィードバックに基づいた正確な改良を通じて、コンテンツを最新の状態に保つための直接的で柔軟なコマンドを提供します。
-
-このガイドでは、以下のタスクの手順を説明します。
-
-*   ソースコードが変更されたときにドキュメントを自動的に更新する。
-*   ターゲットを絞ったフィードバックを使用して特定のドキュメントを再生成する。
-*   ドキュメント全体の構造を調整する。
-
-### ドキュメント更新ワークフロー
-
-以下の図は、ドキュメントを更新するために利用可能なさまざまなワークフローを示しています。
-
-```d2 ドキュメント更新ワークフロー
-direction: down
-
-Developer: {
-  shape: c4-person
-}
-
-Source-Code: {
-  label: "ソースコード"
-}
-
-Documentation: {
-  label: "ドキュメント"
-}
-
-Action-Choice: {
-  label: "アクションを選択"
-  shape: diamond
-}
-
-Generate-Sync: {
-  label: "aigne doc generate"
-  shape: rectangle
-
-  Change-Detection: {
-    label: "変更を検出？"
-    shape: diamond
-  }
-  Regenerate-Affected: "影響を受けるものを再生成"
-  Regenerate-All: "すべてを再生成"
-
-  Change-Detection -> Regenerate-Affected: "はい (デフォルト)"
-  Change-Detection -> Regenerate-All: "いいえ\n(--forceRegenerate)"
-}
-
-Refine-Content: {
-  label: "aigne doc update"
-}
-
-Refine-Structure: {
-  label: "aigne doc generate\n--feedback"
-}
-
-Developer -> Action-Choice
-
-Action-Choice -> Generate-Sync: "コードと同期"
-Action-Choice -> Refine-Content: "ドキュメント内容を改良"
-Action-Choice -> Refine-Structure: "ドキュメント構造を改良"
-
-Source-Code -> Generate-Sync
-
-Generate-Sync.Regenerate-Affected -> Documentation: "更新"
-Generate-Sync.Regenerate-All -> Documentation: "更新"
-Refine-Content -> Documentation: "更新"
-Refine-Structure -> Documentation: "更新"
-```
-
----
-
-## 変更検出による自動更新
-
-`aigne doc generate` コマンドを実行すると、DocSmith はまずコードベースを分析して、最後の生成以降の変更を検出します。次に、これらの変更によって影響を受けるドキュメントのみを再生成します。このデフォルトの動作により、冗長な操作を回避することで、時間を節約し、API の使用量を削減します。
-
-```shell icon=lucide:terminal
-# DocSmith が変更を検出し、必要なものだけを更新します
-aigne doc generate
-```
-
-![DocSmith は変更を検出し、必要なドキュメントのみを再生成します。](../assets/screenshots/doc-regenerate.png)
-
-### 完全な再生成の強制
-
-キャッシュと変更検出をバイパスして、すべてのドキュメントを最初から再生成するには、`--forceRegenerate` フラグを使用します。これは、大幅な設定変更を行った場合や、すべてのファイルで一貫性を確保するために完全な再構築が必要な場合に必要です。
-
-```shell icon=lucide:terminal
-# すべてのドキュメントをゼロから再生成する
-aigne doc generate --forceRegenerate
-```
-
----
-
-## フィードバックによるドキュメントの改良
-
-対応するコードの変更なしに、CLI コマンドに直接フィードバックを提供することでドキュメントを改良できます。これは、明確さを向上させたり、例を追加したり、構造を調整したりするのに役立ちます。
-
-### 個別ドキュメント内容の改良
-
-特定のドキュメントの内容を改善するには、`aigne doc update` コマンドを使用します。このコマンドを使用すると、改良のための具体的な指示を提供でき、インタラクティブモードと非インタラクティブモードの2つのモードで実行できます。
-
-#### インタラクティブモード
-
-ガイド付きのプロセスについては、引数なしでコマンドを実行します。DocSmith は、更新したいドキュメントを選択するためのメニューを表示します。選択後、フィードバックを入力するよう求められます。
-
-```shell icon=lucide:terminal
-# インタラクティブな更新プロセスを開始する
-aigne doc update
-```
-
-![更新したいドキュメントをインタラクティブに選択します。](../assets/screenshots/doc-update.png)
-
-#### 非インタラクティブモード
-
-スクリプト化された、またはより高速なワークフローの場合、フラグを使用してドキュメントとフィードバックを直接指定できます。これにより、正確な非インタラクティブな更新が可能になります。
-
-```shell icon=lucide:terminal
-# 特定のドキュメントをフィードバックで更新する
-aigne doc update --docs overview.md --feedback "最後に、より詳細な FAQ セクションを追加してください。"
-```
-
-`update` コマンドの主要なパラメータは次のとおりです。
-
-| パラメータ | 説明 |
-| :--- | :--- |
-| `--docs` | 更新するドキュメントへのパス。このフラグはバッチ更新のために複数回使用できます。 |
-| `--feedback` | ドキュメントのコンテンツを再生成する際に使用される具体的な指示を含む文字列。 |
-
-### 全体構造の最適化
-
-個々のドキュメントの改良に加えて、ドキュメント全体の構造を調整することもできます。既存の構成が最適でない場合やセクションが欠落している場合は、`generate` コマンドにフィードバックを提供できます。これにより、DocSmith はあなたの入力に基づいてドキュメントプラン全体を再評価するよう指示されます。
-
-```shell icon=lucide:terminal
-# 特定のフィードバックでドキュメント構造を再生成する
-aigne doc generate --feedback "'概要'セクションを削除し、詳細な'APIリファレンス'を追加してください。"
-```
-
-このアプローチは、単一ファイル内のマイナーなコンテンツ編集ではなく、ドキュメントの目次に対する高レベルの変更を目的としています。
-
-コンテンツが改良されたら、次のステップはそれを世界中の読者に向けて準備することです。手順については、[ドキュメントの翻訳](./features-translate-documentation.md)ガイドを参照してください。