@aigne/doc-smith 0.8.12-beta.3 → 0.8.12-beta.4

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

@@ -1,142 +0,0 @@
-# Update and Refine
-
-Keeping documentation synchronized with an evolving codebase is a methodical process. AIGNE DocSmith provides direct and flexible commands to keep your content current, either through automatic updates based on code changes or through precise, feedback-driven refinements.
-
-This guide provides procedures for the following tasks:
-
-*   Automatically updating documents when source code is modified.
-*   Regenerating specific documents using targeted feedback.
-*   Adjusting the overall documentation structure.
-
-### Document Update Workflows
-
-The following diagram illustrates the different workflows available for updating your documentation:
-
-```d2 Document Update Workflows
-direction: down
-
-Developer: {
-  shape: c4-person
-}
-
-Source-Code: {
-  label: "Source Code"
-}
-
-Documentation: {
-  label: "Documentation"
-}
-
-Action-Choice: {
-  label: "Choose Action"
-  shape: diamond
-}
-
-Generate-Sync: {
-  label: "aigne doc generate"
-  shape: rectangle
-
-  Change-Detection: {
-    label: "Detect Changes?"
-    shape: diamond
-  }
-  Regenerate-Affected: "Regenerate Affected"
-  Regenerate-All: "Regenerate All"
-
-  Change-Detection -> Regenerate-Affected: "Yes (Default)"
-  Change-Detection -> Regenerate-All: "No\n(--forceRegenerate)"
-}
-
-Refine-Content: {
-  label: "aigne doc update"
-}
-
-Refine-Structure: {
-  label: "aigne doc generate\n--feedback"
-}
-
-Developer -> Action-Choice
-
-Action-Choice -> Generate-Sync: "Sync with Code"
-Action-Choice -> Refine-Content: "Refine Doc Content"
-Action-Choice -> Refine-Structure: "Refine Doc Structure"
-
-Source-Code -> Generate-Sync
-
-Generate-Sync.Regenerate-Affected -> Documentation: "Update"
-Generate-Sync.Regenerate-All -> Documentation: "Update"
-Refine-Content -> Documentation: "Update"
-Refine-Structure -> Documentation: "Update"
-```
-
----
-
-## Automatic Updates with Change Detection
-
-When you execute the `aigne doc generate` command, DocSmith first analyzes your codebase to detect changes since the last generation. It then regenerates only the documents affected by these changes. This default behavior conserves time and reduces API usage by avoiding redundant operations.
-
-```shell icon=lucide:terminal
-# DocSmith will detect changes and update only what is necessary
-aigne doc generate
-```
-
-![DocSmith detects changes and regenerates only the required documents.](../assets/screenshots/doc-regenerate.png)
-
-### Forcing a Full Regeneration
-
-To regenerate all documentation from scratch, bypassing the cache and change detection, use the `--forceRegenerate` flag. This is necessary when you have made significant configuration changes or require a complete rebuild to ensure consistency across all files.
-
-```shell icon=lucide:terminal
-# Regenerate all documentation from the ground up
-aigne doc generate --forceRegenerate
-```
-
----
-
-## Refining Documents with Feedback
-
-You can refine documentation without corresponding code changes by providing direct feedback to the CLI commands. This is useful for improving clarity, adding examples, or adjusting the structure.
-
-### Refining Individual Document Content
-
-To improve a specific document's content, use the `aigne doc update` command. This command allows you to provide targeted instructions for refinement and can be run in two modes: interactive or non-interactive.
-
-#### Interactive Mode
-
-For a guided process, run the command without arguments. DocSmith will present a menu to select the document you wish to update. After selection, you will be prompted to enter your feedback.
-
-```shell icon=lucide:terminal
-# Start the interactive update process
-aigne doc update
-```
-
-![Interactively select the documents you wish to update.](../assets/screenshots/doc-update.png)
-
-#### Non-Interactive Mode
-
-For scripted or faster workflows, you can specify the document and feedback directly using flags. This enables precise, non-interactive updates.
-
-```shell icon=lucide:terminal
-# Update a specific document with feedback
-aigne doc update --docs overview.md --feedback "Add a more detailed FAQ section at the end."
-```
-
-The primary parameters for the `update` command are as follows:
-
-| Parameter | Description |
-| :--- | :--- |
-| `--docs` | The path to the document to be updated. This flag can be used multiple times for batch updates. |
-| `--feedback` | A string containing the specific instructions to be used when regenerating the document's content. |
-
-### Optimizing the Overall Structure
-
-In addition to refining individual documents, you can adjust the overall documentation structure. If the existing organization is suboptimal or a section is missing, you can provide feedback to the `generate` command. This instructs DocSmith to re-evaluate the entire document plan based on your input.
-
-```shell icon=lucide:terminal
-# Regenerate the documentation structure with specific feedback
-aigne doc generate --feedback "Remove the 'About' section and add a detailed 'API Reference'."
-```
-
-This approach is intended for high-level changes to the document's table of contents, not for minor content edits within a single file.
-
-Once your content is refined, the next step is to prepare it for a global audience. For instructions, see the [Translate Documentation](./features-translate-documentation.md) guide.

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

