@aigne/doc-smith 0.8.11-beta → 0.8.11-beta.2

package/docs/configuration.zh.md

@@ -1,16 +1,16 @@
 # 配置指南
 
-AIGNE DocSmith 的行为由一个位于 `.aigne/doc-smith/config.yaml` 的核心文件 `config.yaml` 控制。该文件决定了文档的风格、目标受众、语言和结构。
+AIGNE DocSmith 的行为由一个中央文件 `config.yaml` 控制，该文件位于 `.aigne/doc-smith/config.yaml`。此文件规定了文档的风格、目标受众、语言和结构。
 
-你可以通过运行 `aigne doc init` 使用交互式设置向导来创建和管理此文件。有关分步演练，请参阅 [交互式设置](./configuration-interactive-setup.md) 指南。
+您可以通过运行 `aigne doc init` 使用交互式设置向导来创建和管理此文件。有关分步演练，请参阅[交互式设置](./configuration-interactive-setup.md)指南。
 
-## 核心配置区域
+## 核心配置领域
 
-你的文档由几个关键的配置区域决定。浏览这些指南，了解如何微调生成过程的各个方面。
+您的文档由几个关键的配置领域来塑造。浏览这些指南，了解如何微调生成过程的每个方面。
 
 <x-cards data-columns="2">
   <x-card data-title="交互式设置" data-icon="lucide:wand-2" data-href="/configuration/interactive-setup">
-    了解引导式向导如何帮助你配置文档项目，包括设置建议和冲突检测。
+    了解引导式向导如何帮助您配置文档项目，包括设置建议和冲突检测。
   </x-card>
   <x-card data-title="LLM 设置" data-icon="lucide:brain-circuit" data-href="/configuration/llm-setup">
     了解如何连接不同的 AI 模型，包括使用无需 API 密钥的内置 AIGNE Hub。
@@ -19,109 +19,109 @@ AIGNE DocSmith 的行为由一个位于 `.aigne/doc-smith/config.yaml` 的核心
     查看支持的语言完整列表，并了解如何设置主语言和启用自动翻译。
   </x-card>
   <x-card data-title="管理偏好" data-icon="lucide:sliders-horizontal" data-href="/configuration/preferences">
-    了解 DocSmith 如何利用你的反馈创建持久化规则，以及如何通过 CLI 管理这些规则。
+    了解 DocSmith 如何利用您的反馈创建持久性规则，以及如何通过 CLI 管理这些规则。
   </x-card>
 </x-cards>
 
 ## 参数参考
 
-`config.yaml` 文件包含几个用于控制文档输出的键值对。以下是每个参数的详细参考。
+`config.yaml` 文件包含几个控制文档输出的键值对。以下是每个参数的详细参考。
 
 ### 项目信息
 
-这些设置提供了关于项目的基本背景信息，用于发布文档。
+这些设置提供了有关您项目的基本背景信息，用于发布文档。
 
-| Parameter | Description |
+| 参数 | 描述 |
 |---|---|
-| `projectName` | 你的项目名称。如果可用，将从 `package.json` 中检测。 |
-| `projectDesc` | 你的项目的简短描述。从 `package.json` 中检测。 |
-| `projectLogo` | 你的项目徽标图片的路径或 URL。 |
+| `projectName` | 您的项目名称。如果可用，则从 `package.json` 中检测。 |
+| `projectDesc` | 您的项目的简短描述。从 `package.json` 中检测。 |
+| `projectLogo` | 您的项目徽标图像的路径或 URL。 |
 
 ### 文档策略
 
 这些参数定义了生成内容的基调、风格和深度。
 
 #### `documentPurpose`
-定义你希望读者达到的主要成果。此设置会影响文档的整体结构和重点。
+定义您希望读者实现的主要成果。此设置会影响文档的整体结构和重点。
 
-| Option | Name | Description |
+| 选项 | 名称 | 描述 |
 |---|---|---|
