@aigne/doc-smith 0.2.5 → 0.2.8

package/agents/save-single-doc.mjs

@@ -1,3 +1,4 @@
+import { shutdownMermaidWorkerPool } from "../utils/mermaid-worker-pool.mjs";
 import { saveDocWithTranslations } from "../utils/utils.mjs";
 
 export default async function saveSingleDoc({
@@ -7,14 +8,32 @@ export default async function saveSingleDoc({
   translates,
   labels,
   locale,
+  isTranslate = false,
+  isShowMessage = false,
 }) {
-  const results = await saveDocWithTranslations({
+  const _results = await saveDocWithTranslations({
     path,
     content,
     docsDir,
     translates,
     labels,
     locale,
+    isTranslate,
   });
+
+  if (isShowMessage) {
+    // Shutdown mermaid worker pool to ensure clean exit
+    try {
+      await shutdownMermaidWorkerPool();
+    } catch (error) {
+      console.warn("Failed to shutdown mermaid worker pool:", error.message);
+    }
+
+    const message = isTranslate
+      ? `✅ Translation completed successfully`
+      : `✅ Document updated successfully`;
+    return { message };
+  }
+
   return {};
 }

package/agents/schema/structure-plan.yaml

@@ -8,7 +8,7 @@ items:
       type: string
     path:
       type: string
-      description: 路径，以 RUL 的格式返回，不能为空, 必须以 / 开头，不需要包含语言层级，比如 /zh/about 直接返回 /about
+      description: 路径，以 RUL 的格式返回，不能为空, 不能包含空格等特殊字符, 必须以 / 开头，不需要包含语言层级，比如 /zh/about 直接返回 /about
     parentId:
       type:
         - string

package/agents/structure-planning.yaml

@@ -36,6 +36,12 @@ input_schema:
 output_schema:
   type: object
   properties:
+    projectName:
+      type: string
+      description: 根据 DataSources 分析项目名称，注意是原始项目名称
+    projectDesc:
+      type: string
+      description: 根据 DataSources 分析生成当前项目描述，为原始项目生成描述，描述简洁，不超过 50 个单词
     structurePlan: ./schema/structure-plan.yaml
     structurePlanTree:
       type: string

package/agents/transform-detail-datasources.mjs

@@ -1,15 +1,12 @@
 import { normalizePath, toRelativePath } from "../utils/utils.mjs";
 
-export default function transformDetailDatasources({
-  sourceIds,
-  datasourcesList,
-}) {
+export default function transformDetailDatasources({ sourceIds, datasourcesList }) {
   // Build a map for fast lookup, with path normalization for compatibility
   const dsMap = Object.fromEntries(
     (datasourcesList || []).map((ds) => {
       const normalizedSourceId = normalizePath(ds.sourceId);
       return [normalizedSourceId, ds.content];
-    })
+    }),
   );
 
   // Collect formatted contents in order, with path normalization

package/agents/translate.yaml

@@ -14,6 +14,9 @@ input_schema:
     glossary:
       type: string
       description: 术语表
+    feedback:
+      type: string
+      description: Feedback for translation improvement
   required:
     - language
     - content

package/aigne.yaml

@@ -2,7 +2,8 @@
 
 chat_model:
   provider: google
-  name: gemini-2.5-pro
+  # name: gemini-2.5-pro
+  name: gemini-2.5-flash
   temperature: 0.8
 agents:
   - ./agents/structure-planning.yaml
@@ -28,6 +29,8 @@ agents:
   - ./agents/load-config.mjs
   - ./agents/team-publish-docs.yaml
   - ./agents/find-item-by-path.mjs
+  - ./agents/retranslate.yaml
+  - ./agents/language-selector.mjs
   - ./docs-mcp/get-docs-structure.mjs
   - ./docs-mcp/get-docs-detail.mjs
   - ./docs-mcp/docs-search.yaml
@@ -40,6 +43,7 @@ cli:
     - ./agents/docs-generator.yaml
     - ./agents/detail-regenerator.yaml
     - ./agents/team-publish-docs.yaml
+    - ./agents/retranslate.yaml
 mcp_server:
   agents:
     - ./docs-mcp/get-docs-structure.mjs

package/biome.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://biomejs.dev/schemas/2.1.2/schema.json",
+  "$schema": "https://biomejs.dev/schemas/2.1.4/schema.json",
   "vcs": {
     "enabled": true,
     "clientKind": "git",
@@ -23,11 +23,21 @@
         "noUnusedVariables": "error",
         "noUnusedImports": "error",
         "noUnusedFunctionParameters": "error",
-        "noUnusedPrivateClassMembers": "error"
+        "noUnusedPrivateClassMembers": "error",
+        "noUndeclaredVariables": "error",
+        "noUnreachable": "error",
+        "noSelfAssign": "error"
       },
       "suspicious": {
         "noConfusingVoidType": "off",
-        "noExplicitAny": "off"
+        "noExplicitAny": "off",
+        "noDoubleEquals": "error",
+        "noGlobalAssign": "error",
+        "noAssignInExpressions": "warn"
+      },
+      "style": {
+        "useNodejsImportProtocol": "error",
+        "useTemplate": "error"
       },
       "complexity": {
         "noForEach": "off",

package/docs-mcp/get-docs-structure.mjs

@@ -5,7 +5,7 @@ const structureDir = path.join(
   process.cwd(),
   "./.aigne/doc-smith",
   "output",
-  "structure-plan.json"
+  "structure-plan.json",
 );
 
 export default async function getDocsStructure() {

package/docs-mcp/read-doc-content.mjs

@@ -3,10 +3,7 @@ import path from "node:path";
 
 const docsDir = path.join(process.cwd(), "./.aigne/doc-smith", "docs");
 
-export default async function readDocContent({
-  relevantDocPaths,
-  docsDir: customDocsDir,
-}) {
+export default async function readDocContent({ relevantDocPaths, docsDir: customDocsDir }) {
   const targetDocsDir = customDocsDir || docsDir;
   const docContents = [];
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.2.5",
+  "version": "0.2.8",
   "description": "",
   "publishConfig": {
     "access": "public"
@@ -12,19 +12,32 @@
   "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
   "license": "MIT",
   "dependencies": {
-    "@aigne/anthropic": "^0.10.10",
-    "@aigne/cli": "^1.31.0",
-    "@aigne/core": "^1.46.0",
-    "@aigne/gemini": "^0.8.14",
-    "@aigne/openai": "^0.10.14",
-    "@aigne/publish-docs": "^0.5.3",
+    "@aigne/aigne-hub": "^0.4.9",
+    "@aigne/anthropic": "^0.11.0",
+    "@aigne/cli": "^1.34.0",
+    "@aigne/core": "^1.49.0",
+    "@aigne/gemini": "^0.9.0",
+    "@aigne/openai": "^0.11.0",
+    "@aigne/publish-docs": "^0.5.4",
     "chalk": "^5.5.0",
+    "dompurify": "^3.2.6",
     "glob": "^11.0.3",
+    "jsdom": "^26.1.0",
+    "mermaid": "^11.9.0",
     "open": "^10.2.0",
+    "remark-gfm": "^4.0.1",
+    "remark-lint": "^10.0.1",
+    "remark-parse": "^11.0.0",
     "terminal-link": "^4.0.0",
     "ufo": "^1.6.1",
+    "unified": "^11.0.5",
+    "unist-util-visit": "^5.0.0",
+    "vfile": "^6.0.3",
     "yaml": "^2.8.0"
   },
+  "devDependencies": {
+    "@biomejs/biome": "^2.1.4"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "lint": "biome check && pnpm -r run lint",

package/prompts/check-structure-planning-result.md

@@ -16,15 +16,13 @@
 - **用户反馈**:
 ```
 {{ feedback }}
-
-根据最新的 Data Sources 按需要更新节点的 sourceIds。
 ```
 </context>
 
 <goal>
-你的主要目标是验证两条关键规则：
+你的主要目标是验证三条关键规则：
 1.  **反馈的实现**：新的结构规划**必须**正确地实现用户反馈中要求的所有变更。
-2.  **无关节点的稳定性**：没有在用户反馈中被提及的节点 ** path 属性不能被修改 **。`path` 是关联现有内容的关键标识符，其稳定性至关重要。
+2.  **无关节点的稳定性**：没有在用户反馈中被提及的节点 ** path、sourcesIds 属性不能被修改 **。`path`、`sourcesIds` 是关联现有内容的关键标识符，其稳定性至关重要。
 3.  **数据有效性**: 所有 {{ nodeName }} 都有关联数据源，sourceIds 中都有值。
 </goal>
 
@@ -40,9 +38,8 @@
 1.  **分析反馈**：仔细阅读并理解 `<context>` 中 用户反馈 提出的每一项变更要求。明确哪些节点是需要被修改、添加或删除的目标。
 2.  **验证反馈的实现**：对比 `<context>` 中的 `structurePlan` 和 `originalStructurePlan`，确认所要求的变更是否已执行。例如，如果反馈是“移除‘示例’部分”，你必须检查该部分在 `structurePlan` 中是否已不存在。
 3.  **验证无关节点的稳定性**：这是最关键的检查。遍历 `structurePlan` 中的所有节点。对于每一个在 `originalStructurePlan` 中也存在、但并未在反馈中被提及的节点：
-    *   **至关重要**：其 `path` 属性**必须**与 `originalStructurePlan` 中的完全相同。
-    *   理想情况下，其他属性（如 `title`）也应保持稳定，除非这些变更是由某个被要求的变更直接导致的。
-4. **`sourcesIds` 是允许变更的**，每次结构规划可以根据最新的 DataSources 变更依赖的数据源，sourceIds 不能为空。
+    *   **至关重要**：其 `path`、`sourcesIds` 属性**必须**与 `originalStructurePlan` 中的完全相同。
+    *   理想情况下，其他属性（如 `title`、`description`）也应保持稳定，除非这些变更是由某个被要求的变更直接导致的，或者是 DataSource 变更导致。
 </rules>
 
 <output>

package/prompts/content-detail-generator.md

@@ -96,6 +96,5 @@ parentId: {{parentId}}
 
 1. 输内容为{{nodeName}}的详细文本。
 2. 直接输出{{nodeName}}内容，不要包含其他信息.
-3. 如果无法生成内容，返回错误提示用户需要补充哪些内容。
-4. 以用户语言 {{locale}} 输出
+3. 以用户语言 {{locale}} 输出
    </output_schema>

package/prompts/structure-planning.md

@@ -27,10 +27,15 @@
 {{originalStructurePlan}}
 </last_structure_plan>
 
+<last_structure_plan_rule>
+如果提供了上一轮生成的结构规划(last_structure_plan)，需要遵循以下规则：
+  1.  **反馈的实现**：新的结构规划**必须**正确地实现用户反馈中要求的所有变更。
+  2.  **无关节点的稳定性**：没有在用户反馈中被提及的节点 ** path、sourcesIds 属性不能被修改 **。`path`、`sourcesIds` 是关联现有内容的关键标识符，其稳定性至关重要。
+    理想情况下，其他属性（如 `title`、`description`）也应保持稳定，除非这些变更是由某个被要求的变更直接导致的，或者是 DataSource 变更导致。
+</last_structure_plan_rule>
+
 <structure_plan_feedback>
 {{ feedback }}
-
-根据最新的 Data Sources 按需要更新节点的 sourceIds，如没有大的变化，可以不更新。
 </structure_plan_feedback>
 
 <review_structure_plan>

package/prompts/translator.md

@@ -61,6 +61,10 @@
 {{content}}
 </content>
 
+<translate_feedback>
+{{ feedback }}
+</translate_feedback>
+
 <review_feedback>
 {{ detailFeedback }}
 </review_feedback>

package/tests/check-detail-result.test.mjs

@@ -23,28 +23,21 @@ async function runTests() {
     const content = "This contains a [dead link](/dead-link).";
     const result = await checkDetailResult({ structurePlan, content });
     assert(result.isApproved === false, "Should not be approved");
-    assert(
-      result.detailFeedback.includes("Found a dead link"),
-      "Should report dead link"
-    );
+    assert(result.detailFeedback.includes("Found a dead link"), "Should report dead link");
     console.log("✅ Test passed: should reject content with a dead link");
   }
 
   async function testRejectIncorrectTableSeparator() {
-    console.log(
-      "Testing: should reject content with incorrect table separator"
-    );
+    console.log("Testing: should reject content with incorrect table separator");
     const structurePlan = [];
     const content = "| Header | Header |\n| - | - |\n| Cell | Cell |";
     const result = await checkDetailResult({ structurePlan, content });
     assert(result.isApproved === false, "Should not be approved");
     assert(
       result.detailFeedback.includes("incorrect table separator"),
-      "Should report incorrect table separator"
-    );
-    console.log(
-      "✅ Test passed: should reject content with incorrect table separator"
+      "Should report incorrect table separator",
     );
+    console.log("✅ Test passed: should reject content with incorrect table separator");
   }
 
   async function testApproveExternalLink() {
@@ -60,17 +53,13 @@ async function runTests() {
   async function testRejectMultipleIssues() {
     console.log("Testing: should reject content with multiple issues");
     const structurePlan = [{ path: "/getting-started" }];
-    const content =
-      "This has a [dead link](/dead-link) and an incorrect table: | - |.";
+    const content = "This has a [dead link](/dead-link) and an incorrect table: | - |.";
     const result = await checkDetailResult({ structurePlan, content });
     assert(result.isApproved === false, "Should not be approved");
-    assert(
-      result.detailFeedback.includes("Found a dead link"),
-      "Should report dead link"
-    );
+    assert(result.detailFeedback.includes("Found a dead link"), "Should report dead link");
     assert(
       result.detailFeedback.includes("incorrect table separator"),
-      "Should report incorrect table separator"
+      "Should report incorrect table separator",
     );
     console.log("✅ Test passed: should reject content with multiple issues");
   }
@@ -100,4 +89,4 @@ async function runTests() {
   }
 }
 
-runTests();
+runTests();