@aigne/doc-smith 0.8.11-beta.4 → 0.8.11-beta.6

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

@@ -1,58 +1,81 @@
 # Publish Your Docs
 
-After generating your documentation, the `aigne doc publish` command uploads your content to a Discuss Kit platform, making it accessible online. This guide explains how to publish your documentation to either the official platform or your own self-hosted website.
+After generating your documentation, the `aigne doc publish` command uploads your files and makes them accessible via a shareable link. This guide provides a step-by-step process for publishing your documentation to either the official AIGNE platform or a self-hosted instance.
 
 ## The Publishing Process
 
-The `aigne doc publish` command initiates an interactive process. The first time you publish to a new destination, it will guide you through authentication. Subsequent publishes will use saved credentials.
+The `aigne doc publish` command starts an interactive workflow. The first time you publish to a destination, the CLI will open a browser to guide you through a one-time authentication process. For subsequent publishes, it will use the saved credentials stored in `~/.aigne/doc-smith-connected.yaml`.
 
-```d2 The Publishing Flow icon=lucide:upload-cloud
-direction: down
+```d2 The Publishing Workflow icon=lucide:upload-cloud
 shape: sequence_diagram
 
-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"
+User: {
+  label: "Developer / CI-CD"
+  shape: c4-person
 }
 
-CLI -> Platform: "Uploads docs & media files"
-Platform -> CLI: "Success response"
-CLI -> User: "✅ Published Successfully!"
+CLI: {
+  label: "CLI\n(aigne doc publish)"
+}
+
+Local-Config: {
+  label: "Local Config\n(~/.aigne/...)"
+  shape: cylinder
+}
 
+Browser
+
+Platform: {
+  label: "Platform\n(Official or Self-Hosted)"
+}
+
+User -> CLI: "Run command"
+
+alt "Interactive Mode" {
+  CLI -> Local-Config: "Check for credentials"
+  opt "Credentials not found (First time)" {
+    CLI -> User: "Prompt to choose platform"
+    User -> CLI: "Platform selected"
+    CLI -> Browser: "Open auth URL"
+    User -> Browser: "Login & Authorize"
+    Browser -> Platform: "Request token"
+    Platform -> Browser: "Return token"
+    Browser -> CLI: "Send token to CLI"
+    CLI -> Local-Config: "Save credentials"
+  }
+  CLI -> Platform: "Upload documentation"
+  Platform -> CLI: "Confirm success"
+  CLI -> User: "Display success message"
+}
+
+alt "CI/CD Mode" {
+  note over CLI: "Reads token from ENV VAR"
+  CLI -> Platform: "Upload documentation"
+  Platform -> CLI: "Confirm success"
+  CLI -> User: "Return success status"
+}
 ```
 
 ## Publishing Options
 
-You have two main options for hosting your documentation:
+You can choose between two primary destinations for hosting your documentation:
 
 <x-cards data-columns="2">
   <x-card data-title="Official Platform" data-icon="lucide:globe">
-    Publish to [docsmith.aigne.io](https://docsmith.aigne.io/app/), a free, public hosting platform provided by AIGNE. This is a good option for open-source projects or to quickly share your docs.
+    Publish to docsmith.aigne.io, a service operated by AIGNE. This is a straightforward option for open-source projects or for quickly sharing your documentation publicly.
   </x-card>
-  <x-card data-title="Your Own Website" data-icon="lucide:server">
-    Publish to your own Discuss Kit instance for full control over access and branding. This is suitable for internal or private documentation. You can get a Discuss Kit instance from the [Blocklet Store](https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu).
+  <x-card data-title="Self-Hosted Instance" data-icon="lucide:server">
+    Publish to your own Discuss Kit instance for complete control over branding, access, and data privacy. This is the recommended option for internal or private documentation. You can run your own Discuss Kit instance by following the instructions available at the official documentation.
   </x-card>
 </x-cards>
 
 ## Step-by-Step Guide
 
-Follow these steps to publish your documentation for the first time.
+Follow these steps to publish your documentation.
 
 ### 1. Run the Publish Command
 
-In your project's root directory, run the following command:
+Navigate to your project's root directory and execute the following command:
 
 ```bash Terminal icon=lucide:terminal
 aigne doc publish
@@ -60,19 +83,19 @@ aigne doc publish
 
 ### 2. Choose Your Platform
 
-If this is your first time publishing, you will be prompted to select a destination. Choose the option that fits your needs.
+If this is your first time publishing, you will be prompted to select a destination. Choose the option that fits your requirements.
 