@@ -1,143 +0,0 @@
-# 更新與完善
-
-讓文件與不斷演進的程式碼庫保持同步是一項有條不紊的過程。AIGNE DocSmith 提供直接而靈活的指令，讓您能透過程式碼變更自動更新，或透過精確、由回饋驅動的完善方式，來保持內容的最新狀態。
-
-本指南提供執行以下任務的程序：
-
-*   在原始碼修改時自動更新文件。
-*   使用針對性的回饋重新產生特定文件。
-*   調整整體文件結構。
-
-### 文件更新工作流程
-
-下圖說明了更新文件可用的不同工作流程：
-
-```d2 文件更新工作流程
-direction: down
-
-Developer: {
-  shape: c4-person
-  label: "開發者"
-}
-
-Source-Code: {
-  label: "原始碼"
-}
-
-Documentation: {
-  label: "文件"
-}
-
-Action-Choice: {
-  label: "選擇操作"
-  shape: diamond
-}
-
-Generate-Sync: {
-  label: "aigne doc generate"
-  shape: rectangle
-
-  Change-Detection: {
-    label: "偵測變更？"
-    shape: diamond
-  }
-  Regenerate-Affected: "重新產生受影響部分"
-  Regenerate-All: "全部重新產生"
-
-  Change-Detection -> Regenerate-Affected: "是 (預設)"
-  Change-Detection -> Regenerate-All: "否\n(--forceRegenerate)"
-}
-
-Refine-Content: {
-  label: "aigne doc update"
-}
-
-Refine-Structure: {
-  label: "aigne doc generate\n--feedback"
-}
-
-Developer -> Action-Choice
-
-Action-Choice -> Generate-Sync: "與程式碼同步"
-Action-Choice -> Refine-Content: "完善文件內容"
-Action-Choice -> Refine-Structure: "完善文件結構"
-
-Source-Code -> Generate-Sync
-
-Generate-Sync.Regenerate-Affected -> Documentation: "更新"
-Generate-Sync.Regenerate-All -> Documentation: "更新"
-Refine-Content -> Documentation: "更新"
-Refine-Structure -> Documentation: "更新"
-```
-
----
-
-## 透過變更偵測自動更新
-
-當您執行 `aigne doc generate` 指令時，DocSmith 會先分析您的程式碼庫，以偵測自上次產生以來的變更。然後，它只會重新產生受這些變更影響的文件。這種預設行為可以節省時間並減少 API 使用量，避免了多餘的操作。
-
-```shell icon=lucide:terminal
-# DocSmith 將偵測變更並僅更新必要的部分
-aigne doc generate
-```
-
-![DocSmith 偵測變更並僅重新產生所需的文件。](../assets/screenshots/doc-regenerate.png)
-
-### 強制完整重新產生
-
-若要從頭開始重新產生所有文件，繞過快取和變更偵測，請使用 `--forceRegenerate` 旗標。當您進行了重大的設定變更或需要完全重建以確保所有檔案的一致性時，這項操作是必要的。
-
-```shell icon=lucide:terminal
-# 從頭開始重新產生所有文件
-aigne doc generate --forceRegenerate
-```
-
----
-
-## 透過回饋完善文件
-
-您可以透過向 CLI 指令提供直接回饋，在沒有相應程式碼變更的情況下完善文件。這對於提高清晰度、新增範例或調整結構很有用。
-
-### 完善個別文件內容
-
-若要改善特定文件的內容，請使用 `aigne doc update` 指令。此指令允許您提供針對性的完善指示，並可以互動或非互動兩種模式執行。
-
-#### 互動模式
-
-若要進行引導式流程，請在不帶任何參數的情況下執行該指令。DocSmith 將會顯示一個選單，讓您選擇要更新的文件。選擇後，系統會提示您輸入回饋。
-
-```shell icon=lucide:terminal
-# 開始互動式更新流程
-aigne doc update
-```
-
-![以互動方式選擇您希望更新的文件。](../assets/screenshots/doc-update.png)
-
-#### 非互動模式
-
-對於腳本化或更快速的工作流程，您可以使用旗標直接指定文件和回饋。這可以實現精確的非互動式更新。
-
-```shell icon=lucide:terminal
-# 透過回饋更新特定文件
-aigne doc update --docs overview.md --feedback "Add a more detailed FAQ section at the end."
-```
-
-`update` 指令的主要參數如下：
-
-| 參數 | 說明 |
-| :--- | :--- |
-| `--docs` | 要更新的文件的路徑。此旗標可多次使用以進行批次更新。 |
-| `--feedback` | 一個字串，包含重新產生文件內容時要使用的具體指示。 |
-
-### 最佳化整體結構
-
-除了完善個別文件外，您還可以調整整體文件結構。如果現有組織結構不佳或缺少某個部分，您可以向 `generate` 指令提供回饋。這會指示 DocSmith 根據您的輸入重新評估整個文件計畫。
-
-```shell icon=lucide:terminal
-# 透過特定回饋重新產生文件結構
-aigne doc generate --feedback "Remove the 'About' section and add a detailed 'API Reference'."
-```
-
-此方法適用於對文件目錄進行高層次的變更，而非針對單一檔案內的微小內容編輯。
-
-內容完善後，下一步是為全球受眾做準備。相關說明，請參閱 [翻譯文件](./features-translate-documentation.md) 指南。

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

