@aigne/doc-smith 0.8.2 → 0.8.4

package/docs/features.zh.md

@@ -1,56 +1,52 @@
----
-labels: ["Reference"]
----
-
 # 核心功能
 
-AIGNE DocSmith 提供了一套全面的工具来管理您的文档生命周期，从初始创建到全球分发。它通过几个简单的命令简化了该流程，并利用 AI 自动化复杂的任务。
-
-典型的工作流程遵循一个逻辑顺序，让您可以生成、优化、翻译并最终发布您的文档。
+AIGNE DocSmith 提供了一系列命令来管理您的文档生命周期，从初始创建到全球分发。该过程被组织成一个标准工作流：生成、优化、翻译和发布您的文档。
 
 ```d2
-direction: right
+direction: down
 
-"生成文档": {
-  shape: step
-  description: "从源代码自动创建"
+Generate: {
+  label: "1. 生成\naigne doc generate"
+  shape: rectangle
+  description: "从您的源代码创建一整套文档。"
 }
 
-"更新与优化": {
-  shape: step
-  description: "与代码变更同步并应用反馈"
+Refine: {
+  label: "2. 更新与优化\naigne doc update"
+  shape: rectangle
+  description: "保持文档与代码同步，并应用有针对性的反馈。"
 }
 
-"翻译": {
-  shape: step
-  description: "支持 12 种以上语言，触及全球受众"
+Translate: {
+  label: "3. 翻译\naigne doc translate"
+  shape: rectangle
+  description: "将内容本地化为多种语言，以面向全球受众。"
 }
 
-"发布": {
-  shape: step
-  description: "将文档分享到公共或私有平台"
+Publish: {
+  label: "4. 发布\naigne doc publish"
+  shape: rectangle
+  description: "将您的文档部署到公共或私有平台。"
 }
 
-"生成文档" -> "更新与优化" -> "翻译" -> "发布" {
-  style.animated: true
-}
+Generate -> Refine -> Translate -> Publish
 ```
 
-在以下部分探索 DocSmith 的主要功能：
+在以下各节中探索 DocSmith 的主要功能：
 
 <x-cards data-columns="2">
   <x-card data-title="生成文档" data-icon="lucide:file-plus-2" data-href="/features/generate-documentation">
-    通过单个命令，直接从源代码自动创建一套完整、结构良好的文档。
+    使用单个命令从您的源代码创建一整套文档。
   </x-card>
   <x-card data-title="更新与优化" data-icon="lucide:edit" data-href="/features/update-and-refine">
-    保持文档与代码变更同步，或根据特定反馈重新生成特定部分以提高质量。
+    保持您的文档与代码更改同步，或根据有针对性的反馈重新生成特定文档。
   </x-card>
   <x-card data-title="翻译文档" data-icon="lucide:languages" data-href="/features/translate-documentation">
-    轻松将您的内容翻译成超过 12 种语言，使您的项目能够触及全球受众。
+    将您的内容翻译成多种支持的语言，使您的项目能够面向全球受众。
   </x-card>
   <x-card data-title="发布您的文档" data-icon="lucide:send" data-href="/features/publish-your-docs">
-    通过一个交互式命令，将您生成的文档发布到 DocSmith 官方平台或您自己托管的实例上。
+    将您生成的文档发布到官方 DocSmith 平台或您自己的自托管实例。
   </x-card>
 </x-cards>
 
-这些核心功能协同工作，共同打造无缝的文档工作流。要详细了解所有可用命令及其选项，请参阅 [CLI 命令参考](./cli-reference.md)。
+这些功能为文档管理提供了一个结构化的工作流。要获取所有可用命令及其选项的详细列表，请参阅 [CLI 命令参考](./cli-reference.md)。

package/docs/getting-started.md

@@ -1,74 +1,123 @@
----
-labels: ["Reference"]
----
-
 # Getting Started
 
