@aigne/doc-smith 0.7.0 → 0.7.1

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

@@ -0,0 +1,83 @@
+---
+labels: ["Reference"]
+---
+
+# 翻译文档
+
+AIGNE DocSmith 可将您的文档自动翻译成 12 种以上的语言，帮助您触及全球受众。该功能简化了本地化流程，确保您的内容仅需一条命令即可触达全球用户。
+
+## 使用交互模式轻松翻译
+
+如需引导式体验，最简单的方式是直接运行 `translate` 命令，无需添加任何参数：
+
+```bash
+aigne doc translate
+```
+
+这将启动一个交互式向导，逐步引导您完成整个过程：
+
+1.  **选择待翻译文档：** 系统将列出您现有的所有文档。您只需选择想要翻译的文档即可。
+
+    ![选择要翻译的文档](https://docsmith.aigne.io/image-bin/uploads/e2cf5fa45aa856c406a444fb4665ed2d.png)
+
+2.  **选择目标语言：** 选择文档后，您可以从支持的语言列表中选择一个或多个目标语言。
+
+    ![选择要翻译成的语言](https://docsmith.aigne.io/image-bin/uploads/2e243a2488f2060a693fe0ac0c8fb5ad.png)
+
+3.  **确认并运行：** DocSmith 随后将处理翻译任务，为每种选定的语言生成相应的文件新版本。
+
+## 使用命令行标志进行高级控制
+
+对于自动化或更具体的任务，您可以使用命令行标志直接控制翻译过程。这非常适合集成到 CI/CD 流程中，也适合偏好使用命令行的资深用户。
+
+以下是可用的主要选项：
+
+| 参数 | 描述 |
+|---|---|
+| `--langs` | 指定一个或多个目标语言。此标志可以多次使用（例如，--langs zh --langs ja）。 |
+| `--docs` | 指定要翻译的文档的路径。此标志也可以多次使用。 |
+| `--feedback` | 向 AI 提供反馈，以提升未来翻译的质量（例如，--feedback "Use formal tone"）。 |
+| `--glossary` | 使用 Markdown 格式的术语表文件，以确保特定术语的翻译保持一致（例如，--glossary @path/to/glossary.md）。 |
+
+### 示例：翻译特定文档
+
+要将 `overview.md` 和 `examples.md` 翻译成中文和日文，您需要运行：
+
+```bash
+aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
+```
+
+### 示例：使用术语表和反馈
+
+为确保品牌名称和技术术语翻译准确，您可以提供一个术语表文件。您还可以提供反馈以优化翻译风格。
+
+```bash
+aigne doc translate --glossary @glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
+```
+
+## 支持的语言
+
+DocSmith 支持以下语言的自动翻译：
+
+| 语言 | 代码 |
+|---|---|
+| 英语 | 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.md

@@ -0,0 +1,86 @@
+---
+labels: ["Reference"]
+---
+
+# Update and Refine
+
+Keeping documentation synchronized with your evolving source code is crucial. AIGNE DocSmith provides powerful and flexible ways to keep your content up-to-date, whether through intelligent automatic updates or precise, feedback-driven refinements.
+
+This guide covers how to:
+- Automatically update documents when your code changes.
+- Manually regenerate specific documents with targeted feedback.
+- Optimize the overall documentation structure.
+
+---
+
+## Automatic Updates with Smart Detection
+
+When you run the `aigne doc generate` command, DocSmith doesn't blindly regenerate everything. It intelligently analyzes your codebase, detects changes since the last run, and only regenerates the documents that are affected. This efficient process saves time and reduces unnecessary LLM API calls.
+
+```bash
+# DocSmith will automatically detect changes and update only what's necessary
+aigne doc generate
+```
+
+![DocSmith intelligently detects changes and regenerates only the required documents.](https://docsmith.aigne.io/image-bin/uploads/21a76b2f65d14d16a49c13d800f1e2c1.png)
+
+### Forcing a Full Regeneration
+
+If you need to regenerate all documentation from scratch, ignoring the cache and previous state, use the `--forceRegenerate` flag. This is useful after significant configuration changes or when you want to ensure a completely fresh build.
+
+```bash
+# Regenerate all documentation from the ground up
+aigne doc generate --forceRegenerate
+```
+
+---
+
+## Refining Individual Documents with Feedback
+
+Sometimes, you need to improve a specific document without any corresponding code changes. The `aigne doc update` command is designed for this purpose, allowing you to provide targeted feedback to the AI for content refinement.
+
+You can use this command in two ways: interactively or directly via command-line arguments.
+
+### Interactive Mode
+
+For an easy, guided experience, simply run the command without any arguments. DocSmith will present you with an interactive menu to select which document you want to update. After you choose, you'll be prompted to enter your feedback.
+
+```bash
+# Start the interactive update process
+aigne doc update
+```
+
+![Interactively select the documents you wish to update.](https://docsmith.aigne.io/image-bin/uploads/75e9cf9823bb369c3d2b5a2e2da4ac06.png)
+
+### Direct Command-Line Updates
+
+For faster workflows or scripting, you can specify the document and feedback directly using flags. This allows for precise, non-interactive updates.
+
+```bash
+# Update a specific document with feedback
+aigne doc update --docs overview.md --feedback "Add a more comprehensive FAQ section at the end."
+```
+
+Key parameters for the `update` command:
+
+| Parameter | Description |
+|---|---|
+| `--docs` | The path to the document you want to update. You can use this flag multiple times for multiple documents. |
+| `--feedback` | The specific feedback or instructions for the AI to use when regenerating the content. |
+
+---
+
+## Optimizing the Overall Structure
+
+Beyond refining the content of individual documents, you can also refine the overall documentation structure. If you feel a section is missing, or the existing organization could be improved, you can provide feedback to the structure planning agent using the `generate` command.
+
+This command tells DocSmith to reconsider the entire document plan based on your new input.
+
+```bash
+# Regenerate the structure plan with specific feedback
+aigne doc generate --feedback "Remove the 'About' section and add a more detailed 'API Reference'."
+```
+
+This approach is best for high-level changes to the table of contents, rather than line-by-line content edits.
+
+With these tools, you can maintain accurate, high-quality documentation that evolves alongside your project. Once your content is refined, you may want to make it available to a global audience. Learn how in the [Translate Documentation](./features-translate-documentation.md) guide.

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

@@ -0,0 +1,86 @@
+---
+labels: ["Reference"]
+---
+
+# 更新与优化
+
+让文档与不断演进的源代码保持同步至关重要。AIGNE DocSmith 提供了强大而灵活的方式来保持内容更新，无论是通过智能自动更新，还是通过精确的、由反馈驱动的优化。
+
+本指南将介绍如何：
+- 在代码变更时自动更新文档。
+- 通过有针对性的反馈手动重新生成特定文档。
+- 优化整体文档结构。
+
+---
+
+## 智能检测与自动更新
+
+当您运行 `aigne doc generate` 命令时，DocSmith 不会盲目地重新生成所有内容。它会智能地分析您的代码库，检测自上次运行以来的变更，并仅重新生成受影响的文档。这个高效的流程可以节省时间，并减少不必要的 LLM API 调用。
+
+```bash
+# DocSmith 将自动检测变更并仅更新必要的部分
+aigne doc generate
+```
+
+![DocSmith 能够智能检测变更，并仅重新生成必要的文档。](https://docsmith.aigne.io/image-bin/uploads/21a76b2f65d14d16a49c13d800f1e2c1.png)
+
+### 强制完全重新生成
+
+如果您需要从头开始重新生成所有文档，忽略缓存和先前的状态，请使用 `--forceRegenerate` 标志。这在发生重大配置变更后，或当您希望确保完全重新构建时非常有用。
+
+```bash
+# 从头开始重新生成所有文档
+aigne doc generate --forceRegenerate
+```
+
+---
+
+## 通过反馈优化单个文档
+
+有时，您需要在没有任何相应代码变更的情况下改进特定文档。`aigne doc update` 命令正是为此设计的，它允许您向 AI 提供有针对性的反馈，以优化内容。
+
+您可以通过两种方式使用此命令：交互式方式或直接通过命令行参数。
+
+### 交互模式
+
+要获得简单的引导式体验，只需运行不带任何参数的命令即可。DocSmith 将为您呈现一个交互式菜单，供您选择要更新的文档。选择后，系统将提示您输入反馈。
+
+```bash
+# 启动交互式更新流程
+aigne doc update
+```
+
+![以交互方式选择您希望更新的文档。](https://docsmith.aigne.io/image-bin/uploads/75e9cf9823bb369c3d2b5a2e2da4ac06.png)
+
+### 直接通过命令行更新
+
+为了实现更快的工作流或脚本化操作，您可以使用标志直接指定文档和反馈。这允许进行精确的非交互式更新。
+
+```bash
+# 使用反馈更新特定文档
+aigne doc update --docs overview.md --feedback "在末尾添加一个更全面的常见问题解答部分。"
+```
+
+`update` 命令的关键参数：
+
+| Parameter | Description |
+|---|---|
+| `--docs` | 您想要更新的文档路径。您可以多次使用此标志来更新多个文档。 |
+| `--feedback` | 供 AI 在重新生成内容时使用的具体反馈或指令。 |
+
+---
+
+## 优化整体结构
+
+除了优化单个文档的内容，您还可以优化整体文档结构。如果您觉得某个部分缺失，或者现有组织结构可以改进，您可以使用 `generate` 命令向结构规划 Agent 提供反馈。
+
+此命令会告知 DocSmith 根据您的新输入重新考虑整个文档计划。
+
+```bash
+# 使用特定反馈重新生成结构规划
+aigne doc generate --feedback "删除‘关于’部分，并添加一个更详细的‘API 参考’。"
+```
+
+这种方法最适合对目录进行高级别的更改，而不是逐行编辑内容。
+
+借助这些工具，您可以维护与项目一同演进的准确、高质量的文档。内容优化后，您可能希望将其提供给全球受众。在 [翻译文档](./features-translate-documentation.md) 指南中了解如何操作。

package/docs/features.md

@@ -0,0 +1,56 @@
+---
+labels: ["Reference"]
+---
+
+# Core Features
+
+AIGNE DocSmith provides a comprehensive suite of tools to manage your documentation lifecycle, from initial creation to global distribution. It streamlines the process with a few simple commands, leveraging AI to automate complex tasks.
+
+The typical workflow follows a logical progression, allowing you to generate, refine, translate, and finally publish your documentation.
+
+```d2
+direction: right
+
+"Generate Docs": {
+  shape: step
+  description: "Automated creation from source code"
+}
+
+"Update & Refine": {
+  shape: step
+  description: "Sync with code changes and apply feedback"
+}
+
+"Translate": {
+  shape: step
+  description: "Reach a global audience with 12+ languages"
+}
+
+"Publish": {
+  shape: step
+  description: "Share your docs on public or private platforms"
+}
+
+"Generate Docs" -> "Update & Refine" -> "Translate" -> "Publish" {
+  style.animated: true
+}
+```
+
+Explore the main capabilities of DocSmith in the following sections:
+
+<x-cards data-columns="2">
+  <x-card data-title="Generate Documentation" data-icon="lucide:file-plus-2" data-href="/features/generate-documentation">
+    Automatically create a complete, well-structured set of documentation directly from your source code with a single command.
+  </x-card>
+  <x-card data-title="Update and Refine" data-icon="lucide:edit" data-href="/features/update-and-refine">
+    Keep your documentation synchronized with code changes or regenerate specific sections with targeted feedback to improve quality.
+  </x-card>
+  <x-card data-title="Translate Documentation" data-icon="lucide:languages" data-href="/features/translate-documentation">
+    Effortlessly translate your content into over 12 languages, making your project accessible to a global audience.
+  </x-card>
+  <x-card data-title="Publish Your Docs" data-icon="lucide:send" data-href="/features/publish-your-docs">
+    Publish your generated documentation to the official DocSmith platform or your own self-hosted instance with an interactive command.
+  </x-card>
+</x-cards>
+
+These core features work together to create a seamless documentation workflow. To see all available commands and their options in detail, head over to the [CLI Command Reference](./cli-reference.md).

package/docs/features.zh.md

@@ -0,0 +1,56 @@
+---
+labels: ["Reference"]
+---
+
+# 核心功能
+
+AIGNE DocSmith 提供了一套全面的工具来管理您的文档生命周期，从初始创建到全球分发。它通过几个简单的命令简化了该流程，并利用 AI 自动化复杂的任务。
+
+典型的工作流程遵循一个逻辑顺序，让您可以生成、优化、翻译并最终发布您的文档。
+
+```d2
+direction: right
+
+"生成文档": {
+  shape: step
+  description: "从源代码自动创建"
+}
+
+"更新与优化": {
+  shape: step
+  description: "与代码变更同步并应用反馈"
+}
+
+"翻译": {
+  shape: step
+  description: "支持 12 种以上语言，触及全球受众"
+}
+
+"发布": {
+  shape: step
+  description: "将文档分享到公共或私有平台"
+}
+
+"生成文档" -> "更新与优化" -> "翻译" -> "发布" {
+  style.animated: true
+}
+```
+
+在以下部分探索 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 官方平台或您自己托管的实例上。
+  </x-card>
+</x-cards>
+
+这些核心功能协同工作，共同打造无缝的文档工作流。要详细了解所有可用命令及其选项，请参阅 [CLI 命令参考](./cli-reference.md)。

package/docs/getting-started.md

@@ -0,0 +1,74 @@
+---
+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.
+
+## Prerequisites
+
+Before you begin, ensure you have the following installed on your system:
+
+- [Node.js](https://nodejs.org/)
+- [pnpm](https://pnpm.io/)
+
+## Step 1: Install AIGNE CLI
+
+DocSmith is available through the AIGNE Command Line Interface (CLI). Install the latest version globally using npm:
+
+```bash
+npm i -g @aigne/cli
+```
+
+Once the installation is complete, verify that it was successful by checking the help command for the documentation tool:
+
+```bash
+aigne doc -h
+```
+
+This command should display a list of available `doc` commands and their options.
+
+## Step 2: 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:
+
+```bash
+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.
+
+![Running the generate command triggers the smart initialization wizard](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
+
+## Step 3: Configure Your Project
+
+The interactive wizard will ask a series of questions to tailor the documentation to your specific needs. You will be prompted to define:
+
+- The primary purpose and style of the documentation.
+- Your target audience and their technical knowledge level.
+- 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.
+
+![Answer a series of questions to complete your project setup](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
+
+## Step 4: Review Your New Docs
+
+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 plans the document structure and generates content](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
+
+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`).
+
+![A success message confirms your documentation is ready](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
+
+## What's Next?
+
+You've successfully installed DocSmith and generated your first set of documents. Now you're ready to explore its capabilities in more detail.
+
+<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>

package/docs/getting-started.zh.md

@@ -0,0 +1,74 @@
+---
+labels: ["Reference"]
+---
+
+# 快速入门
+
+本指南将引导你完成 AIGNE DocSmith 的安装、首个项目的配置，并在短短几分钟内生成一套完整的文档。整个过程设计得非常简单，只需一个命令即可开始。
+
+## 前提条件
+
+在开始之前，请确保你的系统上已安装以下软件：
+
+- [Node.js](https://nodejs.org/)
+- [pnpm](https://pnpm.io/)
+
+## 第 1 步：安装 AIGNE CLI
+
+DocSmith 通过 AIGNE 命令行界面 (CLI) 提供。使用 npm 全局安装最新版本：
+
+```bash
+npm i -g @aigne/cli
+```
+
+安装完成后，通过检查文档工具的帮助命令来验证是否安装成功：
+
+```bash
+aigne doc -h
+```
+
+该命令应显示可用的 `doc` 命令及其选项列表。
+
+## 第 2 步：生成文档
+
+安装 AIGNE CLI 后，你只需一个命令即可生成文档。进入项目根目录并运行：
+
+```bash
+aigne doc generate
+```
+
+### 智能自动配置
+
+如果你是首次在项目中运行 DocSmith，它会自动检测到尚无配置，并启动一个交互式设置向导来引导你完成配置。
+
+![运行 generate 命令会触发智能初始化向导](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
+
+## 第 3 步：配置项目
+
+交互式向导将提出一系列问题，以根据你的具体需求定制文档。系统将提示你定义以下内容：
+
+- 文档的主要用途和风格。
+- 目标受众及其技术知识水平。
+- 主要语言以及任何需要翻译的其他语言。
+- 供 AI 分析的源代码路径。
+- 用于保存文档的输出目录。
+
+![回答一系列问题以完成项目设置](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
+
+## 第 4 步：查看新文档
+
+完成配置后，DocSmith 将开始生成过程。它会分析你的代码，规划出逻辑清晰的文档结构，并为每个部分撰写内容。
+
+![DocSmith 规划文档结构并生成内容](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
+
+完成后，你将在终端中看到一条成功消息。你的新文档现已在你指定的输出目录（例如 `.aigne/doc-smith/docs`）中准备就绪。
+
+![成功消息确认你的文档已准备就绪](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
+
+## 接下来呢？
+
+你已成功安装 DocSmith 并生成了第一套文档。现在，你可以开始更详细地探索其功能了。
+
+<x-card data-title="探索核心功能" data-icon="lucide:compass" data-href="/features" data-cta="了解更多">
+  深入了解 DocSmith 的主要命令和功能，从更新文档到在线发布。
+</x-card>

package/docs/overview.md

@@ -0,0 +1,48 @@
+---
+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.
+
+## 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.
+
+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.
+
+<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.
+</x-card>

package/docs/overview.zh.md

@@ -0,0 +1,48 @@
+---
+labels: ["Reference"]
+---
+
+# 概述
+
+AIGNE DocSmith 是一款基于 [AIGNE 框架](https://www.aigne.io/en/framework) 构建的 AI 驱动的文档生成工具。它可以直接根据您的源代码自动创建详细、结构化且支持多语言的文档，从而简化从规划到发布的整个工作流程。
+
+## AIGNE 生态系统的一部分
+
+DocSmith 是 [AIGNE](https://www.aigne.io) 生态系统的重要组成部分，该生态系统是一个用于开发 AI 应用的综合平台。它能与其他 AIGNE 组件无缝集成，充分利用平台的 AI 能力和基础设施。
+
+下图说明了 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 都能为您提供高效完成这些任务的工具。
+
+<x-card data-title="下一步：开始入门" data-href="/getting-started" data-icon="lucide:arrow-right-circle" data-cta="开始阅读指南">
+  遵循我们的分步指南，安装工具、配置您的第一个项目，并在几分钟内生成文档。
+</x-card>

package/media.md

@@ -0,0 +1,19 @@
+# 提供在文档中可使用的媒体素材
+
+![运行 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/d0766c19380a02eb8a6f8ce86a838849.png)
+
+![文档生成成功](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
+
+![智能检测，只重新生成需要的文档](https://docsmith.aigne.io/image-bin/uploads/21a76b2f65d14d16a49c13d800f1e2c1.png)
+
+![交互式选择需要更新文档](https://docsmith.aigne.io/image-bin/uploads/75e9cf9823bb369c3d2b5a2e2da4ac06.png)
+
+![发布文档到官方平台或自部署平台](https://docsmith.aigne.io/image-bin/uploads/9fd929060b5abe13d03cf5eb7aea85aa.png)
+
+![选择需要翻译的文档](https://docsmith.aigne.io/image-bin/uploads/e2cf5fa45aa856c406a444fb4665ed2d.png)
+
+![选择需要翻译的语言](https://docsmith.aigne.io/image-bin/uploads/2e243a2488f2060a693fe0ac0c8fb5ad.png)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "",
   "publishConfig": {
     "access": "public"