@@ -1,142 +0,0 @@
-# 更新和优化
-
-让文档与不断演进的代码库保持同步是一个系统性的过程。AIGNE DocSmith 提供了直接且灵活的命令，可以通过基于代码变更的自动更新或通过精确、由反馈驱动的优化来保持您的内容为最新状态。
-
-本指南提供了执行以下任务的步骤：
-
-*   在源代码修改时自动更新文档。
-*   使用有针对性的反馈重新生成特定文档。
-*   调整整体文档结构。
-
-### 文档更新工作流
-
-下图说明了可用于更新文档的不同工作流：
-
-```d2 文档更新工作流
-direction: down
-
-Developer: {
-  shape: c4-person
-}
-
-Source-Code: {
-  label: "源代码"
-}
-
-Documentation: {
-  label: "文档"
-}
-
-Action-Choice: {
-  label: "选择操作"
-  shape: diamond
-}
-
-Generate-Sync: {
-  label: "aigne doc generate"
-  shape: rectangle
-
-  Change-Detection: {
-    label: "检测变更？"
-    shape: diamond
-  }
-  Regenerate-Affected: "重新生成受影响部分"
-  Regenerate-All: "重新生成全部"
-
-  Change-Detection -> Regenerate-Affected: "是 (默认)"
-  Change-Detection -> Regenerate-All: "否\n(--forceRegenerate)"
-}
-
-Refine-Content: {
-  label: "aigne doc update"
-}
-
-Refine-Structure: {
-  label: "aigne doc generate\n--feedback"
-}
-
-Developer -> Action-Choice
-
-Action-Choice -> Generate-Sync: "与代码同步"
-Action-Choice -> Refine-Content: "优化文档内容"
-Action-Choice -> Refine-Structure: "优化文档结构"
-
-Source-Code -> Generate-Sync
-
-Generate-Sync.Regenerate-Affected -> Documentation: "更新"
-Generate-Sync.Regenerate-All -> Documentation: "更新"
-Refine-Content -> Documentation: "更新"
-Refine-Structure -> Documentation: "更新"
-```
-
----
-
-## 通过变更检测自动更新
-
-当您执行 `aigne doc generate` 命令时，DocSmith 会首先分析您的代码库，以检测自上次生成以来的变更。然后，它仅重新生成受这些变更影响的文档。这种默认行为通过避免冗余操作来节省时间并减少 API 使用。
-
-```shell icon=lucide:terminal
-# DocSmith 将检测变更并仅更新必要部分
-aigne doc generate
-```
-
-![DocSmith 检测变更并仅重新生成所需文档。](../assets/screenshots/doc-regenerate.png)
-
-### 强制完全重新生成
-
-要从头开始重新生成所有文档，绕过缓存和变更检测，请使用 `--forceRegenerate` 标志。当您进行了重大的配置更改或需要完全重建以确保所有文件的一致性时，这是必要的。
-
-```shell icon=lucide:terminal
-# 从头开始重新生成所有文档
-aigne doc generate --forceRegenerate
-```
-
----
-
-## 通过反馈优化文档
-
-您可以通过向 CLI 命令提供直接反馈来优化文档，而无需进行相应的代码更改。这对于提高清晰度、添加示例或调整结构非常有用。
-
-### 优化单个文档内容
-
-要改进特定文档的内容，请使用 `aigne doc update` 命令。该命令允许您提供有针对性的优化指令，并可以在两种模式下运行：交互式或非交互式。
-
-#### 交互模式
-
-要进行引导式流程，请在不带参数的情况下运行该命令。DocSmith 将会显示一个菜单，供您选择要更新的文档。选择后，系统将提示您输入反馈。
-
-```shell icon=lucide:terminal
-# 启动交互式更新流程
-aigne doc update
-```
-
-![以交互方式选择您希望更新的文档。](../assets/screenshots/doc-update.png)
-
-#### 非交互模式
-
-对于脚本化或更快速的工作流，您可以使用标志直接指定文档和反馈。这样可以实现精确的非交互式更新。
-
-```shell icon=lucide:terminal
-# 使用反馈更新特定文档
-aigne doc update --docs overview.md --feedback "Add a more detailed FAQ section at the end."
-```
-
-`update` 命令的主要参数如下：
-
-| 参数 | 描述 |
-| :--- | :--- |
-| `--docs` | 要更新的文档的路径。此标志可以多次使用以进行批量更新。 |
-| `--feedback` | 一个包含在重新生成文档内容时要使用的具体指令的字符串。 |
-
-### 优化整体结构
-
-除了优化单个文档外，您还可以调整整体文档结构。如果现有组织结构不理想或缺少某个部分，您可以向 `generate` 命令提供反馈。这会指示 DocSmith 根据您的输入重新评估整个文档计划。
-
-```shell icon=lucide:terminal
-# 使用特定反馈重新生成文档结构
-aigne doc generate --feedback "Remove the 'About' section and add a detailed 'API Reference'."
-```
-
-此方法旨在对文档的目录进行高层级更改，而非对单个文件内的细微内容进行编辑。
-
-内容优化后，下一步是为全球受众做准备。有关说明，请参阅[翻译文档](./features-translate-documentation.md)指南。

