@aigne/doc-smith 0.8.3 → 0.8.5

package/docs/features-generate-documentation.md

@@ -1,12 +1,8 @@
----
-labels: ["Reference"]
----
-
 # Generate Documentation
 
-The `aigne doc generate` command is the core function of DocSmith, designed to transform your source code into a comprehensive and well-structured documentation suite with a single command.
+The `aigne doc generate` command is the core function of DocSmith, designed to transform your source code into a structured documentation suite with a single command.
 
-This process involves analyzing your codebase, planning a logical document structure, and then generating detailed content for each section. It's the primary way to create your documentation from scratch.
+This process analyzes your codebase, plans a logical document structure, and then generates content for each section. It's the primary way to create your documentation from scratch.
 
 ## Your First Generation
 
@@ -16,9 +12,9 @@ To begin, navigate to your project's root directory and run the following comman
 aigne doc generate
 ```
 
-### Smart Auto-Configuration
+### Automatic Configuration
 
-If you're running this command for the first time in a project, DocSmith will intelligently detect that no configuration exists. It will automatically launch an interactive setup wizard to guide you through the initial setup. This ensures you have a properly configured environment before generation begins.
+If you're running this command for the first time in a project, DocSmith will detect that no configuration exists. It will automatically launch an interactive setup wizard to guide you through the initial setup. This ensures you have a properly configured environment before generation begins.
 
 ![Running the generate command for the first time triggers the setup wizard](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
 
@@ -40,43 +36,67 @@ Upon successful completion, your newly created documentation will be available i
 
 ## The Generation Process
 
-The `generate` command follows a clear, automated workflow to ensure consistent and high-quality results. The process can be visualized as follows:
+The `generate` command follows an automated workflow to ensure consistent results. The process can be visualized as follows:
 
 ```d2
 direction: down
 
