@aigne/doc-smith 0.2.5 → 0.2.6

package/agents/publish-docs.mjs

@@ -7,119 +7,12 @@ import { existsSync, mkdirSync } from "node:fs";
 import { readFile, writeFile } from "node:fs/promises";
 import { homedir } from "node:os";
 import { parse, stringify } from "yaml";
-import { execSync } from "node:child_process";
 import { basename } from "node:path";
 import { loadConfigFromFile, saveValueToConfig } from "../utils/utils.mjs";
 
 const WELLKNOWN_SERVICE_PATH_PREFIX = "/.well-known/service";
 const DEFAULT_APP_URL = "https://docsmith.aigne.io";
 
-/**
- * Get GitHub repository information
- * @param {string} repoUrl - The repository URL
- * @returns {Promise<Object>} - Repository information
- */
-async function getGitHubRepoInfo(repoUrl) {
-  try {
-    // Extract owner and repo from GitHub URL
-    const match = repoUrl.match(
-      /github\.com[\/:]([^\/]+)\/([^\/]+?)(?:\.git)?$/
-    );
-    if (!match) return null;
-
-    const [, owner, repo] = match;
-    const apiUrl = `https://api.github.com/repos/${owner}/${repo}`;
-
-    const response = await fetch(apiUrl);
-    if (!response.ok) return null;
-
-    const data = await response.json();
-    return {
-      name: data.name,
-      description: data.description || "",
-      icon: data.owner?.avatar_url || "",
-    };
-  } catch (error) {
-    console.warn("Failed to fetch GitHub repository info:", error.message);
-    return null;
-  }
-}
-
-/**
- * Get project information with user confirmation
- * @param {Object} options - Options object containing prompts
- * @returns {Promise<Object>} - Project information including name, description, and icon
- */
-async function getProjectInfo(options) {
-  let repoInfo = null;
-  let defaultName = basename(process.cwd());
-  let defaultDescription = "";
-  let defaultIcon = "";
-
-  // Check if we're in a git repository
-  try {
-    const gitRemote = execSync("git remote get-url origin", {
-      encoding: "utf8",
-      stdio: ["pipe", "pipe", "ignore"],
-    }).trim();
-
-    // Extract repository name from git remote URL
-    const repoName = gitRemote.split("/").pop().replace(".git", "");
-    defaultName = repoName;
-
-    // If it's a GitHub repository, try to get additional info
-    if (gitRemote.includes("github.com")) {
-      repoInfo = await getGitHubRepoInfo(gitRemote);
-      if (repoInfo) {
-        defaultDescription = repoInfo.description;
-        defaultIcon = repoInfo.icon;
-      }
-    }
-  } catch (error) {
-    // Not in git repository or no origin remote, use current directory name
-    console.warn("No git repository found, using current directory name");
-  }
-
-  // Prompt user for project information
-  console.log("\n📋 Project Information for Documentation Platform");
-
-  const projectName = await options.prompts.input({
-    message: "Project name:",
-    default: defaultName,
-    validate: (input) => {
-      if (!input || input.trim() === "") {
-        return "Project name cannot be empty";
-      }
-      return true;
-    },
-  });
-
-  const projectDescription = await options.prompts.input({
-    message: "Project description (optional):",
-    default: defaultDescription,
-  });
-
-  const projectIcon = await options.prompts.input({
-    message: "Project icon URL (optional):",
-    default: defaultIcon,
-    validate: (input) => {
-      if (!input || input.trim() === "") return true;
-      try {
-        new URL(input);
-        return true;
-      } catch {
-        return "Please enter a valid URL";
-      }
-    },
-  });
-
-  return {
-    name: projectName.trim(),
-    description: projectDescription.trim(),
-    icon: projectIcon.trim(),
-  };
-}
-
 /**
  * Get access token from environment, config file, or prompt user for authorization
  * @param {string} appUrl - The application URL
@@ -207,7 +100,7 @@ async function getAccessToken(appUrl) {
 }
 
 export default async function publishDocs(
-  { docsDir, appUrl, boardId, boardName, boardDesc, boardCover },
+  { docsDir, appUrl, boardId, projectName, projectDesc, projectLogo },
   options
 ) {
   // Check if DOC_DISCUSS_KIT_URL is set in environment variables
@@ -260,58 +153,56 @@ export default async function publishDocs(
 
   const sidebarPath = join(docsDir, "_sidebar.md");
 
-  let projectInfo = {
-    name: boardName,
-    description: boardDesc,
-    icon: boardCover,
+  // Get project info from config
+  const projectInfo = {
+    name: projectName || config?.projectName || basename(process.cwd()),
+    description: projectDesc || config?.projectDesc || "",
+    icon: projectLogo || config?.projectLogo || "",
   };
 
-  // Only get project info if we need to create a new board
-  if (!boardName) {
-    projectInfo = await getProjectInfo(options);
-
-    // save project info to config
-    await saveValueToConfig("boardName", projectInfo.name);
-    await saveValueToConfig("boardDesc", projectInfo.description);
-    await saveValueToConfig("boardCover", projectInfo.icon);
-  }
+  try {
+    const {
+      success,
+      boardId: newBoardId,
+      docsUrl,
+    } = await publishDocsFn({
+      sidebarPath,
+      accessToken,
+      appUrl,
+      boardId,
+      autoCreateBoard: true,
+      // Pass additional project information if available
+      boardName: projectInfo.name,
+      boardDesc: projectInfo.description,
+      boardCover: projectInfo.icon,
+    });
 
-  const {
-    success,
-    boardId: newBoardId,
-    docsUrl,
-  } = await publishDocsFn({
-    sidebarPath,
-    accessToken,
-    appUrl,
-    boardId,
-    autoCreateBoard: true,
-    // Pass additional project information if available
-    boardName: projectInfo.name,
-    boardDesc: projectInfo.description,
-    boardCover: projectInfo.icon,
-  });
+    // Save values to config.yaml if publish was successful
+    if (success) {
+      // Save appUrl to config only when not using environment variable
+      if (!useEnvAppUrl) {
+        await saveValueToConfig("appUrl", appUrl);
+      }
 
-  // Save values to config.yaml if publish was successful
-  if (success) {
-    // Save appUrl to config only when not using environment variable
-    if (!useEnvAppUrl) {
-      await saveValueToConfig("appUrl", appUrl);
+      // Save boardId to config if it was auto-created
+      if (boardId !== newBoardId) {
+        await saveValueToConfig(
+          "boardId",
+          newBoardId,
+          "⚠️ Warning: boardId is auto-generated by system, please do not edit manually"
+        );
+      }
     }
 
-    // Save boardId to config if it was auto-created
-    if (boardId !== newBoardId) {
-      await saveValueToConfig("boardId", newBoardId);
-    }
+    const message = `✅ Documentation Published Successfully!`;
+    return {
+      message,
+    };
+  } catch (error) {
+    return {
+      message: `❌ Failed to publish docs: ${error.message}`,
+    };
   }
-
-  //   const message = `## ✅ Documentation Published Successfully!
-
-  // Documentation is now available at: \`${docsUrl}\`
-  //   `;
-  return {
-    // message,
-  };
 }
 
 publishDocs.input_schema = {

package/agents/retranslate.yaml

@@ -0,0 +1,74 @@
+type: team
+name: retranslate
+alias:
+  - rt
+  - translate-again
+description: Re-translate individual document content to selected languages
+skills:
+  - url: ./input-generator.mjs
+    default_input:
+      skipIfExists: true
+  - ./load-config.mjs
+  - ./load-sources.mjs
+  - type: transform
+    jsonata: |
+      $merge([
+        $,
+        {
+          'structurePlan': originalStructurePlan,
+          'structurePlanResult': $map(originalStructurePlan, function($item) {
+            $merge([
+              $item,
+              {
+                'translates': [$map(translateLanguages, function($lang) { {"language": $lang} })]
+              }
+            ])
+          })
+        }
+      ])
+  - url: ./find-item-by-path.mjs
+    default_input:
+      isTranslate: true
+  - ./language-selector.mjs
+  - type: transform
+    jsonata: |
+      $merge([
+        $,
+        {
+          'translates': [$map(selectedLanguages, function($lang) { {"language": $lang} })]
+        }
+      ])
+  - ./batch-translate.yaml
+  - url: ./save-single-doc.mjs
+    default_input:
+      isTranslate: true
+      isShowMessage: true
+input_schema:
+  type: object
+  properties:
+    glossary:
+      type: string
+      description: Glossary of terms for consistent terminology
+    doc-path:
+      type: string
+      description: Document path to retranslate
+    # languages:
+    #   type: array
+    #   items:
+    #     type: string
+    #   description: Languages to translate to
+    feedback:
+      type: string
+      description: Feedback for translation improvement
+output_schema:
+  type: object
+  properties:
+    title:
+      type: string
+    description:
+      type: string
+    path:
+      type: string
+    content:
+      type: string
+mode: sequential

package/agents/save-docs.mjs

@@ -1,6 +1,7 @@
 import { writeFile, readdir, unlink } from "node:fs/promises";
 import { join } from "node:path";
 import { getCurrentGitHead, saveGitHeadToConfig } from "../utils/utils.mjs";
+import { shutdownMermaidWorkerPool } from "../utils/mermaid-worker-pool.mjs";
 
 /**
  * @param {Object} params
@@ -14,6 +15,7 @@ export default async function saveDocs({
   docsDir,
   translateLanguages = [],
   locale,
+  projectInfoMessage,
 }) {
   const results = [];
   // Save current git HEAD to config.yaml for change detection
@@ -47,8 +49,9 @@ export default async function saveDocs({
 
   const message = `## ✅ Documentation Generated Successfully!
 
-  Successfully generated **${structurePlan.length}** documents and saved to: \`${docsDir}\`
-
+  Successfully generated **${structurePlan.length}** documents and saved to:
+  \`${docsDir}\`
+  ${projectInfoMessage || ""}
   ### 🚀 Next Steps
 
   1. Publish Documentation
@@ -78,6 +81,13 @@ export default async function saveDocs({
   ---
   `;
 
+  // Shutdown mermaid worker pool to ensure clean exit
+  try {
+    await shutdownMermaidWorkerPool();
+  } catch (error) {
+    console.warn("Failed to shutdown mermaid worker pool:", error.message);
+  }
+
   return {
     message,
   };

package/agents/save-single-doc.mjs

@@ -1,4 +1,5 @@
 import { saveDocWithTranslations } from "../utils/utils.mjs";
+import { shutdownMermaidWorkerPool } from "../utils/mermaid-worker-pool.mjs";
 
 export default async function saveSingleDoc({
   path,
@@ -7,6 +8,8 @@ export default async function saveSingleDoc({
   translates,
   labels,
   locale,
+  isTranslate = false,
+  isShowMessage = false,
 }) {
   const results = await saveDocWithTranslations({
     path,
@@ -15,6 +18,22 @@ export default async function saveSingleDoc({
     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/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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "description": "",
   "publishConfig": {
     "access": "public"
@@ -12,17 +12,26 @@
   "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/anthropic": "^0.10.13",
+    "@aigne/cli": "^1.33.1",
+    "@aigne/core": "^1.48.0",
+    "@aigne/gemini": "^0.8.17",
+    "@aigne/openai": "^0.10.17",
+    "@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"
   },
   "scripts": {

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>