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

package/docs/advanced-quality-assurance.zh-TW.md

@@ -1,96 +1,92 @@
 # 品質保證
 
-為確保所有生成的文檔功能正常、清晰且專業，DocSmith 整合了一個自動化的品質保證流程。此流程會在發布前對 Markdown 內容執行一系列檢查，以偵測並報告從斷開的連結到格式錯誤的圖表等常見問題。
+為確保所有產生的文件都符合高品質、一致性和準確性的標準，DocSmith 內建了一個全面、自動化的品質保證流程。這些內建的檢查會在發布前自動運行，以識別並標記常見的格式錯誤、失效連結和結構性問題。此過程確保最終的輸出成品具備專業性、可靠性，並讓使用者易於瀏覽。
 
-這個自動化管道會驗證內容結構、連結、媒體和語法，以維持一致的品質標準。
-
-```d2
+```d2 品質保證流程 icon=lucide:shield-check
 direction: down
 
-Input-Markdown-Content: {
-  label: "輸入：Markdown 內容"
+Documentation-Content: {
+  label: "文件內容"
   shape: rectangle
 }
 
-QA-Pipeline: {
-  label: "QA 管道"
+Quality-Assurance-Pipeline: {
+  label: "品質保證流程"
   shape: rectangle
-  grid-columns: 1
+  grid-columns: 3
   grid-gap: 50
 
-  Structural-Checks: {
-    label: "結構檢查"
+  Markdown-Validation: {
+    label: "1. Markdown 與內容驗證\n(基於 remark-lint)"
     shape: rectangle
-    grid-columns: 2
-    Completeness: "確保內容未被截斷"
-    Code-Blocks: "驗證區塊語法與縮排"
+
+    Check-1: "有效的 Markdown 語法"
+    Check-2: "標題完整性"
+    Check-3: "表格格式"
+    Check-4: "程式碼區塊完整性"
+    Check-5: "內容完整性"
   }
 
-  Content-Validation: {
-    label: "內容驗證"
+  Link-Asset-Validation: {
+    label: "2. 連結與資源完整性"
     shape: rectangle
-    grid-columns: 2
-    Link-Integrity: "驗證內部連結"
-    Image-Paths: "檢查本地圖片是否存在"
-    Table-Formatting: "匹配欄位數量"
+
+    Check-6: "失效連結偵測"
+    Check-7: "本地圖片驗證"
   }
 
-  Syntax-Validation: {
-    label: "語法驗證"
+  D2-Diagram-Validation: {
+    label: "3. D2 圖表驗證"
     shape: rectangle
-    grid-columns: 2
-    D2-Diagrams: "驗證 D2 語法"
-    Markdown-Linting: "強制執行樣式規則"
+
+    Check-8: "D2 語法檢查"
   }
 }
 
-Output-Validated-Content-or-Error-Report: {
-  label: "輸出：已驗證的內容或錯誤報告"
-  shape: rectangle
+Validation-Result: {
+  label: "所有檢查是否通過？"
+  shape: diamond
 }
 
-Input-Markdown-Content -> QA-Pipeline
-QA-Pipeline -> Output-Validated-Content-or-Error-Report
-```
-
-### 核心驗證領域
-
-DocSmith 的品質保證流程涵蓋了幾個關鍵領域，以確保文檔的完整性。
-
-#### 內容結構與完整性
-
-DocSmith 執行多項檢查，以確保內容的結構完整性：
+Published-Documentation: {
+  label: "已發布的文件"
+  shape: rectangle
+  style.fill: "#d4edda"
+}
 
-- **不完整的程式碼區塊**：偵測以 ` ``` ` 開啟但未關閉的程式碼區塊。
-- **缺少換行符**：識別出現在單一行上的內容，這可能表示缺少換行符。
-- **內容結尾**：驗證內容是否以適當的標點符號（例如 `.`、`)`、`|`、`>`）結尾，以防止輸出被截斷。
-- **程式碼區塊縮排**：分析程式碼區塊中不一致的縮排。如果某一行程式碼的縮排少於開頭的 ` ``` ` 標記，可能會導致渲染問題。此檢查有助於維持正確的程式碼呈現。
+Error-Report: {
+  label: "錯誤報告"
+  shape: rectangle
+  style.fill: "#f8d7da"
+}
 
-#### 連結與媒體完整性
+Documentation-Content -> Quality-Assurance-Pipeline: "輸入"
+Quality-Assurance-Pipeline -> Validation-Result: "驗證"
+Validation-Result -> Published-Documentation: "是"
+Validation-Result -> Error-Report: "否"
+```
 
-- **連結完整性**：文檔中的所有相對連結都會根據文檔結構計畫進行驗證，以防止出現無效連結。這確保了所有內部導覽都能如預期般運作。檢查器會忽略外部連結（以 `http://` 或 `https://` 開頭）和 `mailto:` 連結。
+## Markdown 與內容結構驗證
 
-- **圖片驗證**：為避免圖片損壞，檢查器會驗證文檔中引用的任何本地圖片檔案是否存在於檔案系統中。它會解析相對和絕對路徑，以確認檔案存在。外部圖片 URL 和資料 URL 不會被檢查。
+品質保證的基礎是確保核心 Markdown 格式正確且結構健全。DocSmith 採用一個基於 `remark-lint` 的精密 linter，並輔以自訂檢查來捕捉常見的結構性問題。
 
-#### 圖表語法驗證
+主要的結構和格式檢查包括：
 
-- **D2 圖表**：DocSmith 透過嘗試將程式碼編譯成 SVG 圖片來驗證 D2 圖表語法。此過程能在語法錯誤導致圖形損壞前捕捉到它們。
+*   **有效的 Markdown 語法**：遵循標準 Markdown 和 GFM (GitHub Flavored Markdown) 規範。
+*   **標題完整性**：偵測同一文件內的重複標題、不正確的標題縮排，以及使用超過一個頂層標題 (H1) 等問題。
+*   **表格格式**：驗證表格結構是否正確，特別是檢查標頭、分隔線和資料列之間的欄位數量是否不匹配。
+*   **程式碼區塊完整性**：確保所有程式碼區塊都以 ``` 正確地開啟和關閉。它還會檢查程式碼區塊內可能影響渲染結果的不一致縮排。
+*   **內容完整性**：一個驗證步驟，透過檢查產生的內容是否以適當的標點符號結尾，來確保內容不會看似被截斷。
 
-#### 格式化與樣式強制執行
+## 連結與資源完整性
 
-- **表格格式化**：檢查表格的標頭、分隔線和資料行之間的欄位數量是否不匹配。此檢查可防止常見的表格渲染失敗。
+失效連結和遺失的圖片會降低使用者體驗。DocSmith 會執行檢查以驗證所有本地資源。
 
-- **Markdown 語法檢查**：內建的 linter 強制執行一致的 Markdown 結構。主要規則包括：
+*   **失效連結偵測**：系統會掃描所有相對 Markdown 連結，並驗證目標路徑是否對應到專案文件結構中定義的有效文件。此檢查可防止使用者在瀏覽文件時遇到「404 Not Found」錯誤。以 `http://` 或 `https://` 開頭的外部連結則不會被檢查。
+*   **本地圖片驗證**：對於所有透過 `![]()` 包含的本地圖片，驗證器會確認所引用的圖片檔案是否存在於指定路徑。這能確保最終的輸出成品中不會出現破損的圖片。
 
-| Rule ID | Description |
-|---|---|
-| `no-duplicate-headings` | 防止在同一部分中出現內容相同的多個標題。 |
-| `no-undefined-references` | 確保所有連結和圖片引用都已定義。 |
-| `no-unused-definitions` | 標記未使用的連結或圖片定義。 |
-| `no-heading-content-indent` | 不允許在標題內容前縮排。 |
-| `no-multiple-toplevel-headings` | 每個文件只允許一個頂層標題 (H1)。 |
-| `code-block-style` | 強制執行一致的程式碼區塊樣式（例如，使用反引號）。 |
+## D2 圖表驗證
 
-透過自動化這些檢查，DocSmith 維護了文檔的一致標準，確保最終輸出準確且易於導覽。
+為保證所有圖表都能正確渲染，DocSmith 會驗證每個 D2 圖表的語法。
 
-若要了解更多關於整體架構的資訊，請參閱 [運作方式](./advanced-how-it-works.md) 部分。
+每個標記為 `d2` 的程式碼區塊都會經過嚴格的語法檢查器處理。若發現任何語法錯誤，產生過程將會被中止，並顯示一則描述性的錯誤訊息。這可以防止發布含有破損或渲染不當的視覺圖表的文件。

package/docs/advanced-quality-assurance.zh.md

@@ -1,96 +1,92 @@
 # 质量保证
 
-为确保所有生成的文档功能正常、清晰且专业，DocSmith 引入了自动化的质量保证流程。该流程在发布前对 Markdown 内容执行一系列检查，以检测和报告常见问题，从损坏的链接到格式错误的图表。
+为确保所有生成的文档都符合高质量、一致性和准确性的标准，DocSmith 包含一个全面的自动化质量保证流程。这些内置检查会自动运行，以在发布前识别并标记常见的格式错误、断开的链接和结构性问题。此过程保证最终输出专业、可靠且易于用户浏览。
 
-这个自动化管道会验证内容结构、链接、媒体和语法，以保持一致的质量标准。
-
-```d2
+```d2 质量保证流程 icon=lucide:shield-check
 direction: down
 
-Input-Markdown-Content: {
-  label: "输入：Markdown 内容"
+Documentation-Content: {
+  label: "文档内容"
   shape: rectangle
 }
 
-QA-Pipeline: {
-  label: "质量保证管道"
+Quality-Assurance-Pipeline: {
+  label: "质量保证流程"
   shape: rectangle
-  grid-columns: 1
+  grid-columns: 3
   grid-gap: 50
 
-  Structural-Checks: {
-    label: "结构检查"
+  Markdown-Validation: {
+    label: "1. Markdown 和内容验证\n（基于 remark-lint）"
     shape: rectangle
-    grid-columns: 2
-    Completeness: "确保内容不被截断"
-    Code-Blocks: "验证块语法和缩进"
+
+    Check-1: "有效的 Markdown 语法"
+    Check-2: "标题完整性"
+    Check-3: "表格格式"
+    Check-4: "代码块完整性"
+    Check-5: "内容完整性"
   }
 
-  Content-Validation: {
-    label: "内容验证"
+  Link-Asset-Validation: {
+    label: "2. 链接和资产完整性"
     shape: rectangle
-    grid-columns: 2
-    Link-Integrity: "验证内部链接"
-    Image-Paths: "检查本地图片是否存在"
-    Table-Formatting: "匹配列数"
+
+    Check-6: "死链检测"
+    Check-7: "本地图片验证"
   }
 
-  Syntax-Validation: {
-    label: "语法验证"
+  D2-Diagram-Validation: {
+    label: "3. D2 图表验证"
     shape: rectangle
-    grid-columns: 2
-    D2-Diagrams: "验证 D2 语法"
-    Markdown-Linting: "强制执行样式规则"
+
+    Check-8: "D2 语法检查"
   }
 }
 
-Output-Validated-Content-or-Error-Report: {
-  label: "输出：已验证内容或错误报告"
-  shape: rectangle
+Validation-Result: {
+  label: "所有检查是否通过？"
+  shape: diamond
 }
 
-Input-Markdown-Content -> QA-Pipeline
-QA-Pipeline -> Output-Validated-Content-or-Error-Report
-```
-
-### 核心验证领域
-
-DocSmith 的质量保证流程涵盖了几个关键领域，以确保文档的完整性。
-
-#### 内容结构与完整性
-
-DocSmith 执行多项检查以确保内容的结构完整性：
+Published-Documentation: {
+  label: "已发布的文档"
+  shape: rectangle
+  style.fill: "#d4edda"
+}
 
-- **不完整的代码块**：检测以 ` ``` ` 开始但未关闭的代码块。
-- **缺少换行符**：识别出现在单行上的内容，这可能表示缺少换行符。
-- **内容结尾**：验证内容是否以适当的标点符号（例如 `.`、`)`、`|`、`>`）结尾，以防止输出被截断。
-- **代码块缩进**：分析代码块中不一致的缩进。如果某行代码的缩进小于起始的 ` ``` ` 标记，可能会导致渲染问题。此检查有助于保持正确的代码呈现。
+Error-Report: {
+  label: "错误报告"
+  shape: rectangle
+  style.fill: "#f8d7da"
+}
 
-#### 链接与媒体完整性
+Documentation-Content -> Quality-Assurance-Pipeline: "输入"
+Quality-Assurance-Pipeline -> Validation-Result: "验证"
+Validation-Result -> Published-Documentation: "是"
+Validation-Result -> Error-Report: "否"
+```
 
-- **链接完整性**：文档中的所有相对链接都会根据文档结构计划进行验证，以防止出现死链接。这确保了所有内部导航都能正常工作。检查器会忽略外部链接（以 `http://` 或 `https://` 开头）和 `mailto:` 链接。
+## Markdown 和内容结构验证
 
-- **图片验证**：为避免图片损坏，检查器会验证文档中引用的任何本地图片文件是否存在于文件系统中。它会解析相对路径和绝对路径以确认文件存在。外部图片 URL 和数据 URL 不会被检查。
+质量保证的基础是确保核心 Markdown 格式良好且结构合理。DocSmith 采用基于 `remark-lint` 的精密 linter，并辅以自定义检查来捕获常见的结构性问题。
 
-#### 图表语法验证
+关键的结构和格式检查包括：
 
-- **D2 图表**：DocSmith 通过尝试将代码编译成 SVG 图片来验证 D2 图表语法。这个过程可以在语法错误导致图形损坏之前捕获它们。
+*   **有效的 Markdown 语法**：遵循标准 Markdown 和 GFM（GitHub Flavored Markdown）规范。
+*   **标题完整性**：检测同一文档中重复的标题、不正确的标题缩进以及使用多个顶级标题（H1）等问题。
+*   **表格格式**：验证表格结构是否正确，特别是检查表头、分隔行和数据行之间的列数是否不匹配。
+*   **代码块完整性**：确保所有代码块都使用 ``` 正确地开始和结束。它还会检查代码块内不一致的缩进，这可能会影响渲染。
+*   **内容完整性**：一个验证步骤，通过检查生成的内容是否以适当的标点符号结尾，来确保内容没有被截断。
 
-#### 格式与样式强制执行
+## 链接和资产完整性
 
-- **表格格式化**：检查表格的表头、分隔线和数据行之间的列数是否不匹配。此检查可防止常见的表格渲染失败。
+断开的链接和缺失的图片会降低用户体验。DocSmith 会执行检查以验证所有本地资源。
 
-- **Markdown 语法检查**：内置的 linter 会强制执行一致的 Markdown 结构。关键规则包括：
+*   **死链检测**：系统会扫描所有相对 Markdown 链接，并验证目标路径是否对应于项目文档结构中定义的有效文档。此检查可防止用户在浏览文档时遇到“404 Not Found”错误。以 `http://` 或 `https://` 开头的外部链接不会被检查。
+*   **本地图片验证**：对于所有通过 `![]()` 包含的本地图片，验证器会确认引用的图片文件是否存在于指定路径。这可以确保最终输出中不会出现损坏的图片。
 
-| Rule ID | Description |
-|---|---|
-| `no-duplicate-headings` | 防止在同一部分中出现内容相同的多个标题。 |
-| `no-undefined-references` | 确保所有链接和图片引用都已定义。 |
-| `no-unused-definitions` | 标记未被使用的链接或图片定义。 |
-| `no-heading-content-indent` | 禁止在标题内容前缩进。 |
-| `no-multiple-toplevel-headings` | 每个文档只允许一个顶级标题 (H1)。 |
-| `code-block-style` | 强制代码块使用一致的样式（例如，使用反引号）。 |
+## D2 图表验证
 
-通过自动化这些检查，DocSmith 为文档维护了一致的标准，确保最终输出准确且易于导航。
+为保证所有图表都能正确渲染，DocSmith 会验证每个 D2 图表的语法。
 
-要了解有关整体架构的更多信息，请参阅[工作原理](./advanced-how-it-works.md)部分。
+每个标记为 `d2` 的代码块都会经过严格的语法检查器处理。如果发现任何语法错误，生成过程将停止并显示描述性错误消息。这可以防止发布包含损坏或渲染不当的可视图表的文档。

package/docs/advanced.ja.md

@@ -1,16 +1,20 @@
 # 高度なトピック
 
-内部の仕組みを理解したいユーザー向けに、このセクションではAIGNE DocSmithのアーキテクチャを詳しく解説します。このツールが舞台裏でどのように機能するのかを説明します。このレベルの詳細は一般的な使用には必要ありませんが、動作のカスタマイズやプロジェクトへの貢献に役立ちます。
+このセクションでは、AIGNE DocSmithの内部アーキテクチャと動作メカニズムについて詳しく説明します。このセクションは、ツールの機能についてより深く理解したいユーザーを対象としており、高度なカスタマイズやプロジェクトへの貢献に役立ちます。この情報は、標準的な使用には必要ありません。
 
-内部プロセスと品質管理についてより深く理解するために、以下のセクションをご覧ください。
+DocSmithは、AIアプリケーション開発のプラットフォームを提供するAIGNEエコシステムのコンポーネントです。次の図は、全体のアーキテクチャを示しています。
+
+![AIGNEエコシステムのアーキテクチャ](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
+
+DocSmith内の特定のプロセスと品質管理手段については、以下の詳細なセクションを参照してください。
 
 <x-cards data-columns="2">
   <x-card data-title="仕組み" data-href="/advanced/how-it-works" data-icon="lucide:cpu">
     DocSmithのアーキテクチャ概要。ドキュメント生成パイプラインにおけるAI Agentの役割を説明します。
   </x-card>
   <x-card data-title="品質保証" data-href="/advanced/quality-assurance" data-icon="lucide:shield-check">
-    リンクチェックや図の検証など、整形されエラーのないドキュメントを保証するためにDocSmithが実行する組み込みのチェックについて理解します。
+    リンクチェックやダイアグラム検証など、適切にフォーマットされエラーのないドキュメントを保証するためにDocSmithが実行する組み込みチェックについて理解します。
   </x-card>
 </x-cards>
 
-これらのトピックを探求することで、DocSmithの機能についてより完全に理解することができます。利用可能なすべてのコマンドとそのオプションの詳細については、[CLIコマンドリファレンス](./cli-reference.md)に進んでください。
+これらのトピックを確認することで、DocSmithの機能を包括的に理解することができます。利用可能なすべてのコマンドとそのパラメータの完全なリファレンスについては、[CLIコマンドリファレンス](./cli-reference.md)を参照してください。

package/docs/advanced.md

@@ -1,8 +1,12 @@
 # Advanced Topics
 
-For users who wish to understand the internal mechanics, this section provides a deeper look into the architecture of AIGNE DocSmith. It explains how the tool functions behind the scenes. While this level of detail is not required for general use, it can be valuable for customizing behavior or contributing to the project.
+This section provides a detailed examination of the internal architecture and operational mechanics of AIGNE DocSmith. It is intended for users who wish to gain a deeper understanding of how the tool functions, which can be beneficial for advanced customization or contributing to the project. This information is not required for standard use.
 
-To better understand the internal processes and quality controls, explore the following sections.
+DocSmith is a component of the AIGNE ecosystem, which provides a platform for AI application development. The following diagram illustrates the overall architecture.
+
+![AIGNE Ecosystem Architecture](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
+
+To explore the specific processes and quality control measures within DocSmith, refer to the following detailed sections.
 
 <x-cards data-columns="2">
   <x-card data-title="How It Works" data-href="/advanced/how-it-works" data-icon="lucide:cpu">
@@ -13,4 +17,4 @@ To better understand the internal processes and quality controls, explore the fo
   </x-card>
 </x-cards>
 
-By exploring these topics, you can gain a more complete understanding of DocSmith's capabilities. For a detailed breakdown of all available commands and their options, proceed to the [CLI Command Reference](./cli-reference.md).
+By reviewing these topics, you can develop a comprehensive understanding of DocSmith's functionality. For a complete reference of all available commands and their parameters, please see the [CLI Command Reference](./cli-reference.md).

package/docs/advanced.zh-TW.md

@@ -1,16 +1,20 @@
 # 進階主題
 
-對於希望了解內部機制的用戶，本節將深入探討 AIGNE DocSmith 的架構，說明該工具在幕後的運作方式。雖然一般使用不需要了解這些細節，但對於自訂行為或為專案做出貢獻，這些資訊將會很有價值。
+本節詳細介紹 AIGNE DocSmith 的內部架構和運作機制。它專為希望深入了解該工具如何運作的使用者而設計，這對於進階自訂或為專案做出貢獻非常有益。標準使用不需要這些資訊。
 
-為了更深入了解內部流程和品質控制，請探索以下章節。
+DocSmith 是 AIGNE 生態系的一個元件，該生態系為 AI 應用程式開發提供了一個平台。下圖說明了整體架構。
+
+![AIGNE 生態系架構](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
+
+若要探索 DocSmith 內的具體流程和品質控制措施，請參閱以下詳細章節。
 
 <x-cards data-columns="2">
   <x-card data-title="運作方式" data-href="/advanced/how-it-works" data-icon="lucide:cpu">
-    DocSmith 的架構概覽，解釋了 AI Agent 在文件產生流程中的角色。
+    DocSmith 的架構概覽，解釋 AI agent 在文件生成流程中的角色。
   </x-card>
   <x-card data-title="品質保證" data-href="/advanced/quality-assurance" data-icon="lucide:shield-check">
-    了解 DocSmith 執行的內建檢查，以確保文件格式良好且無錯誤，包括連結檢查和圖表驗證。
+    了解 DocSmith 執行的內建檢查，以確保文件格式正確且無錯誤，包括連結檢查和圖表驗證。
   </x-card>
 </x-cards>
 
-透過探索這些主題，您可以更全面地了解 DocSmith 的功能。若需所有可用指令及其選項的詳細說明，請參閱 [CLI 指令參考](./cli-reference.md)。
+透過回顧這些主題，您可以全面了解 DocSmith 的功能。有關所有可用指令及其參數的完整參考，請參閱 [CLI 指令參考](./cli-reference.md)。

package/docs/advanced.zh.md

@@ -1,16 +1,20 @@
 # 高级主题
 
-对于希望了解内部机制的用户，本节将深入探讨 AIGNE DocSmith 的架构。它解释了该工具在幕后如何运作。虽然对于一般使用而言，不需要了解这种程度的细节，但它对于自定义行为或为项目做出贡献非常有价值。
+本节详细阐述了 AIGNE DocSmith 的内部架构和运行机制。本节面向希望深入了解该工具工作原理的用户，这对于高级定制或为项目做出贡献大有裨益。标准使用无需了解这些信息。
 
-要更好地了解内部流程和质量控制，请浏览以下部分。
+DocSmith 是 AIGNE 生态系统的一个组件，该生态系统为 AI 应用开发提供了一个平台。下图展示了其整体架构。
+
+![AIGNE 生态系统架构](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
+
+要了解 DocSmith 内部的具体流程和质量控制措施，请参阅以下详细章节。
 
 <x-cards data-columns="2">
   <x-card data-title="工作原理" data-href="/advanced/how-it-works" data-icon="lucide:cpu">
-    DocSmith 的架构概述，解释了 AI agents 在文档生成管道中的作用。
+    DocSmith 的架构概述，解释了 AI Agent 在文档生成流程中的作用。
   </x-card>
   <x-card data-title="质量保证" data-href="/advanced/quality-assurance" data-icon="lucide:shield-check">
-    了解 DocSmith 执行的内置检查，以确保文档格式良好且无错误，包括链接检查和图表验证。
+    了解 DocSmith 为确保文档格式正确、无错误而执行的内置检查，包括链接检查和图表验证。
   </x-card>
 </x-cards>
 
-通过探索这些主题，您可以更全面地了解 DocSmith 的功能。有关所有可用命令及其选项的详细分解，请继续阅读 [CLI 命令参考](./cli-reference.md)。
+通过阅读这些主题，您可以全面了解 DocSmith 的功能。有关所有可用命令及其参数的完整参考，请参阅 [CLI 命令参考](./cli-reference.md)。