package/docs/features.ja.md

@@ -1,62 +0,0 @@
-# コア機能
-
-AIGNE DocSmithは、初期作成からグローバルな配布まで、ドキュメントのライフサイクルを管理するための一連のコマンドを提供します。プロセスは、ドキュメントの生成、改良、翻訳、公開という標準的なワークフローに整理されています。
-
-```d2
-direction: down
-
-source-code: {
-  label: "ソースコード"
-  shape: rectangle
-}
-
-generate-documentation: {
-  label: "ドキュメントの生成"
-  shape: rectangle
-}
-
-update-and-refine: {
-  label: "更新と改良"
-  shape: rectangle
-}
-
-translate-documentation: {
-  label: "ドキュメントの翻訳"
-  shape: rectangle
-}
-
-publish-docs: {
-  label: "ドキュメントの公開"
-  shape: rectangle
-}
-
-platform: {
-  label: "DocSmith プラットフォーム\n(またはセルフホスト)"
-  shape: cylinder
-}
-
-source-code -> generate-documentation
-generate-documentation -> update-and-refine
-update-and-refine -> translate-documentation
-translate-documentation -> publish-docs
-publish-docs -> platform
-```
-
-以下のセクションで、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">
-    コンテンツを複数の対応言語に翻訳し、プロジェクトを世界中のオーディエンスにアクセス可能にします。
-  </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/features.md

