@aigne/doc-smith 0.6.0 → 0.7.1

package/docs/configuration.zh.md

@@ -0,0 +1,173 @@
+---
+labels: ["Reference"]
+---
+
+# 配置指南
+
+AIGNE DocSmith 的行为由一个强大的配置文件 `config.yaml` 控制。该文件位于项目的 `.aigne/doc-smith` 目录中，你可以通过它自定义文档生成过程的各个方面，从目标受众、风格到语言支持和文件结构。
+
+本指南为所有可用设置提供了详细的参考。虽然你可以随时手动编辑此文件，但我们建议使用 [交互式设置](./configuration-interactive-setup.md) 向导来完成初始配置。
+
+## 配置概览
+
+DocSmith 提供灵活的配置系统，以满足你项目的独特需求。你可以定义文档的目标、指定受众、设置 AI 模型以及管理多种语言。请在下方探索主要的配置领域。
+
+<x-cards data-columns="2">
+  <x-card data-title="交互式设置" data-href="/configuration/interactive-setup" data-icon="lucide:wand-2">
+    了解如何使用 `aigne doc init` 命令运行引导式向导，轻松创建初始配置文件。
+  </x-card>
+  <x-card data-title="LLM 设置" data-href="/configuration/llm-setup" data-icon="lucide:brain-circuit">
+    配置不同的大语言模型，包括使用集成的 AIGNE Hub 免密钥访问热门模型。
+  </x-card>
+  <x-card data-title="语言支持" data-href="/configuration/language-support" data-icon="lucide:languages">
+    设置你的主要文档语言，并从超过 12 种支持的语言中选择进行自动翻译。
+  </x-card>
+  <x-card data-title="管理偏好" data-href="/configuration/preferences" data-icon="lucide:sliders-horizontal">
+    了解 DocSmith 如何从你的反馈中学习以创建持久化规则，以及如何管理这些规则。
+  </x-card>
+</x-cards>
+
+## 参数参考
+
+`config.yaml` 文件包含几个关键部分，用于定义文档的生成方式。以下是每个参数的详细说明。
+
+### 项目信息
+
+这些设置用于发布文档时的信息展示。
+
+```yaml
+# 用于文档发布的项目信息
+projectName: AIGNE DocSmith
+projectDesc: 一款 AI 驱动的文档生成工具。
+projectLogo: https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png
+```
+
+- `projectName`: 你的项目名称。
+- `projectDesc`: 你的项目的简短描述。
+- `projectLogo`: 你的项目徽标的 URL。
+
+### 文档风格
+
+这些参数定义了文档的用途、受众和整体基调。
+
+#### `documentPurpose`
+
+定义读者的主要目标。你可以选择多个用途。
+
+| Key | Name | Description |
+|---|---|---|
+| `getStarted` | 快速入门 | 帮助新用户在 30 分钟内从零开始上手。 |
+| `completeTasks` | 完成特定任务 | 引导用户完成常见的工作流程和用例。 |
+| `findAnswers` | 快速查找答案 | 为所有功能和 API 提供可搜索的参考。 |
+| `understandSystem` | 理解系统 | 解释其工作原理以及做出设计决策的原因。 |
+| `solveProblems` | 排查常见问题 | 帮助用户排查和修复问题。 |
+| `mixedPurpose` | 满足多种用途 | 涵盖多种需求的综合性文档。 |
+
+**示例：**
+```yaml
+documentPurpose:
+  - getStarted
+  - findAnswers
+```
+
+#### `targetAudienceTypes`
+
+指定文档的主要受众。
+
+| Key | Name | Description |
+|---|---|---|
+| `endUsers` | 最终用户（非技术人员） | 使用产品但不编写代码的人员。 |
+| `developers` | 集成你的产品/API 的开发者 | 将此产品添加到其项目中的工程师。 |
+| `devops` | DevOps / SRE / 基础设施团队 | 负责部署、监控和维护系统的团队。 |
+| `decisionMakers` | 技术决策者 | 评估或规划实施方案的架构师和负责人。 |
+| `supportTeams` | 支持团队 | 帮助他人使用产品的人员。 |
+| `mixedTechnical` | 混合技术受众 | 开发者、DevOps 和技术用户。 |
+
+**示例：**
+```yaml
+targetAudienceTypes:
+  - developers
+```
+
+#### `readerKnowledgeLevel`
+
+描述读者的典型初始知识水平。
+
+| Key | Name | Description |
+|---|---|---|
+| `completeBeginners` | 完全的初学者，从零开始 | 完全不了解该领域/技术。 |
+| `domainFamiliar` | 以前使用过类似的工具 | 了解问题领域，但对这个具体解决方案不熟悉。 |
+| `experiencedUsers` | 试图做特定事情的专家 | 需要参考/高级主题的普通用户。 |
+| `emergencyTroubleshooting` | 紧急情况/故障排查 | 出现问题，需要快速修复。 |
+| `exploringEvaluating` | 正在评估此工具并与其他工具进行比较 | 试图了解这是否满足他们的需求。 |
+
+**示例：**
+```yaml
+readerKnowledgeLevel: completeBeginners
+```
+
+#### `documentationDepth`
+
+控制文档的全面程度。
+
+| Key | Name | Description |
+|---|---|---|
+| `essentialOnly` | 仅包含基本内容 | 覆盖 80% 的用例，保持简洁。 |
+| `balancedCoverage` | 平衡的覆盖范围 | 具有良好深度和实际示例 [推荐]。 |
+| `comprehensive` | 全面 | 覆盖所有功能、边缘情况和高级场景。 |
+| `aiDecide` | 让 AI 决定 | 分析代码复杂性并建议适当的深度。 |
+
+**示例：**
+```yaml
+documentationDepth: balancedCoverage
+```
+
+### 自定义规则和描述
+
+这些字段允许你向 AI 提供更具体的指令。
+
+- `rules`: 一个多行字符串，你可以在其中定义具体的生成规则和要求，例如“在教程中始终包含‘先决条件’部分”。
+- `targetAudience`: 一个多行字符串，用于比预设选项更详细地描述你的目标受众。
+
+**示例：**
+```yaml
+rules: |
+  - 所有代码示例必须是完整的，并且可以直接复制粘贴。
+  - 避免使用未加解释的技术术语。
+targetAudience: |
+  我们的受众是熟悉 JavaScript 但可能不熟悉后端概念的前端开发者。他们重视清晰、实用的示例。
+```
+
+### 语言和路径设置
+
+这些参数用于配置文档的语言和文件位置。
+
+- `locale`: 文档的主要语言（例如 `en`、`zh`）。
+- `translateLanguages`: 要将文档翻译成的目标语言代码列表。
+- `glossary`: 指向一个 Markdown 文件的路径，该文件包含项目特定术语，以确保翻译的一致性。
+- `docsDir`: 用于保存生成的文档的目录。
+- `sourcesPath`: 供 AI 分析的源代码路径或 glob 模式列表。
+
+**示例：**
+```yaml
+# 语言设置
+locale: en
+translateLanguages:
+  - zh
+  - ja
+
+# 用于确保术语一致性的词汇表
+glossary: "@glossary.md"
+
+# 目录和源路径配置
+docsDir: .aigne/doc-smith/docs  # 保存生成文档的目录
+sourcesPath:  # 需要分析的源代码路径
+  - ./src
+  - ./README.md
+```
+
+---
+
+根据你的项目定制好 `config.yaml` 文件后，你就可以开始创建文档了。下一步是运行生成命令。
+
+➡️ **下一步：** 学习如何 [生成文档](./features-generate-documentation.md)。