-| `getStarted` | 快速入门 | 帮助新用户在 30 分钟内从零开始上手。 |
-| `completeTasks` | 完成特定任务 | 引导用户完成常见工作流程和用例。 |
+| `getStarted` | 快速入门 | 帮助新用户在30分钟内从零开始上手。 |
+| `completeTasks` | 完成特定任务 | 引导用户完成常见的工作流程和用例。 |
 | `findAnswers` | 快速查找答案 | 为所有功能和 API 提供可搜索的参考。 |
 | `understandSystem`| 理解系统 | 解释其工作原理以及做出设计决策的原因。 |
-| `solveProblems` | 解决常见问题 | 帮助用户排查和修复问题。 |
+| `solveProblems` | 排查常见问题 | 帮助用户排查和修复问题。 |
 | `mixedPurpose` | 服务于多种目的 | 涵盖多种需求的文档。 |
 
 #### `targetAudienceTypes`
-定义最常阅读此文档的受众。此选择会影响写作风格和示例。
+定义最常阅读此文档的读者。此选择会影响写作风格和示例。
 
-| Option | Name | Description |
+| 选项 | 名称 | 描述 |
 |---|---|---|
 | `endUsers` | 最终用户（非技术人员） | 使用产品但不编码的人员。 |
-| `developers` | 集成你的产品/API 的开发者 | 将此添加到其项目中的工程师。 |
+| `developers` | 集成您的产品/API 的开发人员 | 将此添加到其项目中的工程师。 |
 | `devops` | DevOps / SRE / 基础设施团队 | 部署、监控和维护系统的团队。 |
-| `decisionMakers`| 技术决策者 | 评估或规划实施的架构师或负责人。 |
+| `decisionMakers`| 技术决策者 | 评估或计划实施的架构师或负责人。 |
 | `supportTeams` | 支持团队 | 帮助他人使用产品的人员。 |
-| `mixedTechnical`| 混合技术受众 | 开发者、DevOps 和其他技术用户。 |
+| `mixedTechnical`| 混合技术受众 | 开发人员、DevOps 和其他技术用户。 |
 
 #### `readerKnowledgeLevel`
-定义读者通常具备的知识水平。这会调整对基础知识的假设程度。
+定义读者通常在阅读前已具备的知识。这会调整对基础知识的假设程度。
 
-| Option | Name | Description |
+| 选项 | 名称 | 描述 |
 |---|---|---|
-| `completeBeginners` | 完全的初学者，从零开始 | 完全不熟悉此领域/技术。 |
-| `domainFamiliar` | 之前使用过类似工具 | 了解问题领域，但对这个特定解决方案不熟悉。 |
-| `experiencedUsers` | 试图做特定事情的专家 | 需要参考或高级主题的常规用户。 |
-| `emergencyTroubleshooting`| 紧急情况/故障排查 | 出现问题，需要快速修复。 |
-| `exploringEvaluating` | 正在评估此工具并与其他工具进行比较 | 试图了解这是否符合他们的需求。 |
+| `completeBeginners` | 完全是初学者，从零开始 | 完全不熟悉该领域/技术。 |
+| `domainFamiliar` | 之前使用过类似的工具 | 了解问题领域，但对这个具体解决方案不熟悉。 |
+| `experiencedUsers` | 是试图做某件特定事情的专家 | 需要参考或高级主题的常规用户。 |
+| `emergencyTroubleshooting`| 紧急/故障排查 | 某些东西坏了，需要快速修复。 |
+| `exploringEvaluating` | 正在将此工具与其他工具进行评估 | 试图了解这是否符合他们的需求。 |
 
 #### `documentationDepth`
 定义文档应达到的全面程度。
 
-| Option | Name | Description |
+| 选项 | 名称 | 描述 |
 |---|---|---|
