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

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.8.15-beta.5](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.15-beta.4...v0.8.15-beta.5) (2025-10-29)
+
+
+### Bug Fixes
+
+* simplify data source input and select tips ([#223](https://github.com/AIGNE-io/aigne-doc-smith/issues/223)) ([069928b](https://github.com/AIGNE-io/aigne-doc-smith/commit/069928bce2b4a70ee5a0444ecff34501e1158e5c))
+
+## [0.8.15-beta.4](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.15-beta.3...v0.8.15-beta.4) (2025-10-28)
+
+
+### Bug Fixes
+
+* fix update translate not working ([#221](https://github.com/AIGNE-io/aigne-doc-smith/issues/221)) ([95bc49e](https://github.com/AIGNE-io/aigne-doc-smith/commit/95bc49ec8b1e18fe20dd1360d9707afdd6629bad))
+
 ## [0.8.15-beta.3](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.15-beta.2...v0.8.15-beta.3) (2025-10-28)
 
 

package/agents/init/index.mjs

@@ -245,25 +245,21 @@ export default async function init(
   input.docsDir = docsDirInput.trim() || `${outputPath}/docs`;
 
   // 8. Content sources
-  console.log("\n🔍 [8/9]: Content Sources");
+  console.log("\n🔍 [8/9]: Data Sources");
+  console.log("Please specify the data source we should analyze to generate your documentation.");
   console.log(
-    "Please specify the folders and files we should analyze to generate your documentation.",
+    `  1. Use paths like ${chalk.green("./src")}, ${chalk.green("./README.md")} or ${chalk.green("!./src/private")}.`,
   );
   console.log(
-    `  1. You can use local file paths like ${chalk.green("./src")}, ${chalk.green("./docs")}, ${chalk.green("./README.md")} (prefix with '!' to ignore a file or folder like ${chalk.green("!./src/private")}).`,
-  );
-  console.log(
-    `  2. You can also use glob patterns like ${chalk.green("src/**/*.js")} or ${chalk.green("docs/**/*.md")} for more specific file matching. (prefix with '!' to ignore a file or folder like ${chalk.green("!private/**/*.js")}).`,
-  );
-  console.log(
-    `  3. You can also use remote url like ${chalk.green("https://example.com/openapi.yaml")}.`,
+    `  2. Use globs like ${chalk.green("src/**/*.js")} or ${chalk.green("!private/**/*.js")} for more specific file matching.`,
   );
+  console.log(`  3. Use URLs like ${chalk.green("https://example.com/openapi.yaml")}.`);
   console.log("💡 If you leave this empty, we will scan the entire directory.");
 
   const sourcePaths = [];
   while (true) {
     const selectedPath = await options.prompts.search({
-      message: "Please enter a file or folder path, or a glob pattern or remote url:",
+      message: "Please enter a valid data source:",
       source: async (input) => {
         if (!input || input.trim() === "") {
           return [

package/agents/update/generate-diagram.yaml

@@ -0,0 +1,30 @@
+type: team
+task_render_mode: collapse
+name: generateDiagram
+skills:
+  - ../generate/draw-diagram.yaml
+  - ../generate/wrap-diagram-code.mjs
+reflection:
+  reviewer: ../generate/check-diagram.mjs
+  is_approved: isValid
+  max_iterations: 5
+  return_last_on_max_iterations: false
+  custom_error_message: "MUST NOT generate any diagram: validation failed after max iterations."
+input_schema:
+  type: object
+  properties:
+    documentContent:
+      type: string
+      description: The **raw text content** of the current document. (**Note:** This is the original document and **does not include** any diagram source code.)
+    locale:
+      type: string
+      description: Language for diagram labels and text
+      default: en
+  required:
+    - documentContent
+output_schema:
+  type: object
+  properties:
+    diagramSourceCode:
+      type: string
+      description: The **diagram source code** generated from the input text.

package/agents/update/generate-document.yaml

@@ -58,33 +58,4 @@ afs:
           should search and read as needed while generating document content
 keep_text_in_tool_uses: false
 skills:
-  - type: team
-    task_render_mode: collapse
-    name: generateDiagram
-    skills:
-      - ../generate/draw-diagram.yaml
-      - ../generate/wrap-diagram-code.mjs
-    reflection:
-      reviewer: ../generate/check-diagram.mjs
-      is_approved: isValid
-      max_iterations: 5
-      return_last_on_max_iterations: false
-      custom_error_message: "MUST NOT generate any diagram: validation failed after max iterations."
-    input_schema:
-      type: object
-      properties:
-        documentContent:
-          type: string
-          description: The **raw text content** of the current document. (**Note:** This is the original document and **does not include** any diagram source code.)
-        locale:
-          type: string
-          description: Language for diagram labels and text
-          default: en
-      required:
-        - documentContent
-    output_schema:
-      type: object
-      properties:
-        diagramSourceCode:
-          type: string
-          description: The **diagram source code** generated from the input text.
+  - ./generate-diagram.yaml

package/agents/update/save-and-translate-document.mjs

@@ -47,20 +47,13 @@ export default async function saveAndTranslateDocument(input, options) {
         // Clear feedback to ensure translation is not affected by update feedback
         doc.feedback = "";
 
-        const result = await options.context.invoke(translateAgent, {
+        await options.context.invoke(translateAgent, {
           ...input, // context is required
           content: doc.content,
           translates: doc.translates,
           title: doc.title,
-        });
-
-        // Save the translated content
-        const saveTranslationsAgent = options.context.agents["saveDocTranslations"];
-        await options.context.invoke(saveTranslationsAgent, {
           path: doc.path,
-          docsDir: docsDir,
-          translates: result.translates || doc.translates,
-          labels: doc.labels,
+          docsDir,
         });
       } catch (error) {
         console.error(`❌ Failed to translate document ${doc.path}:`, error.message);

package/agents/update/update-document-detail.yaml

@@ -57,4 +57,5 @@ afs:
 keep_text_in_tool_uses: false
 skills:
   - ./document-tools/update-document-content.mjs
+  - ./generate-diagram.yaml
 task_render_mode: collapse

package/agents/utils/save-doc-translation.mjs

@@ -1,6 +1,6 @@
 import { saveDocTranslation as _saveDocTranslation } from "../../utils/utils.mjs";
 
-export default async function saveDocTranslations({
+export default async function saveDocTranslation({
   path,
   docsDir,
   translation,
@@ -24,4 +24,4 @@ export default async function saveDocTranslations({
   return {};
 }
 
-saveDocTranslations.task_render_mode = "hide";
+saveDocTranslation.task_render_mode = "hide";

package/aigne.yaml

@@ -71,7 +71,6 @@ agents:
   - ./agents/utils/transform-detail-datasources.mjs
   - ./agents/utils/save-doc.mjs
   - ./agents/utils/save-doc-translation.mjs
-  - ./agents/utils/save-doc-translations.mjs
   - ./agents/utils/save-output.mjs
   - ./agents/utils/format-document-structure.mjs
   - ./agents/utils/find-item-by-path.mjs

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.8.15-beta.3",
+  "version": "0.8.15-beta.5",
   "description": "AI-driven documentation generation tool built on the AIGNE Framework",
   "publishConfig": {
     "access": "public"

package/prompts/detail/generate/user-prompt.md

@@ -97,6 +97,7 @@ Generate detailed and well-structured document for the current {{nodeName}} base
 YOU SHOULD:
 - Use AFS tools `afs_list` `afs_search` or `afs_read` to gather relevant and accurate information to enhance the content.
 - Follow rules in `<diagram_generation_guide>`: use `generateDiagram` tool to create and embed a diagram when appropriate, following the diagram generation guidelines.
+- If the `generateDiagram` tool is not called, do not attempt to add any diagrams.
 
 <steps>
 1. Analyze the provided document structure and user requirements to plan the content.

package/utils/utils.mjs

@@ -111,44 +111,6 @@ export async function saveDoc({ path: docPath, content, docsDir, locale, labels
   }
 }
 
-/**
- * Save a single document's translations to files
- * @param {Object} params
- * @param {string} params.path - Relative path (without extension)
- * @param {string} params.docsDir - Root directory
- * @param {Array<{language: string, translation: string}>} [params.translates] - Translation content
- * @param {Array<string>} [params.labels] - Document labels for front matter
- * @returns {Promise<Array<{ path: string, success: boolean, error?: string }>>}
- */
-export async function saveDocTranslations({ path: docPath, docsDir, translates = [], labels }) {
-  const results = [];
-  try {
-    await fs.mkdir(docsDir, { recursive: true });
-
-    // Process all translations
-    for (const translate of translates) {
-      const translateFileName = getFileName(docPath, translate.language);
-      const translatePath = path.join(docsDir, translateFileName);
-
-      // Add labels front matter to translation content if labels are provided
-      let finalTranslationContent = processContent({
-        content: translate.translation,
-      });
-
-      if (labels && labels.length > 0) {
-        const frontMatter = `---\nlabels: ${JSON.stringify(labels)}\n---\n\n`;
-        finalTranslationContent = frontMatter + finalTranslationContent;
-      }
-
-      await fs.writeFile(translatePath, finalTranslationContent, "utf8");
-      results.push({ path: translatePath, success: true });
-    }
-  } catch (err) {
-    results.push({ path: docPath, success: false, error: err.message });
-  }
-  return results;
-}
-
 export async function saveDocTranslation({
   path: docPath,
   docsDir,

package/agents/utils/save-doc-translations.mjs

@@ -1,33 +0,0 @@
-import { shutdownMermaidWorkerPool } from "../../utils/mermaid-worker-pool.mjs";
-import { saveDocTranslations as _saveDocTranslations } from "../../utils/utils.mjs";
-
-export default async function saveDocTranslations({
-  path,
-  docsDir,
-  translates,
-  labels,
-  isShowMessage = false,
-}) {
-  await _saveDocTranslations({
-    path,
-    docsDir,
-    translates,
-    labels,
-  });
-
-  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 = `✅ Translation completed successfully.`;
-    return { message };
-  }
-
-  return {};
-}
-
-saveDocTranslations.task_render_mode = "hide";