package/docs/features-generate-documentation.md

@@ -0,0 +1,82 @@
+---
+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.
+
+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.
+
+## Your First Generation
+
+To begin, navigate to your project's root directory and run the following command:
+
+```bash
+aigne doc generate
+```
+
+### Smart Auto-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.
+
+![Running the generate command for the first time triggers the setup wizard](https://docsmith.aigne.io/image-bin/uploads/0c45a32667c5250e54194a61d9495965.png)
+
+You will be asked a series of questions to define:
+- Document generation rules and style
+- The target audience
+- Primary and translation languages
+- Source code and output paths
+
+![Answer a few questions to configure your documentation style, languages, and source paths](https://docsmith.aigne.io/image-bin/uploads/fbedbfa256036ad6375a6c18047a75ad.png)
+
+Once the configuration is complete, DocSmith proceeds with the documentation generation.
+
+![DocSmith analyzes your code, plans the structure, and generates each document](https://docsmith.aigne.io/image-bin/uploads/d0766c19380a02eb8a6f8ce86a838849.png)
+
+Upon successful completion, your newly created documentation will be available in the output directory you specified.
+
+![Once complete, you'll find your new documentation in the specified output directory](https://docsmith.aigne.io/image-bin/uploads/0967443611408ad9d0042793d590b8fd.png)
+
+## 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:
+
+```d2
+direction: down
+
+start: "Start"
+run_cmd: "Run `aigne doc generate`"
+check_config: "Configuration exists?" {
+  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
+check_config -> interactive_setup: "No"
+interactive_setup -> plan_structure
+check_config -> plan_structure: "Yes"
+plan_structure -> gen_content -> save_docs -> end
+```
+
+## Fine-Tuning Your Generation
+
+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.
+
+| 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`                |
+
+## 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>.

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

@@ -0,0 +1,82 @@
+---
+labels: ["Reference"]
+---
+
+# 生成文档
+
+`aigne doc generate` 命令是 DocSmith 的核心功能，旨在通过一个命令将您的源代码转换为内容全面、结构清晰的文档套件。
+
+该过程包括分析您的代码库、规划合理的文档结构，然后为每个部分生成详细内容。这是从零开始创建文档的主要方式。
+
+## 首次生成
+
+首先，请进入您项目的根目录并运行以下命令：
+
+```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: "开始"
+run_cmd: "运行 `aigne doc generate`"
+check_config: "配置是否存在？" {
+  shape: diamond
+}
+interactive_setup: "交互式设置向导"
+plan_structure: "分析代码并规划结构"
+gen_content: "生成文档内容"
+save_docs: "将文档保存到输出目录"
+end: "结束"
+
+start -> run_cmd -> check_config
+check_config -> interactive_setup: "否"
+interactive_setup -> plan_structure
+check_config -> plan_structure: "是"
+plan_structure -> gen_content -> 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-publish-your-docs.md

@@ -0,0 +1,98 @@
+---
+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.
+
+This guide covers how to publish your documentation, whether you're using the free official platform or your own self-hosted instance.
+
+## 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
+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!"
+```
+
+## 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>
+
+## Step-by-Step Guide
+
+Publishing your documentation for the first time is a simple, interactive process.
+
+### 1. Run the Publish Command
+
+Navigate to your project's root directory in your terminal and run the following command:
+
+```bash
+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.
+
+![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.
+
+### 3. Authenticate Your Account
+
+For the first connection to a new platform, DocSmith will automatically open a browser window for you to log in and authorize the CLI. This is a one-time step; your access token will be saved locally for all future publishes to that platform.
+
+### 4. Confirmation
+
+Once the upload is complete, you will see a success message in your terminal, and your documentation will be live.
+
+```
+✅ Documentation Published Successfully!
+```
+
+## Publishing in CI/CD Environments
+
+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=...` |
+
+## 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.
+
+For a complete list of commands and options, please refer to the [CLI Command Reference](./cli-reference.md).

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

@@ -0,0 +1,98 @@
+---
+labels: ["Reference"]
+---
+
+# 发布文档
+
+文档生成后，下一步是将其发布到线上。AIGNE DocSmith 通过 `aigne doc publish` 命令简化了这一过程，该命令会将您的内容上传到 Discuss Kit 平台，使其即时对您的受众可用。
+
+本指南将介绍如何发布您的文档，无论您使用的是免费的官方平台还是自托管的实例。
+
+## 发布流程
+
+`aigne doc publish` 命令会启动一个交互式流程，引导您完成必要的步骤。下图展示了首次发布文档的典型工作流程。
+
+```d2
+shape: sequence_diagram
+
+用户; CLI; "Discuss Kit 平台"
+
+用户 -> CLI: 运行 `aigne doc publish`
+
+alt "首次使用或未配置"
+  CLI -> 用户: "提示：选择平台"
+  用户 -> CLI: "选择官方或自托管"
+  CLI -> 用户: "打开浏览器进行身份验证"
+  用户 -> "Discuss Kit 平台": "登录并授权"
+  "Discuss Kit 平台" -> CLI: "提供访问令牌"
+  CLI -> CLI: "保存令牌供将来使用"
+end
+
+CLI -> "Discuss Kit 平台": "上传文档和媒体文件"
+"Discuss Kit 平台" -> CLI: "确认成功"
+CLI -> 用户: "✅ 文档发布成功！"
+```
+
+## 发布选项
+
+您有两种主要选项来托管您的文档，以满足不同的可见性和控制需求。
+
+<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>
+
+## 分步指南
+
+首次发布文档是一个简单的交互式过程。
+
+### 1. 运行发布命令
+
+在终端中，导航到您项目的根目录并运行以下命令：
+
+```bash
+aigne doc publish
+```
+
+### 2. 选择您的平台
+
+如果您之前没有配置过发布目标，系统将提示您在官方平台和自托管平台之间进行选择。请选择最适合您需求的选项。
+
+![在官方平台或自托管实例之间选择](https://docsmith.aigne.io/image-bin/uploads/9fd929060b5abe13d03cf5eb7aea85aa.png)
+
+如果您选择自托管选项，系统将要求您输入您的 Discuss Kit 实例的 URL。
+
+### 3. 验证您的账户
+
+首次连接到新平台时，DocSmith 会自动打开一个浏览器窗口，供您登录并授权 CLI。这是一个一次性步骤；您的访问令牌将被保存在本地，用于将来向该平台进行的所有发布。
+
+### 4. 确认
+
+上传完成后，您将在终端中看到一条成功消息，您的文档即已上线。
+
+```
+✅ 文档发布成功！
+```
+
+## 在 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=...` |
+
+## 故障排除
+
+如果您在发布过程中遇到问题，以下是一些常见原因及其解决方案：
+
+-   **无效的 URL 或连接错误**：这通常发生在为自托管实例提供的 URL 不正确或服务器无法访问时。请仔细检查 URL 和您的网络连接。
+-   **缺少必需组件**：目标网站必须安装 Discuss Kit 组件才能托管文档。如果缺少该组件，CLI 将返回错误并提供安装指导。
+
+有关命令和选项的完整列表，请参阅 [CLI 命令参考](./cli-reference.md)。

package/docs/features-translate-documentation.md

@@ -0,0 +1,83 @@
+---
+labels: ["Reference"]
+---
+
+# Translate Documentation
+
+AIGNE DocSmith helps you reach a global audience by automatically translating your documentation into over 12 languages. This feature streamlines the localization process, ensuring your content is accessible to users worldwide with a single command.
+
+## Easy Translation with Interactive Mode
+
+For a guided experience, the simplest way to start is by running the `translate` command without any arguments:
+
+```bash
+aigne doc translate
+```
+
+This will launch an interactive wizard that walks you through the process:
+
+1.  **Select Documents to Translate:** You'll be presented with a list of your existing documents. Simply choose the ones you want to translate.
+
+    ![Select documents to translate](https://docsmith.aigne.io/image-bin/uploads/e2cf5fa45aa856c406a444fb4665ed2d.png)
+
+2.  **Choose Target Languages:** After selecting your documents, you can pick one or more target languages from the list of supported options.
+
+    ![Select languages to translate into](https://docsmith.aigne.io/image-bin/uploads/2e243a2488f2060a693fe0ac0c8fb5ad.png)
+
+3.  **Confirm and Run:** DocSmith will then handle the translation, generating new versions of your selected files for each language.
+
+## Advanced Control with Command-Line Flags
+
+For automation or more specific tasks, you can use command-line flags to control the translation process directly. This is ideal for integrating into CI/CD pipelines or for power users who prefer the command line.
+
+Here are the primary options available:
+
+| Parameter | Description |
+|---|---|
+| `--langs` | Specify one or more target languages. This flag can be used multiple times (e.g., `--langs zh --langs ja`). |
+| `--docs` | Specify the paths of the documents to translate. This flag can also be used multiple times. |
+| `--feedback` | Provide feedback to the AI to improve the quality of future translations (e.g., `--feedback "Use formal tone"`). |
+| `--glossary` | Use a glossary file in markdown format to ensure consistent terminology for specific terms (e.g., `--glossary @path/to/glossary.md`). |
+
+### Example: Translating Specific Documents
+
+To translate `overview.md` and `examples.md` into Chinese and Japanese, you would run:
+
+```bash
+aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
+```
+
+### Example: Using a Glossary and Feedback
+
+To ensure brand names and technical terms are translated correctly, you can provide a glossary file. You can also give feedback to refine the translation style.
+
+```bash
+aigne doc translate --glossary @glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
+```
+
+## Supported Languages
+
+DocSmith supports automatic translation for the following languages:
+
+| Language | Code |
+|---|---|
+| English | en |
+| Simplified Chinese | zh-CN |
+| Traditional Chinese | zh-TW |
+| Japanese | ja |
+| Korean | ko |
+| Spanish | es |
+| French | fr |
+| German | de |
+| Portuguese | pt-BR |
+| Russian | ru |
+| Italian | it |
+| Arabic | ar |
+
+---
+
+Once your documentation is translated, you're ready to share it with the world. Learn how in the next section.
+
+<x-card data-title="Next: Publish Your Docs" data-icon="lucide:upload-cloud" data-href="/features/publish-your-docs" data-cta="Read More">
+  A guide on how to easily publish your documentation to a public platform or your own private website.
+</x-card>