-This guide will walk you through installing AIGNE DocSmith, configuring your first project, and generating a complete set of documentation in just a few minutes. The process is designed to be straightforward, with a single command to get you started.
+This guide provides a step-by-step walkthrough to install AIGNE DocSmith, configure a project, and generate a complete set of documentation from your source code.
+
+## Step 1: Prerequisites
+
+Before you begin, ensure you have Node.js and its package manager, npm, installed on your system. DocSmith is a command-line tool that runs on the Node.js environment.
+
+### Installing Node.js
+
+Here are brief instructions for installing Node.js on various operating systems.
+
+**Windows**
+1.  Download the installer from the official [Node.js website](https://nodejs.org/).
+2.  Run the `.msi` installer and follow the steps in the installation wizard.
 
-## Prerequisites
+**macOS**
 
-Before you begin, ensure you have the following installed on your system:
+The recommended method is using [Homebrew](https://brew.sh/):
 
-- [Node.js](https://nodejs.org/)
-- [pnpm](https://pnpm.io/)
+```bash Terminal icon=lucide:apple
+# Install Homebrew if you don't have it
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
 
-## Step 1: Install AIGNE CLI
+# Install Node.js
+brew install node
+```
+
+Alternatively, you can download the `.pkg` installer from the [Node.js website](https://nodejs.org/).
+
+**Linux**
+
+For Ubuntu/Debian-based systems:
+
+```bash Terminal icon=lucide:laptop
+sudo apt update
+curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
+sudo apt-get install -y nodejs
+```
 
-DocSmith is available through the AIGNE Command Line Interface (CLI). Install the latest version globally using npm:
+For CentOS/RHEL/Fedora systems:
 
-```bash
+```bash Terminal icon=lucide:laptop
+curl -fsSL https://rpm.nodesource.com/setup_lts.x | sudo bash -
+sudo yum install nodejs
+```
+
+### Verification
+
+After installation, verify that Node.js and npm are available by running these commands in your terminal:
+
+```bash Terminal
+node --version
+npm --version
+```
+
+## Step 2: Install AIGNE CLI
+
+The DocSmith tool is included within the AIGNE Command Line Interface (CLI). Install the latest version of the AIGNE CLI globally using npm:
+
+```bash Terminal icon=logos:npm
 npm i -g @aigne/cli
 ```
 
-Once the installation is complete, verify that it was successful by checking the help command for the documentation tool:
+After the installation is complete, verify it by running the help command for the documentation tool:
 
-```bash
+```bash Terminal
 aigne doc -h
 ```
 
-This command should display a list of available `doc` commands and their options.
+This command will display the help menu for DocSmith, confirming it is ready for use.
 
-## Step 2: Generate Your Documentation
+## Step 3: Generate Your Documentation
 
-With the AIGNE CLI installed, you can generate your documentation with a single command. Navigate to your project's root directory and run:
+With the CLI installed, you can generate your documents with a single command. Navigate to your project's root directory in your terminal and run:
 
-```bash
+```bash Terminal icon=lucide:sparkles
 aigne doc generate
 ```
 
-### Smart Auto-Configuration
-
-If this is your first time running DocSmith in the project, it will automatically detect that no configuration exists and launch an interactive setup wizard to guide you.
+### Automatic Configuration
 
-![Running the generate command triggers the smart initialization wizard](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
+When you run this command for the first time in a project, DocSmith detects that no configuration exists and automatically launches an interactive setup wizard.
 
-## Step 3: Configure Your Project
+![Running the generate command initiates the setup wizard](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
 
-The interactive wizard will ask a series of questions to tailor the documentation to your specific needs. You will be prompted to define:
+You will be prompted with a series of questions to define the documentation's characteristics, including:
 
-- The primary purpose and style of the documentation.
-- Your target audience and their technical knowledge level.
+- The primary purpose and style.
+- The intended target audience.
 - The primary language and any additional languages for translation.
 - The source code paths for the AI to analyze.
-- The output directory where the documents will be saved.
+- The output directory for the generated documents.
 
-![Answer a series of questions to complete your project setup](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
+![Answer the prompts to complete the project setup](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
 
-## Step 4: Review Your New Docs
+Once the configuration is complete, DocSmith will proceed to analyze your source code, plan the document structure, and generate the content.
 
-After you complete the configuration, DocSmith will begin the generation process. It analyzes your code, plans a logical document structure, and writes the content for each section.
+![DocSmith planning the structure and generating documents](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
 
-![DocSmith plans the document structure and generates content](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
+## Step 4: Review Your Output
 
-Once finished, you'll see a success message in your terminal. Your new documentation is now ready in the output directory you specified (e.g., `.aigne/doc-smith/docs`).
+After the generation process is finished, a confirmation message will be displayed in your terminal.
 
-![A success message confirms your documentation is ready](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
+![Successful documentation generation message](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
 
-## What's Next?
+Your new documentation is now available in the output directory you specified during the setup process. The default location is `.aigne/doc-smith/docs`.
 
-You've successfully installed DocSmith and generated your first set of documents. Now you're ready to explore its capabilities in more detail.
+## What's Next?
 
-<x-card data-title="Explore Core Features" data-icon="lucide:compass" data-href="/features" data-cta="Learn More">
-  Dive deeper into the main commands and capabilities of DocSmith, from updating documents to publishing them online.
-</x-card>
+Now that you have generated your first set of documents, you can explore other features:
+
+<x-cards>
+  <x-card data-title="Core Features" data-icon="lucide:box" data-href="/features">
+    Explore the main commands and capabilities, from updating documents to publishing them online.
+  </x-card>
+  <x-card data-title="Configuration Guide" data-icon="lucide:settings" data-href="/configuration">
+    Learn how to fine-tune your documentation's style, audience, and languages by editing the config.yaml file.
+  </x-card>
+  <x-card data-title="CLI Command Reference" data-icon="lucide:terminal" data-href="/cli-reference">
+    Get a complete reference for all available `aigne doc` commands and their options.
+  </x-card>
+</x-cards>

package/docs/getting-started.zh.md

@@ -1,74 +1,123 @@
----
-labels: ["Reference"]
----
+# 入门指南
 
-# 快速入门
+本指南将引导您逐步完成 AIGNE DocSmith 的安装、项目配置，并从源代码生成一套完整的文档。
 
-本指南将引导你完成 AIGNE DocSmith 的安装、首个项目的配置，并在短短几分钟内生成一套完整的文档。整个过程设计得非常简单，只需一个命令即可开始。
+## 第 1 步：准备工作
 
-## 前提条件
+在开始之前，请确保您的系统中已安装 Node.js 及其包管理器 npm。DocSmith 是一个在 Node.js 环境下运行的命令行工具。
 
-在开始之前，请确保你的系统上已安装以下软件：
+### 安装 Node.js
 
-- [Node.js](https://nodejs.org/)
-- [pnpm](https://pnpm.io/)
+以下是在各种操作系统上安装 Node.js 的简要说明。
 
-## 第 1 步：安装 AIGNE CLI
+**Windows**
+1.  从 [Node.js 官网](https://nodejs.org/) 下载安装程序。
+2.  运行 `.msi` 安装程序，并按照安装向导的步骤进行操作。
 
-DocSmith 通过 AIGNE 命令行界面 (CLI) 提供。使用 npm 全局安装最新版本：
+**macOS**
 
-```bash
+推荐使用 [Homebrew](https://brew.sh/) 进行安装：
+
+```bash Terminal icon=lucide:apple
+# Install Homebrew if you don't have it
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+
+# Install Node.js
+brew install node
+```
+
+或者，您也可以从 [Node.js 网站](https://nodejs.org/) 下载 `.pkg` 安装程序。
+
+**Linux**
+
+对于基于 Ubuntu/Debian 的系统：
+
+```bash Terminal icon=lucide:laptop
+sudo apt update
+curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
+sudo apt-get install -y nodejs
+```
+
+对于基于 CentOS/RHEL/Fedora 的系统：
+
+```bash Terminal icon=lucide:laptop
+curl -fsSL https://rpm.nodesource.com/setup_lts.x | sudo bash -
+sudo yum install nodejs
+```
+
+### 验证
+
+安装完成后，在终端中运行以下命令，验证 Node.js 和 npm 是否可用：
+
+```bash Terminal
+node --version
+npm --version
+```
+
+## 第 2 步：安装 AIGNE CLI
+
+DocSmith 工具包含在 AIGNE 命令行界面 (CLI) 中。使用 npm 全局安装最新版本的 AIGNE CLI：
+
+```bash Terminal icon=logos:npm
 npm i -g @aigne/cli
 ```
 
-安装完成后，通过检查文档工具的帮助命令来验证是否安装成功：
+安装完成后，运行文档工具的帮助命令进行验证：
 
-```bash
+```bash Terminal
 aigne doc -h
 ```
 
-该命令应显示可用的 `doc` 命令及其选项列表。
+该命令将显示 DocSmith 的帮助菜单，确认其已准备就绪。
 
-## 第 2 步：生成文档
+## 第 3 步：生成您的文档
 
-安装 AIGNE CLI 后，你只需一个命令即可生成文档。进入项目根目录并运行：
+安装 CLI 后，您只需一个命令即可生成文档。在终端中导航到您项目的根目录并运行：
 
-```bash
+```bash Terminal icon=lucide:sparkles
 aigne doc generate
 ```
 
-### 智能自动配置
+### 自动配置
 
-如果你是首次在项目中运行 DocSmith，它会自动检测到尚无配置，并启动一个交互式设置向导来引导你完成配置。
+当您首次在项目中运行此命令时，DocSmith 会检测到尚无配置，并自动启动一个交互式设置向导。
 
-![运行 generate 命令会触发智能初始化向导](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
+![运行 generate 命令会启动设置向导](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
 
-## 第 3 步：配置项目
+系统将提示您回答一系列问题，以定义文档的特性，包括：
 
-交互式向导将提出一系列问题，以根据你的具体需求定制文档。系统将提示你定义以下内容：
-
-- 文档的主要用途和风格。
-- 目标受众及其技术知识水平。
-- 主要语言以及任何需要翻译的其他语言。
+- 主要目的和风格。
+- 目标受众。
+- 主要语言及其他需要翻译的语言。
 - 供 AI 分析的源代码路径。
-- 用于保存文档的输出目录。
+- 生成文档的输出目录。
+
+![回答提示以完成项目设置](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
 
-![回答一系列问题以完成项目设置](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
+配置完成后，DocSmith 将开始分析您的源代码、规划文档结构并生成内容。
 
-## 第 4 步：查看新文档
+![DocSmith 正在规划结构并生成文档](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
 
-完成配置后，DocSmith 将开始生成过程。它会分析你的代码，规划出逻辑清晰的文档结构，并为每个部分撰写内容。
+## 第 4 步：查看您的输出
 
-![DocSmith 规划文档结构并生成内容](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
+生成过程结束后，您的终端将显示一条确认消息。
 
-完成后，你将在终端中看到一条成功消息。你的新文档现已在你指定的输出目录（例如 `.aigne/doc-smith/docs`）中准备就绪。
+![文档生成成功消息](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
 
-![成功消息确认你的文档已准备就绪](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
+您的新文档现已位于您在设置过程中指定的输出目录中。默认位置是 `.aigne/doc-smith/docs`。
 
-## 接下来呢？
+## 下一步？
 
-你已成功安装 DocSmith 并生成了第一套文档。现在，你可以开始更详细地探索其功能了。
+既然您已经生成了第一套文档，可以探索其他功能：
 
-<x-card data-title="探索核心功能" data-icon="lucide:compass" data-href="/features" data-cta="了解更多">
-  深入了解 DocSmith 的主要命令和功能，从更新文档到在线发布。
-</x-card>
+<x-cards>
+  <x-card data-title="核心功能" data-icon="lucide:box" data-href="/features">
+    探索主要命令和功能，从更新文档到在线发布。
+  </x-card>
+  <x-card data-title="配置指南" data-icon="lucide:settings" data-href="/configuration">
+    了解如何通过编辑 config.yaml 文件来微调文档的风格、受众和语言。
+  </x-card>
+  <x-card data-title="CLI 命令参考" data-icon="lucide:terminal" data-href="/cli-reference">
+    获取所有可用 `aigne doc` 命令及其选项的完整参考。
+  </x-card>
+</x-cards>

package/docs/overview.md

@@ -1,48 +1,30 @@
----
-labels: ["Reference"]
----
-
 # Overview
 
-AIGNE DocSmith is an AI-driven documentation generation tool built on the [AIGNE Framework](https://www.aigne.io/en/framework). It automates the creation of detailed, structured, and multi-language documentation directly from your source code, streamlining the entire workflow from planning to publishing.
+AIGNE DocSmith is an AI-driven tool that generates documentation directly from your source code. Built on the [AIGNE Framework](https://www.aigne.io/en/framework), it automates the creation of structured, multi-language documents. This process reduces the manual effort of writing and maintaining documentation, ensuring it stays synchronized with the codebase.
 
 ## Part of the AIGNE Ecosystem
 
-DocSmith is a key component of the [AIGNE](https://www.aigne.io) ecosystem, a comprehensive platform for developing AI applications. It integrates seamlessly with other AIGNE components, leveraging the platform's AI capabilities and infrastructure.
+DocSmith is a key component of the [AIGNE](https://www.aigne.io) ecosystem, a platform for developing AI applications. It integrates with other AIGNE components to use the platform's AI capabilities and infrastructure.
 
 The following diagram illustrates how DocSmith fits within the AIGNE architecture:
 
 ![AIGNE Ecosystem Architecture](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
 
-## Key Features
-
-DocSmith offers a range of features designed to make documentation effortless and intelligent.
-
-<x-cards data-columns="3">
-  <x-card data-title="Automated Structure Planning" data-icon="lucide:file-cog">
-    Intelligently analyzes your codebase to generate a comprehensive and logical document structure.
-  </x-card>
-  <x-card data-title="AI-Powered Content Generation" data-icon="lucide:bot">
-    Populates the document structure with detailed, high-quality content derived directly from your source.
-  </x-card>
-  <x-card data-title="Multi-Language Support" data-icon="lucide:languages">
-    Seamlessly translates documentation into over 12 languages to reach a global audience.
-  </x-card>
-  <x-card data-title="AIGNE Hub Integration" data-icon="lucide:plug-zap">
-    Use various LLMs through AIGNE Hub without needing your own API keys, and switch between models easily.
-  </x-card>
-  <x-card data-title="Discuss Kit Publishing" data-icon="lucide:send">
-    Publish your generated documentation to the official platform or your own self-hosted Discuss Kit instance.
-  </x-card>
-  <x-card data-title="Intelligent Updates" data-icon="lucide:git-pull-request-arrow">
-    Automatically detects source code changes to update documentation or lets you refine specific documents with targeted feedback.
-  </x-card>
-</x-cards>
-
-## Get Started
-
-Whether you're a developer looking to eliminate the manual effort of documentation or a project manager aiming for consistent, high-quality user guides, DocSmith provides the tools to get it done efficiently.
+## Core Features
+
+DocSmith provides a set of features to automate and simplify the documentation process:
+
+*   **Structure Planning:** Analyzes a codebase to generate a logical document structure.
+*   **Content Generation:** Populates the planned document structure with content generated from the source code.
+*   **Multi-Language Support:** Translates documentation into 12 languages, including English, Chinese, Japanese, and Spanish.
+*   **AIGNE Hub Integration:** Uses [AIGNE Hub](https://www.aigne.io/en/hub) as an LLM provider, allowing model switching without managing individual API keys.
+*   **Document Publishing:** Publishes documentation to the official platform at [docsmith.aigne.io](https://docsmith.aigne.io/app/) or to a user's own [Discuss Kit](https://www.arcblock.io/docs/web3-kit/en/discuss-kit) instance.
+*   **Iterative Updates:** Detects source code changes to update documentation and supports targeted regeneration of specific documents based on user feedback.
+
+## Next Steps
+
+To begin using DocSmith, proceed to the installation and configuration guide.
 
 <x-card data-title="Next: Getting Started" data-href="/getting-started" data-icon="lucide:arrow-right-circle" data-cta="Start the guide">
-  Follow our step-by-step guide to install the tool, configure your first project, and generate documentation in minutes.
+  Follow the step-by-step guide to install the tool, configure your first project, and generate documentation.
 </x-card>

package/docs/overview.zh.md

@@ -1,48 +1,30 @@
----
-labels: ["Reference"]
----
-
 # 概述
 
-AIGNE DocSmith 是一款基于 [AIGNE 框架](https://www.aigne.io/en/framework) 构建的 AI 驱动的文档生成工具。它可以直接根据您的源代码自动创建详细、结构化且支持多语言的文档，从而简化从规划到发布的整个工作流程。
+AIGNE DocSmith 是一款 AI 驱动的工具，可直接从源代码生成文档。它基于 [AIGNE 框架](https://www.aigne.io/en/framework)，可自动创建结构化的多语言文档。此过程减少了编写和维护文档的人工工作量，确保文档与代码库保持同步。
 
 ## AIGNE 生态系统的一部分
 
-DocSmith 是 [AIGNE](https://www.aigne.io) 生态系统的重要组成部分，该生态系统是一个用于开发 AI 应用的综合平台。它能与其他 AIGNE 组件无缝集成，充分利用平台的 AI 能力和基础设施。
+DocSmith 是 [AIGNE](https://www.aigne.io) 生态系统的一个关键组件，该生态系统是一个用于开发 AI 应用的平台。它与其他 AIGNE 组件集成，以使用该平台的 AI 功能和基础设施。
 
-下图说明了 DocSmith 在 AIGNE 架构中的位置：
+下图说明了 DocSmith 如何融入 AIGNE 架构：
 
 ![AIGNE 生态系统架构](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
 
-## 主要特性
-
-DocSmith 提供了一系列旨在使文档编写工作变得轻松智能的功能。
-
-<x-cards data-columns="3">
-  <x-card data-title="自动化结构规划" data-icon="lucide:file-cog">
-    智能分析您的代码库，生成全面且逻辑清晰的文档结构。
-  </x-card>
-  <x-card data-title="AI 驱动的内容生成" data-icon="lucide:bot">
-    直接从您的源代码中提取详细、高质量的内容，并填充到文档结构中。
-  </x-card>
-  <x-card data-title="多语言支持" data-icon="lucide:languages">
-    将文档无缝翻译成 12 种以上的语言，以触达全球受众。
-  </x-card>
-  <x-card data-title="AIGNE Hub 集成" data-icon="lucide:plug-zap">
-    通过 AIGNE Hub 使用各种大语言模型，无需您自己的 API 密钥，并可轻松切换模型。
-  </x-card>
-  <x-card data-title="Discuss Kit 发布" data-icon="lucide:send">
-    将生成的文档发布到官方平台或您自己托管的 Discuss Kit 实例。
-  </x-card>
-  <x-card data-title="智能更新" data-icon="lucide:git-pull-request-arrow">
-    自动检测源代码变更以更新文档，或允许您通过有针对性的反馈来优化特定文档。
-  </x-card>
-</x-cards>
-
-## 开始入门
-
-无论您是希望摆脱手动编写文档工作的开发者，还是追求一致、高质量用户指南的项目经理，DocSmith 都能为您提供高效完成这些任务的工具。
+## 核心功能
+
+DocSmith 提供了一系列功能来自动化和简化文档流程：
+
+*   **结构规划：** 分析代码库以生成逻辑化的文档结构。
+*   **内容生成：** 使用从源代码生成的内容填充规划好的文档结构。
+*   **多语言支持：** 将文档翻译成 12 种语言，包括英语、中文、日语和西班牙语。
+*   **AIGNE Hub 集成：** 使用 [AIGNE Hub](https://www.aigne.io/en/hub) 作为 LLM 提供商，无需管理独立的 API 密钥即可切换模型。
+*   **文档发布：** 将文档发布到官方平台 [docsmith.aigne.io](https://docsmith.aigne.io/app/) 或用户自己的 [Discuss Kit](https://www.arcblock.io/docs/web3-kit/en/discuss-kit) 实例。
+*   **迭代更新：** 检测源代码变更以更新文档，并支持根据用户反馈对特定文档进行定向重新生成。
+
+## 后续步骤
+
+要开始使用 DocSmith，请继续阅读安装和配置指南。
 
 <x-card data-title="下一步：开始入门" data-href="/getting-started" data-icon="lucide:arrow-right-circle" data-cta="开始阅读指南">
-  遵循我们的分步指南，安装工具、配置您的第一个项目，并在几分钟内生成文档。
+  按照分步指南安装工具、配置你的第一个项目并生成文档。
 </x-card>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.8.2",
+  "version": "0.8.4",
   "description": "",
   "publishConfig": {
     "access": "public"
@@ -12,14 +12,15 @@
   "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
   "license": "MIT",
   "dependencies": {
-    "@aigne/aigne-hub": "^0.8.6",
-    "@aigne/anthropic": "^0.11.17",
-    "@aigne/cli": "^1.43.1",
-    "@aigne/core": "^1.57.5",
-    "@aigne/gemini": "^0.11.6",
-    "@aigne/openai": "^0.13.7",
-    "@aigne/publish-docs": "^0.9.1",
+    "@aigne/aigne-hub": "^0.8.10",
+    "@aigne/anthropic": "^0.12.3",
+    "@aigne/cli": "^1.44.3",
+    "@aigne/core": "^1.58.3",
+    "@aigne/gemini": "^0.12.3",
+    "@aigne/openai": "^0.14.3",
+    "@aigne/publish-docs": "^0.9.6",
     "chalk": "^5.5.0",
+    "debug": "^4.4.1",
     "dompurify": "^3.2.6",
     "fs-extra": "^11.3.1",
     "glob": "^11.0.3",

package/prompts/content-detail-generator.md

@@ -106,6 +106,7 @@ parentId: {{parentId}}
 
 {% include "document/custom-components.md" %}
 
+{% include "document/custom-code-block.md" %}
 </rules>
 
 {% include "document/detail-example.md" %}