-| `essentialOnly` | 仅限基本内容 | 涵盖 80% 的用例，保持简洁。 |
+| `essentialOnly` | 仅限基本内容 | 覆盖 80% 的用例，保持简洁。 |
 | `balancedCoverage`| 均衡覆盖 | 具有良好深度和实际示例 [推荐]。 |
-| `comprehensive` | 全面 | 涵盖所有功能、边缘情况和高级场景。 |
+| `comprehensive` | 全面 | 覆盖所有功能、边缘情况和高级场景。 |
 | `aiDecide` | 让 AI 决定 | 分析代码复杂性并建议适当的深度。 |
 
 ### 自定义指令
 
-为实现更精细的控制，你可以提供自由文本指令。
+为了更精细的控制，您可以提供自由文本指令。
 
-| Parameter | Description |
+| 参数 | 描述 |
 |---|---|
-| `rules` | 一个多行字符串，你可以在其中定义特定的文档生成规则（例如，“始终包含性能基准测试”）。 |
-| `targetAudience`| 一个多行字符串，用于比预设更详细地描述你的特定目标受众。 |
+| `rules` | 一个多行字符串，您可以在其中定义特定的文档生成规则（例如，“始终包含性能基准测试”）。 |
+| `targetAudience`| 一个多行字符串，用于比预设更详细地描述您的特定目标受众。 |
 
 ### 语言和路径配置
 
 这些设置控制本地化和文件位置。
 
-| Parameter | Description |
+| 参数 | 描述 |
 |---|---|
-| `locale` | 文档的主语言（例如，`en`、`zh`）。 |
-| `translateLanguages` | 要将文档翻译成的语言代码列表（例如，`[ja, fr, es]`）。 |
+| `locale` | 文档的主要语言（例如 `en`、`zh`）。 |
+| `translateLanguages` | 要将文档翻译成的语言代码列表（例如 `[ja, fr, es]`）。 |
 | `docsDir` | 保存生成的文档文件的目录。 |
-| `sourcesPath` | 供 DocSmith 分析的源代码路径或 glob 模式列表（例如，`['./src', './lib/**/*.js']`）。 |
+| `sourcesPath` | 供 DocSmith 分析的源代码路径或 glob 模式列表（例如 `['./src', './lib/**/*.js']`）。 |
 | `glossary` | 包含项目特定术语的 markdown 文件（`@glossary.md`）的路径，以确保翻译的一致性。 |
 
-## config.yaml 示例
+## `config.yaml` 示例
 
-这是一个完整的配置文件示例。你可以随时直接编辑此文件以更改设置。
+这是一个完整的配置文件示例。您可以随时直接编辑此文件以更改设置。
 
 ```yaml Example config.yaml icon=logos:yaml
 # 用于文档发布的项目信息
 projectName: AIGNE DocSmith
-projectDesc: An AI-driven documentation generation tool.
+projectDesc: 一个 AI 驱动的文档生成工具。
 projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
 
 # =============================================================================
 # 文档配置
 # =============================================================================
 
-# 目的：你希望读者达到的主要成果是什么？
+# 目的：您希望读者实现的主要成果是什么？
 # 选项：getStarted, completeTasks, findAnswers, understandSystem, solveProblems, mixedPurpose
 documentPurpose:
   - completeTasks
@@ -132,11 +132,11 @@ documentPurpose:
 targetAudienceTypes:
   - developers
 
-# 读者知识水平：读者通常具备什么知识？
+# 读者知识水平：读者在阅读前通常具备哪些知识？
 # 选项：completeBeginners, domainFamiliar, experiencedUsers, emergencyTroubleshooting, exploringEvaluating
 readerKnowledgeLevel: domainFamiliar
 
-# 文档深度：文档应该有多全面？
+# 文档深度：文档应达到多大的全面程度？
 # 选项：essentialOnly, balancedCoverage, comprehensive, aiDecide
 documentationDepth: balancedCoverage
 
@@ -144,14 +144,14 @@ documentationDepth: balancedCoverage
 rules: |+
   
 
-# 目标受众：描述你的特定目标受众及其特征
+# 目标受众：描述您的特定目标受众及其特征
 targetAudience: |+
   
 
 # 术语表：包含项目特定术语和定义的 markdown 文件的路径
 # glossary: "@glossary.md"
 
-# 文档的主语言
+# 文档的主要语言
 locale: en
 
 # 要将文档翻译成的语言列表
@@ -167,6 +167,6 @@ sourcesPath:
   - ./
 ```
 