-![Choose between the official platform or a self-hosted instance](https://docsmith.aigne.io/image-bin/uploads/9fd929060b5abe13d03cf5eb7aea85aa.png)
+![Choose between the official platform or a self-hosted instance](https://docsmith.aigne.io/image-bin/uploads/9fd929060b5abe13d0_3cf5eb7aea85aa.png)
 
-If you select your own website, you will be asked to enter its URL.
+If you select a self-hosted instance, you will be asked to enter its URL.
 
 ### 3. Authenticate Your Account
 
-For the first connection to a new platform, a browser window will open for you to log in and authorize the CLI. This is a one-time step per platform; your access token is saved locally in `~/.aigne/doc-smith-connected.yaml` for future use.
+For the initial connection, a browser window will open automatically for you to log in and authorize the CLI. This step is only required once per platform. The access token is saved locally for future use.
 
 ### 4. Confirmation
 
-Once the upload is complete, a success message will appear in your terminal.
+Once the upload is complete, a success message will appear in your terminal, confirming that the documentation is live.
 
 ```
 ✅ Documentation Published Successfully!
@@ -80,14 +103,14 @@ Once the upload is complete, a success message will appear in your terminal.
 
 ## Publishing in CI/CD Environments
 
-For automated workflows, you can provide arguments and environment variables to bypass the interactive prompts.
+To use the publish command in automated workflows like CI/CD pipelines, you can bypass the interactive prompts by providing the necessary information through arguments and environment variables.
 
 | Method | Name | Description |
 |---|---|---|
-| **Argument** | `--appUrl` | Specifies the URL of your Discuss Kit instance directly. |
-| **Env Var** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | Provides the access token, skipping the interactive login. |
+| **Argument** | `--appUrl` | Specifies the URL of your Discuss Kit instance. |
+| **Env Var** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | Provides the access token to skip the interactive login process. |
 
-Here is an example of a non-interactive publish command suitable for a CI/CD pipeline:
+Here is an example of a non-interactive publish command suitable for a CI/CD script:
 
 ```bash CI/CD Example icon=lucide:workflow
 export DOC_DISCUSS_KIT_ACCESS_TOKEN="your_access_token_here"
@@ -96,12 +119,12 @@ aigne doc publish --appUrl https://docs.mycompany.com
 
 ## Troubleshooting
 
-If you encounter an issue during publishing, check for these common problems:
+If you encounter an issue during the publishing process, it may be due to one of the following common problems.
 
-- **Connection Error**: The provided URL for your self-hosted instance might be incorrect, or the server may be unreachable. Verify the URL and your network connection.
+- **Connection Error**: The CLI may return an error message like `Unable to connect to: <URL>`. This can be caused by network issues, a server that is temporarily unavailable, or an incorrect URL. Verify that the URL is correct and the server is reachable.
 
-- **Invalid Website URL**: The URL must point to a valid website built on the ArcBlock platform. The CLI will show an error like `The provided URL is not a valid website on ArcBlock platform`. To host your documentation, you can start by getting a [Discuss Kit instance from the store](https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu).
+- **Invalid Website URL**: The command may fail with the message `The provided URL is not a valid website on ArcBlock platform`. The destination URL must be a website built on the ArcBlock platform. To host your documentation, you can run your own instance of Discuss Kit.
 
-- **Missing Required Components**: The destination website must have the Discuss Kit component installed. If it is missing, the CLI will return an error like `This website does not have required components for publishing`. Please refer to the [Discuss Kit documentation](https://www.arcblock.io/docs/web3-kit/en/discuss-kit) to add the necessary component.
+- **Missing Required Components**: An error stating `This website does not have required components for publishing` indicates that the destination website does not have the Discuss Kit component installed. Please refer to the Discuss Kit documentation to add the necessary component to your site.
 
-For a complete list of commands and options, refer to the [CLI Command Reference](./cli-reference.md).
+For a complete list of commands and options, see the [CLI Command Reference](./cli-reference.md).

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

@@ -1,58 +1,81 @@
-# 發布您的文件
+# 發佈您的文件
 
-產生文件後，`aigne doc publish` 指令會將您的內容上傳到 Discuss Kit 平台，使其可以在線上存取。本指南將說明如何將您的文件發布到官方平台或您自己託管的網站。
+產生您的文件後，`aigne doc publish` 指令會上傳您的檔案，並透過可分享的連結使其可供存取。本指南提供了將您的文件發佈到官方 AIGNE 平台或自行託管實例的逐步流程。
 
-## 發布流程
+## 發佈流程
 
-`aigne doc publish` 指令會啟動一個互動式流程。當您首次發布到新目標時，它會引導您進行身份驗證。後續的發布將使用已儲存的憑證。
+`aigne doc publish` 指令會啟動一個互動式工作流程。當您第一次發佈到某個目的地時，CLI 會開啟瀏覽器引導您完成一次性的身份驗證過程。對於後續的發佈，它將使用儲存在 `~/.aigne/doc-smith-connected.yaml` 中的已儲存憑證。
 
-```d2 發布流程 icon=lucide:upload-cloud
-direction: down
+```d2 The Publishing Workflow icon=lucide:upload-cloud
 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: "儲存權杖以供未來使用"
+User: {
+  label: "開發者 / CI-CD"
+  shape: c4-person
 }
 
-CLI -> 平台: "上傳文件與媒體檔案"
-平台 -> CLI: "成功回應"
-CLI -> 使用者: "✅ 發布成功！"
+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">
-    發布到 [docsmith.aigne.io](https://docsmith.aigne.io/app/)，這是由 AIGNE 提供的免費公開託管平台。對於開源專案或需要快速分享文件的情況，這是一個不錯的選擇。
+    發佈到由 AIGNE 營運的服務 docsmith.aigne.io。對於開源專案或希望快速公開分享文件的使用者來說，這是一個直接的選項。
   </x-card>
-  <x-card data-title="您自己的網站" data-icon="lucide:server">
-    發布到您自己的 Discuss Kit 實例，以完全控制存取權限和品牌。這適用於內部或私密文件。您可以從 [Blocklet 商店](https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu) 取得 Discuss Kit 實例。
+  <x-card data-title="自行託管實例" data-icon="lucide:server">
+    發佈到您自己的 Discuss Kit 實例，以完全控制品牌、存取權限和資料隱私。這是內部或私有文件的推薦選項。您可以按照官方文件中的說明來執行您自己的 Discuss Kit 實例。
   </x-card>
 </x-cards>
 
-## 步驟指南
+## 逐步指南
 
-請按照以下步驟首次發布您的文件。
+請按照以下步驟發佈您的文件。
 
-### 1. 執行發布指令
+### 1. 執行發佈指令
 
-在您專案的根目錄中，執行以下指令：
+導覽至您專案的根目錄並執行以下指令：
 
 ```bash Terminal icon=lucide:terminal
 aigne doc publish
@@ -60,48 +83,48 @@ aigne doc publish
 
 ### 2. 選擇您的平台
 
-如果這是您第一次發布，系統會提示您選擇一個目標。請選擇符合您需求的選項。
+如果這是您第一次發佈，系統會提示您選擇一個目的地。請選擇符合您需求的選項。
 
-![在官方平台或自行託管的實例之間選擇](https://docsmith.aigne.io/image-bin/uploads/9fd929060b5abe13d03cf5eb7aea85aa.png)
+![在官方平台或自行託管實例之間進行選擇](https://docsmith.aigne.io/image-bin/uploads/9fd929060b5abe13d0_3cf5eb7aea85aa.png)
 
-如果您選擇自己的網站，系統會要求您輸入其 URL。
+如果您選擇自行託管的實例，系統會要求您輸入其 URL。
 
 ### 3. 驗證您的帳戶
 
-首次連接到新平台時，會開啟一個瀏覽器視窗讓您登入並授權 CLI。每個平台只需執行此步驟一次；您的存取權杖會儲存在本地的 `~/.aigne/doc-smith-connected.yaml` 檔案中，以供未來使用。
+初次連線時，瀏覽器視窗會自動開啟，讓您登入並授權給 CLI。此步驟每個平台僅需執行一次。存取權杖會儲存在本機以供未來使用。
 
 ### 4. 確認
 
-上傳完成後，您的終端機中會顯示一條成功訊息。
+上傳完成後，您的終端機中會出現一條成功訊息，確認文件已上線。
 
 ```
-✅ 文件發布成功！
+✅ Documentation Published Successfully!
 ```
 
-## 在 CI/CD 環境中發布
+## 在 CI/CD 環境中發佈
 
-對於自動化工作流程，您可以提供參數和環境變數來繞過互動式提示。
+若要在 CI/CD 管線等自動化工作流程中使用發佈指令，您可以透過參數和環境變數提供必要的資訊，以繞過互動式提示。
 
 | 方法 | 名稱 | 說明 |
 |---|---|---|
-| **參數** | `--appUrl` | 直接指定您的 Discuss Kit 實例的 URL。 |
-| **環境變數** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | 提供存取權杖，跳過互動式登入。 |
+| **參數** | `--appUrl` | 指定您的 Discuss Kit 實例的 URL。 |
+| **環境變數** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | 提供存取權杖以跳過互動式登入過程。 |
 
-以下是一個適合 CI/CD 管線的非互動式發布指令範例：
+以下是一個適用於 CI/CD 指令碼的非互動式發佈指令範例：
 
-```bash CI/CD 範例 icon=lucide:workflow
+```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 和您的網路連線。
+- **連線錯誤**：CLI 可能會返回類似 `Unable to connect to: <URL>` 的錯誤訊息。這可能是由網路問題、伺服器暫時無法使用或 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)。
+- **無效的網站 URL**：指令可能會失敗並顯示訊息 `The provided URL is not a valid website on ArcBlock platform`。目標 URL 必須是建立在 ArcBlock 平台上的網站。若要託管您的文件，您可以執行自己的 Discuss Kit 實例。
 
-- **缺少必要元件**：目標網站必須安裝 Discuss Kit 元件。如果缺少該元件，CLI 將返回類似 `This website does not have required components for publishing` 的錯誤。請參考 [Discuss Kit 文件](https://www.arcblock.io/docs/web3-kit/en/discuss-kit) 來新增必要的元件。
+- **缺少必要元件**：一個錯誤訊息，內容為 `This website does not have required components for publishing` 表示目標網站未安裝 Discuss Kit 元件。請參閱 Discuss Kit 文件，將必要的元件新增到您的網站。
 
-有關指令和選項的完整清單，請參考 [CLI 指令參考](./cli-reference.md)。
+有關指令和選項的完整列表，請參閱 [CLI 指令參考](./cli-reference.md)。

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

@@ -1,58 +1,81 @@
 # 发布您的文档
 
-生成文档后，`aigne doc publish` 命令会将您的内容上传到 Discuss Kit 平台，使其可以在线访问。本指南将说明如何将您的文档发布到官方平台或您自己的自托管网站。
+生成文档后，`aigne doc publish` 命令会上传您的文件，并通过一个可共享的链接使其可访问。本指南提供了将文档发布到 AIGNE 官方平台或自托管实例的分步过程。
 
-## 发布流程
+## 发布过程
 
-`aigne doc publish` 命令会启动一个交互式流程。首次发布到新目的地时，它将引导您完成身份验证。后续的发布将使用已保存的凭据。
+`aigne doc publish` 命令会启动一个交互式工作流程。当您首次发布到某个目标时，CLI 将打开一个浏览器来引导您完成一次性身份验证过程。对于后续的发布，它将使用保存在 `~/.aigne/doc-smith-connected.yaml` 中的凭证。
 
-```d2 发布流程 icon=lucide:upload-cloud
-direction: down
+```d2 The Publishing Workflow icon=lucide:upload-cloud
 shape: sequence_diagram
 
-User: { shape: c4-person }
-CLI: { label: "AIGNE CLI" }
-Browser: { label: "浏览器" }
-Platform: { label: "Discuss Kit 平台" }
-
-User -> CLI: "aigne doc publish"
-
-alt: "首次发布或缺少配置" {
-  CLI -> User: "选择平台\n(官方 / 自托管)"
-  User -> CLI: "提供选择"
-  CLI -> Browser: "打开认证 URL"
-  User -> Browser: "登录并授权"
-  Browser -> Platform: "发送凭据"
-  Platform -> CLI: "返回访问令牌"
-  CLI -> CLI: "保存令牌以备将来使用"
+User: {
+  label: "开发者 / CI-CD"
+  shape: c4-person
 }
 
-CLI -> Platform: "上传文档和媒体文件"
-Platform -> CLI: "成功响应"
-CLI -> User: "✅ 发布成功！"
+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">
-    发布到 [docsmith.aigne.io](https://docsmith.aigne.io/app/)，这是 AIGNE 提供的一个免费的公共托管平台。对于开源项目或希望快速分享文档的用户来说，这是一个不错的选择。
+    发布到 docsmith.aigne.io，这是由 AIGNE 运营的服务。对于开源项目或希望快速公开分享文档的用户来说，这是一个直接的选择。
   </x-card>
-  <x-card data-title="您自己的网站" data-icon="lucide:server">
-    发布到您自己的 Discuss Kit 实例，以完全控制访问和品牌。这适用于内部或私有文档。您可以从 [Blocklet 商店](https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu) 获取 Discuss Kit 实例。
+  <x-card data-title="自托管实例" data-icon="lucide:server">
+    发布到您自己的 Discuss Kit 实例，以完全控制品牌、访问权限和数据隐私。这是内部或私有文档的推荐选项。您可以按照官方文档中的说明运行自己的 Discuss Kit 实例。
   </x-card>
 </x-cards>
 
 ## 分步指南
 
-请按照以下步骤首次发布您的文档。
+请按照以下步骤发布您的文档。
 
 ### 1. 运行发布命令
 
-在您的项目根目录中，运行以下命令：
+导航到您项目的根目录并执行以下命令：
 
 ```bash Terminal icon=lucide:terminal
 aigne doc publish
@@ -60,19 +83,19 @@ aigne doc publish
 
 ### 2. 选择您的平台
 
-如果这是您第一次发布，系统将提示您选择一个目的地。请选择适合您需求的选项。
+如果这是您第一次发布，系统会提示您选择一个目标。请选择符合您要求的选项。
 
-![在官方平台或自托管实例之间选择](https://docsmith.aigne.io/image-bin/uploads/9fd929060b5abe13d03cf5eb7aea85aa.png)
+![在官方平台或自托管实例之间选择](https://docsmith.aigne.io/image-bin/uploads/9fd929060b5abe13d0_3cf5eb7aea85aa.png)
 
-如果您选择自己的网站，系统将要求您输入其 URL。
+如果您选择自托管实例，系统会要求您输入其 URL。
 
 ### 3. 验证您的账户
 
-首次连接到新平台时，将打开一个浏览器窗口供您登录并授权 CLI。每个平台只需执行一次此步骤；您的访问令牌将保存在本地的 `~/.aigne/doc-smith-connected.yaml` 文件中，以备将来使用。
+对于初次连接，浏览器窗口将自动打开，以便您登录并授权 CLI。此步骤每个平台只需执行一次。访问令牌会保存在本地以备将来使用。
 
 ### 4. 确认
 
-上传完成后，您的终端将显示一条成功消息。
+上传完成后，您的终端将显示一条成功消息，确认文档已上线。
 
 ```
 ✅ 文档发布成功！
@@ -80,28 +103,28 @@ aigne doc publish
 
 ## 在 CI/CD 环境中发布
 
-对于自动化工作流，您可以通过提供参数和环境变量来绕过交互式提示。
+要在 CI/CD 流水线等自动化工作流程中使用发布命令，您可以通过参数和环境变量提供必要信息来绕过交互式提示。
 
 | 方法 | 名称 | 描述 |
 |---|---|---|
-| **参数** | `--appUrl` | 直接指定您的 Discuss Kit 实例的 URL。 |
-| **环境变量** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | 提供访问令牌，跳过交互式登录。 |
+| **参数** | `--appUrl` | 指定您的 Discuss Kit 实例的 URL。 |
+| **环境变量** | `DOC_DISCUSS_KIT_ACCESS_TOKEN` | 提供访问令牌以跳过交互式登录过程。 |
 
-以下是一个适用于 CI/CD 流程的非交互式发布命令示例：
+以下是一个适用于 CI/CD 脚本的非交互式发布命令示例：
 
-```bash CI/CD Example icon=lucide:workflow
+```bash CI/CD 示例 icon=lucide:workflow
 export DOC_DISCUSS_KIT_ACCESS_TOKEN="your_access_token_here"
 aigne doc publish --appUrl https://docs.mycompany.com
 ```
 
-## 问题排查
+## 故障排除
 
-如果在发布过程中遇到问题，请检查以下常见问题：
+如果您在发布过程中遇到问题，可能是由以下常见问题之一引起的。
 
-- **连接错误**：您提供的自托管实例的 URL 可能不正确，或者服务器可能无法访问。请验证 URL 和您的网络连接。
+- **连接错误**：CLI 可能会返回类似 `Unable to connect to: <URL>` 的错误消息。这可能是由网络问题、服务器暂时不可用或 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)开始。
+- **无效的网站 URL**：命令可能会失败并显示消息 `The provided URL is not a valid website on ArcBlock platform`。目标 URL 必须是基于 ArcBlock 平台构建的网站。要托管您的文档，您可以运行自己的 Discuss Kit 实例。
 
-- **缺少必需组件**：目标网站必须安装 Discuss Kit 组件。如果缺少该组件，CLI 将返回类似 `This website does not have required components for publishing` 的错误。请参阅 [Discuss Kit 文档](https://www.arcblock.io/docs/web3-kit/en/discuss-kit)以添加必要的组件。
+- **缺少必需组件**：错误消息 `This website does not have required components for publishing` 表示目标网站没有安装 Discuss Kit 组件。请参阅 Discuss Kit 文档，将必要的组件添加到您的站点。
 
 有关命令和选项的完整列表，请参阅 [CLI 命令参考](./cli-reference.md)。