@@ -1,62 +0,0 @@
-# Core Features
-
-AIGNE DocSmith provides a set of commands to manage the documentation lifecycle, from initial creation to global distribution. The process is organized into a standard workflow: generating, refining,translating, and publishing your documentation.
-
-```d2
-direction: down
-
-source-code: {
-  label: "Source Code"
-  shape: rectangle
-}
-
-generate-documentation: {
-  label: "Generate Documentation"
-  shape: rectangle
-}
-
-update-and-refine: {
-  label: "Update and Refine"
-  shape: rectangle
-}
-
-translate-documentation: {
-  label: "Translate Documentation"
-  shape: rectangle
-}
-
-publish-docs: {
-  label: "Publish Your Docs"
-  shape: rectangle
-}
-
-platform: {
-  label: "DocSmith Platform\n(or self-hosted)"
-  shape: cylinder
-}
-
-source-code -> generate-documentation
-generate-documentation -> update-and-refine
-update-and-refine -> translate-documentation
-translate-documentation -> publish-docs
-publish-docs -> platform
-```
-
-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">
-    Create a complete set of documentation from your source code using 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 documents with targeted feedback.
-  </x-card>
-  <x-card data-title="Translate Documentation" data-icon="lucide:languages" data-href="/features/translate-documentation">
-    Translate your content into multiple supported languages to make 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.
-  </x-card>
-</x-cards>
-
-These features provide a structured workflow for creating and maintaining documentation. For a detailed list of all available commands and their options, refer to the [CLI Command Reference](./cli-reference.md).

package/docs/features.zh-TW.md

@@ -1,62 +0,0 @@
-# 核心功能
-
-AIGNE DocSmith 提供了一組指令來管理文件的生命週期，從初始建立到全球分發。整個過程被組織成一個標準的工作流程：產生、優化、翻譯和發布您的文件。
-
-```d2
-direction: down
-
-source-code: {
-  label: "原始碼"
-  shape: rectangle
-}
-
-generate-documentation: {
-  label: "產生文件"
-  shape: rectangle
-}
-
-update-and-refine: {
-  label: "更新與優化"
-  shape: rectangle
-}
-
-translate-documentation: {
-  label: "翻譯文件"
-  shape: rectangle
-}
-
-publish-docs: {
-  label: "發布您的文件"
-  shape: rectangle
-}
-
-platform: {
-  label: "DocSmith 平台\n（或自行託管）"
-  shape: cylinder
-}
-
-source-code -> generate-documentation
-generate-documentation -> update-and-refine
-update-and-refine -> translate-documentation
-translate-documentation -> publish-docs
-publish-docs -> platform
-```
-
-在以下章節中探索 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">
-    將您的內容翻譯成多種支援的語言，讓您的專案能夠觸及全球使用者。
-  </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/features.zh.md

@@ -1,62 +0,0 @@
-# 核心功能
-
-AIGNE DocSmith 提供了一套命令来管理文档的整个生命周期，从初始创建到全球分发。该过程被组织成一个标准工作流程：生成、优化、翻译和发布您的文档。
-
-```d2
-direction: down
-
-source-code: {
-  label: "源代码"
-  shape: rectangle
-}
-
-generate-documentation: {
-  label: "生成文档"
-  shape: rectangle
-}
-
-update-and-refine: {
-  label: "更新与优化"
-  shape: rectangle
-}
-
-translate-documentation: {
-  label: "翻译文档"
-  shape: rectangle
-}
-
-publish-docs: {
-  label: "发布文档"
-  shape: rectangle
-}
-
-platform: {
-  label: "DocSmith 平台\n(或自托管)"
-  shape: cylinder
-}
-
-source-code -> generate-documentation
-generate-documentation -> update-and-refine
-update-and-refine -> translate-documentation
-translate-documentation -> publish-docs
-publish-docs -> platform
-```
-
-在以下部分中，探索 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">
-    将您的内容翻译成多种支持的语言，使您的项目能够面向全球受众。
-  </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)。