-完成配置后，你就可以创建符合项目需求的文档了。下一步是运行生成命令。
+配置设置完成后，您就可以创建符合项目需求的文档了。下一步是运行生成命令。
 
 ➡️ **下一步：** [生成文档](./features-generate-documentation.md)

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

@@ -0,0 +1,101 @@
+# ドキュメントの生成
+
+`aigne doc generate`コマンドは、ソースコードから完全なドキュメントセットを作成するための中核機能です。このプロセスでは、コードベースを分析し、論理的なドキュメント構造を計画し、各セクションのコンテンツを生成します。これは、ドキュメントをゼロから作成するための主要な方法です。
+
+## 最初の生成
+
+まず、プロジェクトのルートディレクトリに移動し、次のコマンドを実行します。
+
+```bash
+aigne doc generate
+```
+
+### 自動設定
+
+このコマンドをプロジェクトで初めて実行すると、DocSmithは設定が存在しないことを検出し、対話型のセットアップウィザードを起動して初期設定を案内します。これにより、生成を開始する前に環境が適切に設定されていることを確認できます。
+
+![初めてgenerateコマンドを実行するとセットアップウィザードがトリガーされます](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
+
+以下を定義するための一連の質問が表示されます。
+
+- ドキュメントの生成ルールとスタイル
+- 対象読者
+- プライマリ言語と翻訳言語
+- ソースコードと出力パス
+
+![質問に答えて、ドキュメントのスタイル、言語、ソースパスを設定します](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
+
+設定が完了すると、DocSmithはドキュメントの生成に進みます。
+
+![DocSmithがコードを分析し、構造を計画し、各ドキュメントを生成します](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
+
+正常に完了すると、新しく作成されたドキュメントが指定した出力ディレクトリで利用可能になります。
+
+![完了すると、指定した出力ディレクトリに新しいドキュメントが見つかります](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
+
+## 生成プロセス
+
+`generate`コマンドは、自動化されたワークフローに従います。プロセスは次のように視覚化できます。
+
+```d2
+direction: down
+
+start: "開始" {
+  shape: oval
+}
+
+run_cmd: "`aigne doc generate` を実行" {
+  shape: rectangle
+}
+
+check_config: "設定は存在するか？" {
+  shape: diamond
+}
+
+interactive_setup: "対話型セットアップウィザードを起動" {
+  shape: rectangle
+}
+
+plan_structure: "1. コードを分析し、構造を計画" {
+  shape: rectangle
+}
+
+gen_content: "2. ドキュメントコンテンツを生成" {
+  shape: rectangle
+}
+
+save_docs: "3. ドキュメントを保存" {
+  shape: rectangle
+}
+
+end: "終了" {
+  shape: oval
+}
+
+start -> run_cmd
+run_cmd -> check_config
+check_config -> interactive_setup: "いいえ"
+interactive_setup -> plan_structure
+check_config -> plan_structure: "はい"
+plan_structure -> gen_content
+gen_content -> save_docs
+save_docs -> end
+```
+
+## コマンドオプション
+
+デフォルトの`generate`コマンドはほとんどのユースケースで十分ですが、生成プロセスを制御するためにいくつかのオプションを使用できます。これらは、コンテンツの再生成やドキュメント構造の改良に役立ちます。
+
+| オプション          | 説明                                                                                                                                     | 例                                                                   |
+|---------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
+| `--forceRegenerate` | 既存のすべてのドキュメントを削除し、ゼロから再生成します。ソースコードや設定に大幅な変更を加えた後に使用します。 | `aigne doc generate --forceRegenerate`                                 |
+| `--feedback`        | セクションの追加、削除、再編成など、ドキュメント全体の構造を改良するための高レベルなフィードバックを提供します。           | `aigne doc generate --feedback "APIリファレンスセクションを追加"`         |
+| `--model`           | AIGNE Hubから特定の 大規模言語モデルを指定してコンテンツ生成に使用し、モデル間の切り替えを可能にします。       | `aigne doc generate --model claude:claude-3-5-sonnet`                |
+
+## 次のステップ
+
+初期のドキュメントを生成した後も、プロジェクトは進化し続けます。ドキュメントをコードと同期させるためには、更新が必要です。次のセクションに進み、対象を絞った変更を行い、特定のファイルを再生成する方法を学びましょう。
+
+<x-card data-title="更新と改良" data-icon="lucide:file-edit" data-href="/features/update-and-refine">
+  コードが変更された際のドキュメントの更新方法や、フィードバックを使用して特定の改善を行う方法を学びます。
+</x-card>

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

@@ -0,0 +1,101 @@
+# 產生文件
+
+`aigne doc generate` 命令是從您的原始碼建立完整文件集的核心功能。此過程會分析您的程式碼庫、規劃邏輯性的文件結構，然後為每個部分產生內容。這是從零開始建立文件的主要方式。
+
+## 您的首次產生
+
+首先，請導覽至您專案的根目錄並執行以下命令：
+
+```bash
+aigne doc generate
+```
+
+### 自動設定
+
+當您首次在專案中執行此命令時，DocSmith 會偵測到尚無設定。接著，它會啟動一個互動式設定精靈，引導您完成初始設定。這能確保在開始產生文件前，您擁有一個正確配置的環境。
+
+![首次執行 generate 命令會觸發設定精靈](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
+
+系統會詢問您一系列問題以定義：
+
+- 文件產生規則與風格
+- 目標讀者
+- 主要語言與翻譯語言
+- 原始碼與輸出路徑
+
+![回答問題以設定您的文件風格、語言和來源路徑](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
+
+設定完成後，DocSmith 將繼續進行文件產生。
+
+![DocSmith 會分析您的程式碼、規劃結構並產生每個文件](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
+
+成功完成後，您新建立的文件將會出現在您指定的輸出目錄中。
+
+![完成後，您將在指定的輸出目錄中找到新文件](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
+
+## 產生過程
+
+`generate` 命令遵循一個自動化的工作流程。其過程可視覺化如下：
+
+```d2
+direction: down
+
+start: "開始" {
+  shape: oval
+}
+
+run_cmd: "執行 `aigne doc generate`" {
+  shape: rectangle
+}
+
+check_config: "找到設定檔？" {
+  shape: diamond
+}
+
+interactive_setup: "啟動互動式設定精靈" {
+  shape: rectangle
+}
+
+plan_structure: "1. 分析程式碼並規劃結構" {
+  shape: rectangle
+}
+
+gen_content: "2. 產生文件內容" {
+  shape: rectangle
+}
+
+save_docs: "3. 儲存文件" {
+  shape: rectangle
+}
+
+end: "結束" {
+  shape: oval
+}
+
+start -> run_cmd
+run_cmd -> check_config
+check_config -> interactive_setup: "否"
+interactive_setup -> plan_structure
+check_config -> plan_structure: "是"
+plan_structure -> gen_content
+gen_content -> save_docs
+save_docs -> end
+```
+
+## 命令選項
+
+雖然預設的 `generate` 命令已足夠應付大多數使用情境，但您仍可使用數個選項來控制產生過程。這些選項對於重新產生內容或優化文件結構很有幫助。
+
+| Option              | Description                                                                                                                              | Example                                                              |
+|---------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
+| `--forceRegenerate` | 刪除所有現有文件並從頭開始重新產生。當您的原始碼或設定有重大變更時，請使用此選項。 | `aigne doc generate --forceRegenerate`                                 |
+| `--feedback`        | 提供高層次的回饋以優化整體文件結構，例如新增、移除或重組章節。           | `aigne doc generate --feedback "Add an API Reference section"`         |
+| `--model`           | 指定一個來自 AIGNE Hub 的特定大型語言模型用於內容產生，讓您可以在不同模型之間切換。       | `aigne doc generate --model claude:claude-3-5-sonnet`                |
+
+## 接下來呢？
+
+既然您已經產生了初始文件，您的專案將會持續發展。為了讓文件與程式碼保持同步，您需要更新它們。請前往下一節，學習如何進行針對性修改並重新產生特定檔案。
+
+<x-card data-title="更新與優化" data-icon="lucide:file-edit" data-href="/features/update-and-refine">
+  了解當程式碼變更時如何更新文件，或利用回饋進行特定改進。
+</x-card>

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

@@ -1,10 +1,10 @@
 # 生成文档
 
-`aigne doc generate` 命令是从源代码创建完整文档集的核心功能。该过程会分析你的代码库，规划逻辑化的文档结构，然后为每个部分生成内容。这是从零开始创建文档的主要方式。
+`aigne doc generate` 命令是用于从源代码创建完整文档集的核心功能。此过程会分析您的代码库，规划逻辑文档结构，然后为每个部分生成内容。这是从头开始创建文档的主要方式。
 
 ## 首次生成
 
-首先，请导航到项目的根目录并运行以下命令：
+首先，请导航到您项目的根目录并运行以下命令：
 
 ```bash
 aigne doc generate
@@ -12,30 +12,30 @@ aigne doc generate
 
 ### 自动配置
 
-如果这是你首次在项目中运行此命令，DocSmith 会检测到尚无配置。接着，它将启动一个交互式设置向导，引导你完成初始设置。这能确保在生成开始前，你拥有一个正确配置的环境。
+如果您在项目中首次运行此命令，DocSmith 会检测到不存在任何配置。然后，它将启动一个交互式设置向导来指导您完成初始设置。这能确保在生成开始前，您拥有一个正确配置的环境。
 
 ![首次运行 generate 命令会触发设置向导](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
 
-系统将询问你一系列问题，以定义：
+系统将询问您一系列问题以定义：
 
 - 文档生成规则和风格
 - 目标受众
 - 主要语言和翻译语言
 - 源代码和输出路径
 
-![回答问题以配置文档风格、语言和源路径](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
+![回答问题以配置您的文档风格、语言和源路径](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
 
 配置完成后，DocSmith 将继续进行文档生成。
 
-![DocSmith 分析你的代码、规划结构并生成每个文档](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
+![DocSmith 分析您的代码，规划结构，并生成每个文档](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
 
-成功完成后，新创建的文档将位于你指定的输出目录中。
+成功完成后，您新创建的文档将在您指定的输出目录中可用。
 
-![完成后，你将在指定的输出目录中找到新文档](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
+![完成后，您将在指定的输出目录中找到新文档](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
 
 ## 生成过程
 
-`generate` 命令遵循一个自动化的工作流程。该过程可直观地表示如下：
+`generate` 命令遵循自动化工作流程。该过程可按如下方式可视化：
 
 ```d2
 direction: down
@@ -84,18 +84,18 @@ save_docs -> end
 
 ## 命令选项
 
-虽然默认的 `generate` 命令足以满足大多数使用场景，但你可以使用几个选项来控制生成过程。这些选项在重新生成内容或优化文档结构时非常有用。
+虽然默认的 `generate` 命令足以满足大多数用例，但您可以使用几个选项来控制生成过程。这些选项对于重新生成内容或优化文档结构非常有用。
 
-| 选项                | 描述                                                                                                                             | 示例                                                                 |
-|---------------------|----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
-| `--forceRegenerate` | 删除所有现有文档并从头开始重新生成。在对源代码或配置进行重大更改后使用此选项。                                                     | `aigne doc generate --forceRegenerate`                                 |
-| `--feedback`        | 提供高层反馈以优化整体文档结构，例如添加、删除或重组章节。                                                                       | `aigne doc generate --feedback "Add an API Reference section"`         |
-| `--model`           | 指定 AIGNE Hub 中的特定大型语言模型用于内容生成，允许你切换模型。                                                                  | `aigne doc generate --model claude:claude-3-5-sonnet`                |
+| 选项 | 描述 | 示例 |
+|---------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
+| `--forceRegenerate` | 删除所有现有文档并从头开始重新生成。在对源代码或配置进行重大更改后使用此选项。 | `aigne doc generate --forceRegenerate` |
+| `--feedback` | 提供高层反馈以优化整体文档结构，例如添加、删除或重组部分。 | `aigne doc generate --feedback "添加一个 API 参考部分"` |
+| `--model` | 指定一个来自 AIGNE Hub 的特定大型语言模型用于内容生成，允许您在不同模型之间切换。 | `aigne doc generate --model claude:claude-3-5-sonnet` |
 
 ## 接下来做什么？
 
-既然你已经生成了初始文档，你的项目将继续演进。为使文档与代码保持同步，你需要更新它们。请继续阅读下一部分，了解如何进行有针对性的更改和重新生成特定文件。
+既然您已经生成了初始文档，您的项目将继续发展。为了使文档与代码保持同步，您需要更新它们。请继续下一部分，学习如何进行有针对性的更改并重新生成特定文件。
 
 <x-card data-title="更新和优化" data-icon="lucide:file-edit" data-href="/features/update-and-refine">
-  了解当代码变更时如何更新文档，或使用反馈进行特定改进。
+  学习当您的代码发生变化时如何更新文档，或使用反馈进行特定改进。
 </x-card>

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

@@ -0,0 +1,107 @@
+# ドキュメントを公開する
+
+ドキュメントを生成した後、`aigne doc publish`コマンドはコンテンツをDiscuss Kitプラットフォームにアップロードし、オンラインでアクセスできるようにします。このガイドでは、公式プラットフォームまたは自己ホスト型のウェブサイトにドキュメントを公開する方法について説明します。
+
+## 公開プロセス
+
+`aigne doc publish`コマンドは対話的なプロセスを開始します。新しい宛先に初めて公開する場合、認証プロセスが案内されます。その後の公開では、保存された認証情報が使用されます。
+
+```d2 公開フロー icon=lucide:upload-cloud
+direction: down
+shape: sequence_diagram
+
+ユーザー: { shape: c4-person }
+CLI: { label: "AIGNE CLI" }
+ブラウザ: { label: "ブラウザ" }
+プラットフォーム: { label: "Discuss Kit プラットフォーム" }
+
+ユーザー -> CLI: "aigne doc publish"
+
+alt: "初回公開または設定がない場合" {
+  CLI -> ユーザー: "プラットフォームを選択\n(公式 / 自己ホスト型)"
+  ユーザー -> CLI: "選択を提供"
+  CLI -> ブラウザ: "認証URLを開く"
+  ユーザー -> ブラウザ: "ログインして承認"
+  ブラウザ -> プラットフォーム: "認証情報を送信"
+  プラットフォーム -> CLI: "アクセストークンを返す"
+  CLI -> CLI: "今後の使用のためにトークンを保存"
+}
+
+CLI -> プラットフォーム: "ドキュメントとメディアファイルをアップロード"
+プラットフォーム -> CLI: "成功応答"
+CLI -> ユーザー: "✅ 公開成功！"
+
+```
+
+## 公開オプション
+
+ドキュメントをホストするための主なオプションは2つあります：
+
+<x-cards data-columns="2">
+  <x-card data-title="公式プラットフォーム" data-icon="lucide:globe">
+    AIGNEが提供する無料の公開ホスティングプラットフォームである[docsmith.aigne.io](https://docsmith.aigne.io/app/)に公開します。これはオープンソースプロジェクトやドキュメントを迅速に共有するのに良い選択肢です。
+  </x-card>
+  <x-card data-title="独自のウェブサイト" data-icon="lucide:server">
+    アクセスとブランディングを完全に制御するために、独自のDiscuss Kitインスタンスに公開します。これは内部またはプライベートなドキュメントに適しています。[Blocklet Store](https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu)からDiscuss Kitインスタンスを入手できます。
+  </x-card>
+</x-cards>
+
+## ステップバイステップガイド
+
+初めてドキュメントを公開するには、以下の手順に従ってください。
+
+### 1. 公開コマンドを実行する
+
+プロジェクトのルートディレクトリで、次のコマンドを実行します：
+
+```bash Terminal icon=lucide:terminal
+aigne doc publish
+```
+
+### 2. プラットフォームを選択する
+
+初めて公開する場合、宛先を選択するように求められます。ニーズに合ったオプションを選択してください。
+
+![公式プラットフォームまたは自己ホスト型インスタンスから選択](https://docsmith.aigne.io/image-bin/uploads/9fd929060b5abe13d03cf5eb7aea85aa.png)
+
+独自のウェブサイトを選択した場合、そのURLを入力するように求められます。
+
+### 3. アカウントを認証する
+
+新しいプラットフォームへの最初の接続では、ブラウザウィンドウが開き、ログインしてCLIを承認します。これはプラットフォームごとに一度だけのステップです。アクセストークンは将来の使用のためにローカルの`~/.aigne/doc-smith-connected.yaml`に保存されます。
+
+### 4. 確認
+
+アップロードが完了すると、ターミナルに成功メッセージが表示されます。
+
+```
+✅ ドキュメントが正常に公開されました！
+```
+
+## CI/CD環境での公開
+
+自動化されたワークフローの場合、引数と環境変数を提供して対話型プロンプトをバイパスできます。
+
+| 方法 | 名前 | 説明 |
+|---|---|---|
+| **引数** | `--appUrl` | Discuss KitインスタンスのURLを直接指定します。 |
+| **環境変数** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | アクセストークンを提供し、対話型ログインをスキップします。 |
+
+以下は、CI/CDパイプラインに適した非対話型の公開コマンドの例です：
+
+```bash CI/CD Example icon=lucide:workflow
+export DOC_DISCUSS_KIT_ACCESS_TOKEN="your_access_token_here"
+aigne doc publish --appUrl https://docs.mycompany.com
+```
+
+## トラブルシューティング
+
+公開中に問題が発生した場合は、これらの一般的な問題を確認してください：
+
+- **接続エラー**: 自己ホスト型インスタンスに提供されたURLが正しくないか、サーバーに到達できない可能性があります。URLとネットワーク接続を確認してください。
+
+- **無効なウェブサイトURL**: URLはArcBlockプラットフォーム上に構築された有効なウェブサイトを指している必要があります。CLIは`The provided URL is not a valid website on ArcBlock platform`のようなエラーを表示します。ドキュメントをホストするには、まず[ストアからDiscuss Kitインスタンスを取得](https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu)することから始めることができます。
+
+- **必須コンポーネントの欠落**: 宛先のウェブサイトにはDiscuss Kitコンポーネントがインストールされている必要があります。欠落している場合、CLIは`This website does not have required components for publishing`のようなエラーを返します。[Discuss Kitのドキュメント](https://www.arcblock.io/docs/web3-kit/en/discuss-kit)を参照して、必要なコンポーネントを追加してください。
+
+コマンドとオプションの完全なリストについては、[CLIコマンドリファレンス](./cli-reference.md)を参照してください。