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

package/docs/overview.zh-TW.md

@@ -1,82 +1,61 @@
 # 總覽
 
-AIGNE DocSmith 是一款由 AI 驅動的工具，可直接從您的原始程式碼生成文件。它基於 [AIGNE 框架](https://www.aigne.io/en/framework) 建構，能自動化建立結構化、多語言的文件。此過程減少了手動編寫和維護文件的工作量，確保文件與程式碼庫保持同步。
+AIGNE DocSmith 是一個利用人工智慧從專案原始碼自動建立文件的工具。它建立在 AIGNE 框架之上，旨在產出能準確反映您程式碼庫的結構化、多語言文件。
 
-下圖說明了 DocSmith 的高階工作流程：
+DocSmith 的主要目標是解決手動撰寫文件時的常見挑戰，例如耗時、因程式碼變更而過時，以及缺乏一致性。透過自動化此流程，DocSmith 有助於確保您的文件保持最新和準確。
 
-```d2
-direction: right
-style: {
-  font-size: 14
-}
+## 運作方式
 
-# 參與者
-source_code: "原始程式碼儲存庫" {
-  shape: cloud
-  style: {
-    fill: "#F0F4F8"
-    stroke: "#4A5568"
-  }
-}
+DocSmith 透過分析您的專案原始碼來理解其結構、元件和功能。基於此分析，它會生成一套完整的文件，從高階指南到詳細的 API 參考資料。
 
-docsmith: "AIGNE DocSmith 引擎" {
-  shape: hexagon
-  style: {
-    fill: "#E6FFFA"
-    stroke: "#2C7A7B"
-  }
+```d2
+direction: down
+
+Source-Code: {
+  label: "專案原始碼"
+  shape: rectangle
 }
 
-published_docs: "已發佈文件" {
-  shape: document
-  style: {
-    fill: "#FEFCBF"
-    stroke: "#B7791F"
-  }
+DocSmith: {
+  label: "AIGNE DocSmith\n(AI 分析引擎)"
+  shape: rectangle
 }
 
-# 主要流程
-source_code -> docsmith: "1. 分析程式碼"
-docsmith -> published_docs: "2. 生成與發佈"
-
-# DocSmith 內部流程
-subflow: {
-  direction: down
-  
-  analyze: "分析與規劃結構"
-  generate: "生成內容"
-  translate: "翻譯（選用）"
-  publish: "發佈"
-  
-  analyze -> generate -> translate -> publish
+Docs: {
+  label: "生成的文件"
+  shape: rectangle
 }
 
-docsmith.subflow: subflow
+Source-Code -> DocSmith: "分析"
+DocSmith -> Docs: "生成"
 ```
 
 ## 核心功能
 
-DocSmith 提供一系列功能來自動化並簡化文件製作過程：
-
-*   **結構規劃：** 分析程式碼庫以生成邏輯性的文件結構。
-*   **內容生成：** 用從原始程式碼生成的內容填充已規劃的文件結構。
-*   **多語言支援：** 將文件翻譯成 12 種語言，包括英文、中文和西班牙文。
-*   **AIGNE Hub 整合：** 使用 [AIGNE Hub](https://www.aigne.io/en/hub)，該服務提供對各種大型語言模型（LLMs）的存取，例如來自 Google、OpenAI 和 Anthropic 的模型，讓您無需管理個別的 API 金鑰即可切換模型。
-*   **一鍵發佈：** 透過可分享的連結讓您的文件上線。您可以發佈到官方平台，或使用 [Discuss Kit](https://www.web3kit.rocks/discuss-kit) 運行您自己的實例。
-*   **迭代更新：** 偵測原始程式碼的變更以更新文件，並支援根據使用者回饋對特定文件進行針對性地重新生成。
-
-## AIGNE 生態系的一部分
+DocSmith 提供一系列功能來處理從建立到發布的整個文件生命週期。
 
-DocSmith 是 [AIGNE](https://www.aigne.io) 生態系的一個組件，該生態系是一個用於開發 AI 應用程式的平台。它與其他 AIGNE 組件整合，以利用該平台的人工智慧能力和基礎設施。
+*   **AI 驅動生成**：分析您的程式碼庫以提出合乎邏輯的文件結構，並生成解釋程式碼功能的內容。
+*   **多語言支援**：將文件翻譯成 12 種語言，包括英文、簡體中文和日文。翻譯過程會感知上下文，以保持技術準確性。
+*   **與大型語言模型 (LLM) 整合**：可連接各種大型語言模型 (LLM)。預設情況下，它使用 [AIGNE Hub](https://www.aigne.io/en/hub)，這項服務讓您可以在 Google Gemini 和 OpenAI GPT 等模型之間切換，而無需獨立的 API 金鑰。您也可以設定自己的 API 金鑰以直接存取供應商。
+*   **智慧更新**：偵測原始碼中的變更，並更新文件的相應部分。您也可以提供具體的回饋來完善生成的內容。
+*   **發布選項**：只需一個指令即可發布您生成的文件。您可以部署到官方的 DocSmith 平台，或您自己的 [Discuss Kit](https://www.web3kit.rocks/discuss-kit) 實例。Discuss Kit 是一項用於託管和展示文件的服務。
 
-下圖顯示了 DocSmith 如何融入 AIGNE 架構中：
+## 可用指令
 
-![AIGNE 生態系架構](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
+DocSmith 透過一系列指令進行操作。下表總結了主要指令及其功能。
 
-## 後續步驟
+| Command | Description |
+| :--- | :--- |
+| `generate` | 從您的原始檔案建立一套新的文件。 |
+| `update` | 根據程式碼變更或新的回饋修改現有文件。 |
+| `translate` | 將文件翻譯成 12 種支援語言中的一種或多種。 |
+| `publish` | 將您的文件部署到一個可公開存取的即時 URL。 |
+| `evaluate` | 評估您所生成文件的品質與完整性。 |
+| `history` | 檢視文件的更新歷史記錄。 |
+| `chat` | 啟動一個互動式聊天會話，以協助處理文件任務。 |
+| `clear` | 移除生成檔案、配置和快取資料。 |
+| `prefs` | 管理用於文件生成的已儲存偏好設定和配置。 |
 
-若要開始使用 DocSmith，請參閱安裝與設定指南。
+---
 
-<x-card data-title="下一步：入門指南" data-href="/getting-started" data-icon="lucide:arrow-right-circle" data-cta="開始指南">
-遵循逐步指南來安裝工具、設定您的第一個專案並生成文件。
-</x-card>
+本總覽提供了 AIGNE DocSmith 用途和功能的高階摘要。若要開始使用此工具，請前往 [快速入門](./getting-started.md) 指南以取得安裝和設定說明。

package/docs/overview.zh.md

@@ -1,82 +1,61 @@
 # 概述
 
-AIGNE DocSmith 是一款 AI 驱动的工具，可直接从您的源代码生成文档。它基于 [AIGNE 框架](https://www.aigne.io/en/framework) 构建，能够自动化创建结构化、多语言的文档。此过程减少了编写和维护文档的人工工作，确保文档与代码库保持同步。
+AIGNE DocSmith 是一款利用人工智能从项目源代码自动创建文档的工具。它基于 AIGNE 框架构建，旨在生成能够准确反映代码库的结构化、多语言文档。
 
-下图说明了 DocSmith 的高级工作流程：
+DocSmith 的主要目标是解决手动编写文档时面临的常见挑战，例如耗时、代码变更后内容过时以及缺乏一致性。通过自动化此过程，DocSmith 有助于确保您的文档保持最新和准确。
 
-```d2
-direction: right
-style: {
-  font-size: 14
-}
+## 工作原理
 
-# Actors
-source_code: "源代码仓库" {
-  shape: cloud
-  style: {
-    fill: "#F0F4F8"
-    stroke: "#4A5568"
-  }
-}
+DocSmith 通过分析项目的源代码来理解其结构、组件和功能。基于此分析，它会生成一套完整的文档，从高级指南到详细的 API 参考手册。
 
-docsmith: "AIGNE DocSmith 引擎" {
-  shape: hexagon
-  style: {
-    fill: "#E6FFFA"
-    stroke: "#2C7A7B"
-  }
+```d2
+direction: down
+
+Source-Code: {
+  label: "项目源代码"
+  shape: rectangle
 }
 
-published_docs: "已发布的文档" {
-  shape: document
-  style: {
-    fill: "#FEFCBF"
-    stroke: "#B7791F"
-  }
+DocSmith: {
+  label: "AIGNE DocSmith\n（AI 分析引擎）"
+  shape: rectangle
 }
 
-# Main Flow
-source_code -> docsmith: "1. 分析代码"
-docsmith -> published_docs: "2. 生成并发布"
-
-# DocSmith Internal Process
-subflow: {
-  direction: down
-  
-  analyze: "分析并规划结构"
-  generate: "生成内容"
-  translate: "翻译（可选）"
-  publish: "发布"
-  
-  analyze -> generate -> translate -> publish
+Docs: {
+  label: "生成的文档"
+  shape: rectangle
 }
 
-docsmith.subflow: subflow
+Source-Code -> DocSmith: "分析"
+DocSmith -> Docs: "生成"
 ```
 
 ## 核心功能
 
-DocSmith 提供了一系列功能来自动化和简化文档流程：
-
-*   **结构规划：** 分析代码库以生成逻辑化的文档结构。
-*   **内容生成：** 使用从源代码生成的内容填充规划好的文档结构。
-*   **多语言支持：** 可将文档翻译成 12 种语言，包括英语、中文和西班牙语。
-*   **AIGNE Hub 集成：** 使用 [AIGNE Hub](https://www.aigne.io/en/hub)，该服务提供对各种大语言模型 (LLM) 的访问，例如来自 Google、OpenAI 和 Anthropic 的模型，允许切换模型而无需管理各个 API 密钥。
-*   **一键发布：** 通过可共享的链接发布您的文档。您可以发布到官方平台，也可以使用 [Discuss Kit](https://www.web3kit.rocks/discuss-kit) 运行您自己的实例。
-*   **迭代更新：** 检测源代码变更以更新文档，并支持根据用户反馈对特定文档进行定向重新生成。
-
-## AIGNE 生态系统的一部分
+DocSmith 提供了一系列功能来处理从创建到发布的整个文档生命周期。
 
-DocSmith 是 [AIGNE](https://www.aigne.io) 生态系统的一个组件，该生态系统是一个用于开发 AI 应用程序的平台。它与其他 AIGNE 组件集成，以利用该平台的人工智能能力和基础设施。
+*   **AI 驱动生成**：分析您的代码库，提出逻辑化的文档结构，并生成解释代码功能的内容。
+*   **多语言支持**：可将文档翻译成 12 种语言，包括英语、简体中文和日语。翻译过程具备上下文感知能力，以保持技术准确性。
+*   **与 LLM 集成**：可连接各种大型语言模型（LLM）。默认情况下，它使用 [AIGNE Hub](https://www.aigne.io/en/hub)，该服务允许您在 Google Gemini 和 OpenAI GPT 等模型之间切换，而无需单独的 API 密钥。您也可以配置自己的 API 密钥以直接访问提供商。
+*   **智能更新**：检测源代码中的变更，并更新文档的相应部分。您还可以提供具体反馈以优化生成的内容。
+*   **发布选项**：通过单个命令即可发布您生成的文档。您可以将其部署到官方 DocSmith 平台，也可以部署到您自己的 [Discuss Kit](https://www.web3kit.rocks/discuss-kit) 实例。Discuss Kit 是一项用于托管和展示文档的服务。
 
-下图展示了 DocSmith 如何融入 AIGNE 架构：
+## 可用命令
 
-![AIGNE 生态系统架构](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
+DocSmith 通过一组命令进行操作。下表总结了主要命令及其功能。
 
-## 后续步骤
+| 命令 | 描述 |
+| :--- | :--- |
+| `generate` | 从源文件创建一套新的文档。 |
+| `update` | 根据代码变更或新的反馈修改现有文档。 |
+| `translate` | 将文档翻译成 12 种支持的语言中的一种或多种。 |
+| `publish` | 将您的文档部署到一个可实时访问的 URL。 |
+| `evaluate` | 评估所生成文档的质量和完整性。 |
+| `history` | 查看文档的更新历史。 |
+| `chat` | 启动一个交互式聊天会话，以协助完成文档任务。 |
+| `clear` | 删除生成的文件、配置和缓存数据。 |
+| `prefs` | 管理用于文档生成的已保存偏好和配置。 |
 
-要开始使用 DocSmith，请继续阅读安装和配置指南。
+---
 
-<x-card data-title="下一步：开始使用" data-href="/getting-started" data-icon="lucide:arrow-right-circle" data-cta="开始阅读指南">
-按照分步指南安装工具、配置您的第一个项目并生成文档。
-</x-card>
+本概述简要介绍了 AIGNE DocSmith 的用途和功能。要开始使用该工具，请参阅 [快速入门](./getting-started.md) 指南以获取安装和设置说明。

package/docs/release-notes.ja.md

@@ -0,0 +1,255 @@
+# リリースノート
+
+このドキュメントでは、各バージョンの新機能、改善点、バグ修正の概要を説明します。すべての変更は、新しいものから順に記載されています。
+
+## バージョン 0.8.12-beta.3 (2025-10-09)
+
+### バグ修正
+
+- クラウドへの公開時に、誤って管理者権限が要求される問題を解決しました。
+
+## バージョン 0.8.12-beta.2 (2025-10-09)
+
+### バグ修正
+
+- ドキュメント更新時のファイルパスに関するエラーを修正しました。
+- ドキュメントの生成と更新が失敗する可能性があった問題を修正しました。
+
+## バージョン 0.8.12-beta.1 (2025-10-08)
+
+### 新機能
+
+- 履歴追跡機能を導入し、ドキュメントの過去の変更を表示できるようになりました。
+- ドキュメント更新プロセスにおいて、翻訳がオプションのステップとなり、柔軟性が向上しました。
+
+### 改善
+
+- ドキュメントの生成と更新プロセスを改良し、信頼性を向上させました。
+
+## バージョン 0.8.12-beta (2025-10-07)
+
+### バグ修正
+
+- 内部のファイル読み取りツールが、相対パスを正しくサポートするようになりました。
+
+## バージョン 0.8.11 (2025-10-05)
+
+このバージョンには、全般的なメンテナンスと安定性の向上が含まれています。
+
+## バージョン 0.8.11-beta.7 (2025-10-03)
+
+### 新機能
+
+- ドキュメントジェネレーターとアップデーターを強化し、パフォーマンスを向上させました。
+- 共有コンテキストを使用することで、ドキュメント構造の分析とコンテンツの改良の速度を向上させました。
+
+### バグ修正
+
+- 内部ドキュメントを更新し、カスタムコンポーネントのプロンプトを改良して精度を向上させました。
+
+## バージョン 0.8.11-beta.5 (2025-10-01)
+
+### 新機能
+
+- 公開時のユーザーロール要件とカスタムルール設定のサポートを追加しました。
+- D2ダイアグラムの生成を独立したツールに分離し、機能をより集中させました。
+
+## バージョン 0.8.11-beta.4 (2025-09-30)
+
+### 新機能
+
+- 選択入力を使用する Agent に「チェックのみ」オプションを追加しました。
+
+### バグ修正
+
+- ドキュメント選択ユーティリティのエラーハンドリングを改善しました。
+- 翻訳プロンプトを調整し、コードブロック内のコメントが正しく翻訳されるようになりました。
+
+## バージョン 0.8.11-beta.3 (2025-09-29)
+
+### バグ修正
+
+- 評価 Agent のためのコマンドラインエントリーを追加しました。
+
+## バージョン 0.8.11-beta.2 (2025-09-27)
+
+### バグ修正
+
+- 依存関係の競合を解決し、よりスムーズな動作を保証しました。
+
+## バージョン 0.8.11-beta.1 (2025-09-27)
+
+### 新機能
+
+- 品質レポートを生成するためのドキュメント評価機能を導入しました。
+- 改善されたツールでドキュメントと構造の更新プロセスを強化しました。
+- 公開プロセス中のベンダー処理とデバッグ機能を改善しました。
+
+### バグ修正
+
+- コンポーネントの説明がテキストではなく属性として扱われる問題を修正し、カスタムコンポーネントのレンダリングを改善しました。
+
+## バージョン 0.8.10 (2025-09-20)
+
+このバージョンには、全般的なメンテナンスと安定性の向上が含まれています。
+
+## バージョン 0.8.10-beta.3 (2025-09-19)
+
+### バグ修正
+
+- エンタープライズデプロイメントに関連するリンクを追加しました。
+- ドキュメントレビュープロンプトのコピーライティングを洗練しました。
+
+## バージョン 0.8.10-beta.2 (2025-09-18)
+
+### バグ修正
+
+- ドキュメント構造レビューのプロンプトと表示を改善しました。
+- 正しいレンダリングを保証するために、フィールド要素の使用ルールを更新しました。
+
+## バージョン 0.8.10-beta.1 (2025-09-18)
+
+### 新機能
+
+- 生成前にドキュメント構造をレビューするワークフローを追加しました。
+
+### バグ修正
+
+- ユーザーインターフェースにおける英語テキストの一貫性と明確性を向上させました。
+- DocSmithのロゴを更新しました。
+
+## バージョン 0.8.9 (2025-09-15)
+
+### バグ修正
+
+- 視覚的な一貫性を高めるため、D2ダイアグラムのテーマカラーを更新しました。
+
+## バージョン 0.8.8 (2025-09-13)
+
+### バグ修正
+
+- 問い合わせフィードバックのコピーを最適化し、より明確で役立つものにしました。
+
+## バージョン 0.8.7 (2025-09-12)
+
+### 新機能
+
+- `<x-field>` カスタムコンポーネントを使用したAPIパラメータの定義をサポートしました。
+
+## バージョン 0.8.6 (2025-09-11)
+
+### 新機能
+
+- 公開プロセスが成功した後、デフォルトでURLが表示されるようになりました。
+
+### バグ修正
+
+- デプロイメントプロセス中にログが正しく保存され、データ損失を防ぐようにしました。
+
+## バージョン 0.8.5 (2025-09-10)
+
+### 新機能
+
+- エンタープライズスペースへのドキュメント公開をサポートしました。
+
+## バージョン 0.8.4 (2025-09-09)
+
+### バグ修正
+
+- Markdownのコードブロックが、タイトルやアイコンなどの拡張属性をサポートするカスタム`<x-code>`要素に解析されるようになりました。
+- D2ダイアグラムの背景を透明にし、異なるテーマとの統合性を向上させました。
+
+## バージョン 0.8.3 (2025-09-05)
+
+### バグ修正
+
+- ローカル画像の寸法を自動検出し、正しく表示されるようにしました。
+
+## バージョン 0.8.1 (2025-09-03)
+
+### 新機能
+
+- より包括的な例を用いてD2チャート生成を調整し、出力品質を向上させました。
+
+## バージョン 0.8.0 (2025-09-03)
+
+### 新機能
+
+- カスタムコンポーネントのガイドラインを更新し、新しいフォーマット制限を追加しました。
+
+## バージョン 0.7.1 (2025-08-31)
+
+### バグ修正
+
+- パス選択にタブキーを使用すると期待通りに動作しないバグを修正しました。
+
+## バージョン 0.7.0 (2025-08-30)
+
+### 新機能
+
+- ドキュメントの生成と管理のための対話型チャットモードを追加しました。
+- ドキュメントの生成と公開ワークフローにD2チャートのサポートを導入しました。
+- カスタムコンポーネントと、より堅牢な設定処理をサポートしました。
+
+## バージョン 0.6.0 (2025-08-27)
+
+### 新機能
+
+- ドキュメント公開前のメディア処理を完全にサポートしました。
+
+## バージョン 0.5.0 (2025-08-26)
+
+### 新機能
+
+- ユーザーフィードバックを永続的な設定として保存し、将来のセッションで利用できるようになりました。
+
+### バグ修正
+
+- 初期設定プロセスで尋ねられる質問のテキストを洗練しました。
+
+## バージョン 0.4.4 (2025-08-22)
+
+### バグ修正
+
+- 公開プロセス中にボードIDを割り当てるサポートを追加しました。
+
+## バージョン 0.4.1 (2025-08-21)
+
+### バグ修正
+
+- ボード情報の更新をサポートしました。
+
+## バージョン 0.4.0 (2025-08-20)
+
+### 新機能
+
+- ドキュメントを翻訳するための新しい`translate`コマンドを導入しました。
+
+## バージョン 0.3.0 (2025-08-19)
+
+### 新機能
+
+- ドキュメント生成中のコンテキスト収集ワークフローを洗練しました。
+
+### バグ修正
+
+- セルフホストのDiscuss Kitインスタンスを実行しているユーザー向けのヘルプテキストを最適化しました。
+
+## バージョン 0.2.11 (2025-08-15)
+
+### バグ修正
+
+- デフォルトの言語モデルを切り替え、生成品質を向上させました。
+
+## バージョン 0.2.5 (2025-08-08)
+
+### バグ修正
+
+- よりスムーズなユーザーエクスペリエンスのため、コマンドラインインターフェースのプロセスを洗練しました。
+
+## バージョン 0.2.0 (2025-08-05)
+
+### 新機能
+
+- コマンド実行時に設定が存在しない場合、ツールが自動的に設定を初期化するようになりました。
+- ソースファイルが変更されたときにドキュメントを更新するための新しい`update`コマンドを追加しました。