-start: "Start"
-run_cmd: "Run `aigne doc generate`"
-check_config: "Configuration exists?" {
+start: "Start" {
+  shape: oval
+}
+
+run_cmd: "Run `aigne doc generate`" {
+  shape: rectangle
+}
+
+check_config: "Configuration Found?" {
   shape: diamond
 }
-interactive_setup: "Interactive Setup Wizard"
-plan_structure: "Analyze Code & Plan Structure"
-gen_content: "Generate Document Content"
-save_docs: "Save Documents to Output Directory"
-end: "End"
 
-start -> run_cmd -> check_config
+interactive_setup: "Launch Interactive Setup Wizard" {
+  shape: rectangle
+}
+
+plan_structure: "1. Analyze Code & Plan Structure" {
+  shape: rectangle
+}
+
+gen_content: "2. Generate Document Content" {
+  shape: rectangle
+}
+
+save_docs: "3. Save Documents" {
+  shape: rectangle
+}
+
+end: "End" {
+  shape: oval
+}
+
+start -> run_cmd
+run_cmd -> check_config
 check_config -> interactive_setup: "No"
 interactive_setup -> plan_structure
 check_config -> plan_structure: "Yes"
-plan_structure -> gen_content -> save_docs -> end
+plan_structure -> gen_content
+gen_content -> save_docs
+save_docs -> end
 ```
 
-## Fine-Tuning Your Generation
+## Command Options
 
-While the default `generate` command is sufficient for most use cases, you can use several options to control the generation process. These are particularly useful for regenerating content or refining the document structure.
+While the default `generate` command is sufficient for most use cases, you can use several options to control the generation process. These are useful for regenerating content or refining the document structure.
 
 | Option              | Description                                                                                                                              | Example                                                              |
 |---------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
 | `--forceRegenerate` | Deletes all existing documents and regenerates them from scratch. Use this after making significant changes to your source code or configuration. | `aigne doc generate --forceRegenerate`                                 |
 | `--feedback`        | Provides high-level feedback to refine the overall document structure plan, such as adding, removing, or reorganizing sections.           | `aigne doc generate --feedback "Add an API Reference section"`         |
-| `--model`           | Specifies a particular Large Language Model from AIGNE Hub to use for content generation, allowing you to switch between models easily.       | `aigne doc generate --model claude:claude-3-5-sonnet`                |
+| `--model`           | Specifies a particular Large Language Model from AIGNE Hub to use for content generation, allowing you to switch between models.       | `aigne doc generate --model claude:claude-3-5-sonnet`                |
 
 ## What's Next?
 
 Now that you have generated your initial documentation, your project will continue to evolve. To keep your documents synchronized with your code, you will need to update them. Proceed to the next section to learn how to make targeted changes and regenerate specific files.
 
 <x-card data-title="Update and Refine" data-icon="lucide:file-edit" data-href="/features/update-and-refine">
-  Discover how to intelligently update documents when your code changes or make specific improvements using feedback.
-</x-card>.
+  Discover how to update documents when your code changes or make specific improvements using feedback.
+</x-card>

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

@@ -1,28 +1,24 @@
----
-labels: ["Reference"]
----
-
 # 生成文档
 
-`aigne doc generate` 命令是 DocSmith 的核心功能，旨在通过一个命令将您的源代码转换为内容全面、结构清晰的文档套件。
+`aigne doc generate` 命令是 DocSmith 的核心功能，旨在通过一个命令将您的源代码转换为结构化的文档套件。
 
-该过程包括分析您的代码库、规划合理的文档结构，然后为每个部分生成详细内容。这是从零开始创建文档的主要方式。
+该过程会分析您的代码库，规划逻辑文档结构，然后为每个部分生成内容。这是从零开始创建文档的主要方式。
 
 ## 首次生成
 
-首先，请进入您项目的根目录并运行以下命令：
+首先，请导航至您项目的根目录并运行以下命令：
 
 ```bash
 aigne doc generate
 ```
 
-### 智能自动配置
+### 自动配置
 
-如果您首次在项目中运行此命令，DocSmith 将智能地检测到尚无配置。它会自动启动一个交互式设置向导，引导您完成初始设置。这能确保在生成开始前，您已拥有一个正确配置的环境。
+如果您首次在项目中运行此命令，DocSmith 会检测到尚无配置。它将自动启动交互式设置向导，引导您完成初始设置。这可以确保您在生成开始前拥有一个正确配置的环境。
 
 ![首次运行 generate 命令会触发设置向导](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
 
-系统将询问您一系列问题以定义：
+系统会询问您一系列问题，用于定义：
 - 文档生成规则和风格
 - 目标受众
 - 主要语言和翻译语言
@@ -32,7 +28,7 @@ aigne doc generate
 
 配置完成后，DocSmith 会继续进行文档生成。
 
-![DocSmith 分析您的代码、规划结构并生成每个文档](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
+![DocSmith 会分析您的代码、规划结构并生成每个文档](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
 
 成功完成后，您新创建的文档将位于您指定的输出目录中。
 
@@ -40,43 +36,67 @@ aigne doc generate
 
 ## 生成过程
 
-`generate` 命令遵循一个清晰、自动化的工作流程，以确保结果的一致性和高质量。该过程的可视化流程如下：
+`generate` 命令遵循自动化工作流以确保结果的一致性。该过程可按如下方式可视化：
 
 ```d2
 direction: down
 
-start: "开始"
-run_cmd: "运行 `aigne doc generate`"
-check_config: "配置是否存在？" {
+start: "开始" {
+  shape: oval
+}
+
+run_cmd: "运行 `aigne doc generate`" {
+  shape: rectangle
+}
+
+check_config: "找到配置？" {
   shape: diamond
 }
-interactive_setup: "交互式设置向导"
-plan_structure: "分析代码并规划结构"
-gen_content: "生成文档内容"
-save_docs: "将文档保存到输出目录"
-end: "结束"
 
-start -> run_cmd -> check_config
+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 -> save_docs -> end
+plan_structure -> gen_content
+gen_content -> save_docs
+save_docs -> end
 ```
 
-## 微调生成过程
+## 命令选项
 
-虽然默认的 `generate` 命令足以满足大多数使用场景，但您也可以使用一些选项来控制生成过程。这些选项在重新生成内容或优化文档结构时尤其有用。
+虽然默认的 `generate` 命令足以满足大多数用例，但您可以使用多个选项来控制生成过程。这些选项对于重新生成内容或优化文档结构非常有用。
 
-| 选项              | 描述                                                                                                                             | 示例                                                              | 
+| 选项                | 描述                                                                                                                                     | 示例                                                                 |
 |---------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
-| `--forceRegenerate` | 删除所有现有文档并从头开始重新生成。在对源代码或配置进行重大更改后使用此选项。                                                           | `aigne doc generate --forceRegenerate`                                 |
-| `--feedback`        | 提供高级反馈以优化整体文档结构规划，例如添加、删除或重组章节。                                                                           | `aigne doc generate --feedback "添加一个 API 参考部分"`         |
-| `--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>.
+  了解当代码发生变化时如何更新文档，或使用反馈进行特定改进。
+</x-card>

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

@@ -1,50 +1,50 @@
----
-labels: ["Reference"]
----
-
 # Publish Your Docs
 
-Once your documentation is generated, the next step is to make it accessible online. AIGNE DocSmith simplifies this process with the `aigne doc publish` command, which uploads your content to a Discuss Kit platform, making it instantly available to your audience.
+Once your documentation is generated, the next step is to make it accessible online. AIGNE DocSmith simplifies this process with the `aigne doc publish` command, which uploads your content to a Discuss Kit platform, making it available to your audience.
 
-This guide covers how to publish your documentation, whether you're using the free official platform or your own self-hosted instance.
+This guide covers how to publish your documentation, whether you are using the official platform or your own website.
 
 ## The Publishing Process
 
 The `aigne doc publish` command initiates an interactive process that guides you through the necessary steps. The diagram below shows the typical workflow for publishing your documentation for the first time.
 
 ```d2
+direction: down
 shape: sequence_diagram
 
-User; CLI; "Discuss Kit Platform"
-
-User -> CLI: runs `aigne doc publish`
-
-alt "First time or not configured"
-  CLI -> User: "Prompt: Select platform"
-  User -> CLI: "Selects Official or Self-Hosted"
-  CLI -> User: "Opens browser for authentication"
-  User -> "Discuss Kit Platform": "Logs in and authorizes"
-  "Discuss Kit Platform" -> CLI: "Provides access token"
-  CLI -> CLI: "Saves token for future use"
-end
-
-CLI -> "Discuss Kit Platform": "Uploads documentation & media"
-"Discuss Kit Platform" -> CLI: "Confirms success"
-CLI -> User: "✅ Documentation Published Successfully!"
+User: { shape: c4-person }
+CLI: { label: "AIGNE CLI" }
+Browser: { label: "Browser" }
+Platform: { label: "Discuss Kit Platform" }
+
+User -> CLI: "aigne doc publish"
+
+alt: "First-time publish or missing config" {
+  CLI -> User: "Select Platform\n(Official / Self-Hosted)"
+  User -> CLI: "Provides selection"
+  CLI -> Browser: "Opens authentication URL"
+  User -> Browser: "Logs in & authorizes"
+  Browser -> Platform: "Sends credentials"
+  Platform -> CLI: "Returns Access Token"
+  CLI -> CLI: "Saves Token for future use"
+}
+
+CLI -> Platform: "Uploads docs & media files"
+Platform -> CLI: "Success response"
+CLI -> User: "✅ Published Successfully!"
 ```
 
 ## Publishing Options
 
 You have two primary options for hosting your documentation, catering to different needs for visibility and control.
 
-<x-cards data-columns="2">
-  <x-card data-title="Official Platform" data-icon="lucide:globe">
-    Publish to docsmith.aigne.io, the official hosting platform. This option is free, ideal for open-source projects, and makes your documentation publicly accessible.
-  </x-card>
-  <x-card data-title="Self-Hosted Platform" data-icon="lucide:server">
-    Publish to your own private instance of Discuss Kit. This gives you full control over who can access your documentation, making it suitable for internal or private projects.
-  </x-card>
-</x-cards>
+### Official Platform
+
+Publish to [docsmith.aigne.io](https://docsmith.aigne.io), the official hosting platform. This option is free, makes your documentation publicly accessible, and is recommended for open-source projects.
+
+### Your Own Website
+
+Publish to your own website by running a Discuss Kit instance. This gives you full control over who can access your documentation, making it suitable for internal or private projects. You can get started with running your own Discuss Kit from the [official store](https://www.arcblock.io/store/z8iZhf67n368m2k5a9fXvCL778jAnf3e5n2b).
 
 ## Step-by-Step Guide
 
@@ -60,11 +60,11 @@ aigne doc publish
 
 ### 2. Choose Your Platform
 
-If you haven't configured a publishing destination before, you will be prompted to choose between the official platform and a self-hosted one. Select the option that best suits your needs.
+If you have not configured a publishing destination before, you will be prompted to choose between the official platform and a self-hosted one. Select the option that best suits your needs.
 
 ![Choose between the official platform or a self-hosted instance](https://docsmith.aigne.io/image-bin/uploads/9fd929060b5abe13d03cf5eb7aea85aa.png)
 
-If you select the self-hosted option, you will be asked to enter the URL for your Discuss Kit instance.
+If you select your own website, you will be asked to enter the URL for your Discuss Kit instance.
 
 ### 3. Authenticate Your Account
 
@@ -82,17 +82,18 @@ Once the upload is complete, you will see a success message in your terminal, an
 
 For automated workflows, you can bypass the interactive prompts by using command-line arguments or environment variables.
 
-| Method | Name | Description | Example |
-|---|---|---|---|
-| **Argument** | `--appUrl` | Specifies the URL of your self-hosted Discuss Kit instance directly. | `aigne doc publish --appUrl https://docs.mycompany.com` |
-| **Env Var** | `DOC_DISCUSS_KIT_URL` | Sets the target platform URL, overriding any other configuration. | `export DOC_DISCUSS_KIT_URL=...` |
-| **Env Var** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | Provides the access token directly, skipping the interactive login. | `export DOC_DISCUSS_KIT_ACCESS_TOKEN=...` |
+| Method     | Name                           | Description                                                                              | Example                                                     |
+| ---------- | ------------------------------ | ---------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
+| **Argument** | `--appUrl`                     | Specifies the URL of your Discuss Kit instance directly.                                 | `aigne doc publish --appUrl https://docs.mycompany.com`       |
+| **Env Var**  | `DOC_DISCUSS_KIT_URL`          | Sets the target platform URL, overriding any other configuration.                        | `export DOC_DISCUSS_KIT_URL=...`                              |
+| **Env Var**  | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | Provides the access token directly, skipping the interactive login.                      | `export DOC_DISCUSS_KIT_ACCESS_TOKEN=...`                     |
 
 ## Troubleshooting
 
 If you encounter issues during the publishing process, here are some common causes and their solutions:
 
--   **Invalid URL or Connection Error**: This often happens if the provided URL for a self-hosted instance is incorrect or the server is not reachable. Double-check the URL and your network connection.
--   **Missing Required Components**: The destination website must have the Discuss Kit component installed to host the documentation. If it's missing, the CLI will return an error with guidance on how to install it.
+-   **Connection Error**: This can happen if the provided URL for your own instance is incorrect or the server is not reachable. Check the URL and your network connection.
+-   **Invalid Website URL**: The provided URL is not a valid website on the ArcBlock platform. To host your documentation, you need a website running on this platform. You can start by visiting the [Discuss Kit Store](https://www.arcblock.io/store/z8iZhf67n368m2k5a9fXvCL778jAnf3e5n2b).
+-   **Missing Required Components**: The destination website must have the Discuss Kit component installed to host the documentation. If it is missing, the CLI will return an error with guidance on how to add the component. You can find instructions in the [Discuss Kit documentation](https://www.arcblock.io/docs/web3-kit/en/discuss-kit).
 
-For a complete list of commands and options, please refer to the [CLI Command Reference](./cli-reference.md).
+For a complete list of commands and options, refer to the [CLI Command Reference](./cli-reference.md).

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

@@ -1,50 +1,50 @@
----
-labels: ["Reference"]
----
+# 发布你的文档
 
-# 发布文档
+文档生成后，下一步是使其可以在线访问。AIGNE DocSmith 通过 `aigne doc publish` 命令简化了这一过程，该命令会将你的内容上传到 Discuss Kit 平台，供你的受众访问。
 
-文档生成后，下一步是将其发布到线上。AIGNE DocSmith 通过 `aigne doc publish` 命令简化了这一过程，该命令会将您的内容上传到 Discuss Kit 平台，使其即时对您的受众可用。
-
-本指南将介绍如何发布您的文档，无论您使用的是免费的官方平台还是自托管的实例。
+本指南将介绍如何发布文档，无论你是使用官方平台还是自己的网站。
 
 ## 发布流程
 
-`aigne doc publish` 命令会启动一个交互式流程，引导您完成必要的步骤。下图展示了首次发布文档的典型工作流程。
+`aigne doc publish` 命令会启动一个交互式流程，引导你完成必要的步骤。下图展示了首次发布文档的典型工作流程。
 
 ```d2
+direction: down
 shape: sequence_diagram
 
-用户; CLI; "Discuss Kit 平台"
+User: { shape: c4-person }
+CLI: { label: "AIGNE CLI" }
+Browser: { label: "Browser" }
+Platform: { label: "Discuss Kit Platform" }
+
+User -> CLI: "aigne doc publish"
+
+alt: "首次发布或缺少配置" {
+  CLI -> User: "选择平台\n（官方/自托管）"
+  User -> CLI: "提供选择"
+  CLI -> Browser: "打开认证 URL"
+  User -> Browser: "登录并授权"
+  Browser -> Platform: "发送凭证"
+  Platform -> CLI: "返回访问令牌"
+  CLI -> CLI: "保存令牌以备将来使用"
+}
+
+CLI -> Platform: "上传文档和媒体文件"
+Platform -> CLI: "成功响应"
+CLI -> User: "✅ 发布成功！"
+```
 
-用户 -> CLI: 运行 `aigne doc publish`
+## 发布选项
 
-alt "首次使用或未配置"
-  CLI -> 用户: "提示：选择平台"
-  用户 -> CLI: "选择官方或自托管"
-  CLI -> 用户: "打开浏览器进行身份验证"
-  用户 -> "Discuss Kit 平台": "登录并授权"
-  "Discuss Kit 平台" -> CLI: "提供访问令牌"
-  CLI -> CLI: "保存令牌供将来使用"
-end
+你有两种主要选项来托管文档，以满足对可见性和控制的不同需求。
 
-CLI -> "Discuss Kit 平台": "上传文档和媒体文件"
-"Discuss Kit 平台" -> CLI: "确认成功"
-CLI -> 用户: "✅ 文档发布成功！"
-```
+### 官方平台
 
-## 发布选项
+发布到官方托管平台 [docsmith.aigne.io](https://docsmith.aigne.io)。此选项免费，可使你的文档公开访问，推荐用于开源项目。
 
-您有两种主要选项来托管您的文档，以满足不同的可见性和控制需求。
+### 你自己的网站
 
-<x-cards data-columns="2">
-  <x-card data-title="官方平台" data-icon="lucide:globe">
-    发布到官方托管平台 docsmith.aigne.io。该选项免费，非常适合开源项目，并能让您的文档公开访问。
-  </x-card>
-  <x-card data-title="自托管平台" data-icon="lucide:server">
-    发布到您自己的 Discuss Kit 私有实例。这使您可以完全控制谁可以访问您的文档，适合内部或私有项目。
-  </x-card>
-</x-cards>
+通过运行 Discuss Kit 实例发布到你自己的网站。这使你可以完全控制谁能访问你的文档，适合内部或私有项目。你可以从[官方商店](https://www.arcblock.io/store/z8iZhf67n368m2k5a9fXvCL778jAnf3e5n2b)开始运行你自己的 Discuss Kit。
 
 ## 分步指南
 
@@ -52,27 +52,27 @@ CLI -> 用户: "✅ 文档发布成功！"
 
 ### 1. 运行发布命令
 
-在终端中，导航到您项目的根目录并运行以下命令：
+在终端中导航到项目根目录，并运行以下命令：
 
 ```bash
 aigne doc publish
 ```
 
-### 2. 选择您的平台
+### 2. 选择你的平台
 
-如果您之前没有配置过发布目标，系统将提示您在官方平台和自托管平台之间进行选择。请选择最适合您需求的选项。
+如果你之前没有配置过发布目的地，系统将提示你在官方平台和自托管平台之间进行选择。请选择最适合你需求的选项。
 
 ![在官方平台或自托管实例之间选择](https://docsmith.aigne.io/image-bin/uploads/9fd929060b5abe13d03cf5eb7aea85aa.png)
 
-如果您选择自托管选项，系统将要求您输入您的 Discuss Kit 实例的 URL。
+如果你选择自己的网站，系统将要求你输入 Discuss Kit 实例的 URL。
 
-### 3. 验证您的账户
+### 3. 认证你的账户
 
-首次连接到新平台时，DocSmith 会自动打开一个浏览器窗口，供您登录并授权 CLI。这是一个一次性步骤；您的访问令牌将被保存在本地，用于将来向该平台进行的所有发布。
+首次连接到新平台时，DocSmith 会自动打开浏览器窗口，以便你登录并授权 CLI。这是一个一次性步骤；你的访问令牌将保存在本地，用于将来对该平台的所有发布操作。
 
 ### 4. 确认
 
-上传完成后，您将在终端中看到一条成功消息，您的文档即已上线。
+上传完成后，你将在终端看到一条成功消息，你的文档即已上线。
 
 ```
 ✅ 文档发布成功！
@@ -80,19 +80,20 @@ aigne doc publish
 
 ## 在 CI/CD 环境中发布
 
-对于自动化工作流，您可以通过使用命令行参数或环境变量来绕过交互式提示。
+对于自动化工作流，你可以使用命令行参数或环境变量来绕过交互式提示。
 
-| 方法 | 名称 | 描述 | 示例 |
-|---|---|---|---|
-| **参数** | `--appUrl` | 直接指定您自托管的 Discuss Kit 实例的 URL。 | `aigne doc publish --appUrl https://docs.mycompany.com` |
-| **环境变量** | `DOC_DISCUSS_KIT_URL` | 设置目标平台 URL，覆盖任何其他配置。 | `export DOC_DISCUSS_KIT_URL=...` |
-| **环境变量** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | 直接提供访问令牌，跳过交互式登录。 | `export DOC_DISCUSS_KIT_ACCESS_TOKEN=...` |
+| Method     | Name                           | Description                                                                              | Example                                                     |
+| ---------- | ------------------------------ | ---------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
+| **Argument** | `--appUrl`                     | 直接指定你的 Discuss Kit 实例的 URL。                                 | `aigne doc publish --appUrl https://docs.mycompany.com`       |
+| **Env Var**  | `DOC_DISCUSS_KIT_URL`          | 设置目标平台 URL，覆盖任何其他配置。                        | `export DOC_DISCUSS_KIT_URL=...`                              |
+| **Env Var**  | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | 直接提供访问令牌，跳过交互式登录。                      | `export DOC_DISCUSS_KIT_ACCESS_TOKEN=...`                     |
 
 ## 故障排除
 
-如果您在发布过程中遇到问题，以下是一些常见原因及其解决方案：
+如果你在发布过程中遇到问题，以下是一些常见原因及其解决方案：
 
--   **无效的 URL 或连接错误**：这通常发生在为自托管实例提供的 URL 不正确或服务器无法访问时。请仔细检查 URL 和您的网络连接。
--   **缺少必需组件**：目标网站必须安装 Discuss Kit 组件才能托管文档。如果缺少该组件，CLI 将返回错误并提供安装指导。
+-   **连接错误**：如果提供的自有实例 URL 不正确或服务器无法访问，可能会发生此问题。请检查 URL 和你的网络连接。
+-   **无效的网站 URL**：提供的 URL 不是 ArcBlock 平台上的有效网站。要托管你的文档，你需要一个在该平台上运行的网站。你可以从访问 [Discuss Kit 商店](https://www.arcblock.io/store/z8iZhf67n368m2k5a9fXvCL778jAnf3e5n2b) 开始。
+-   **缺少必需组件**：目标网站必须安装 Discuss Kit 组件才能托管文档。如果缺少该组件，CLI 将返回错误并提供有关如何添加该组件的指导。你可以在 [Discuss Kit 文档](https://www.arcblock.io/docs/web3-kit/en/discuss-kit) 中找到相关说明。
 
-有关命令和选项的完整列表，请参阅 [CLI 命令参考](./cli-reference.md)。
+如需完整的命令和选项列表，请参阅 [CLI 命令参考](./cli-reference.md)。