@aigne/doc-smith 0.8.12-beta.8 → 0.8.12

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.8.12](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.12-beta.9...v0.8.12) (2025-10-16)
+
+## [0.8.12-beta.9](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.12-beta.8...v0.8.12-beta.9) (2025-10-15)
+
+
+### Features
+
+* **branding:** support updating branding information during publish doc ([#190](https://github.com/AIGNE-io/aigne-doc-smith/issues/190)) ([1918cae](https://github.com/AIGNE-io/aigne-doc-smith/commit/1918cae6ceefd24d76b6086730b6e0d038057cb6))
+* support translate meta in publish ([#189](https://github.com/AIGNE-io/aigne-doc-smith/issues/189)) ([3a34e38](https://github.com/AIGNE-io/aigne-doc-smith/commit/3a34e38f4283d4b2a19a88e426a8b49f0dd52bb6))
+
+
+### Bug Fixes
+
+* generate d2 diagram by tool use ([#184](https://github.com/AIGNE-io/aigne-doc-smith/issues/184)) ([0d04349](https://github.com/AIGNE-io/aigne-doc-smith/commit/0d04349d14cde62388467f755dedc10b74d14980))
+
 ## [0.8.12-beta.8](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.12-beta.7...v0.8.12-beta.8) (2025-10-14)
 
 

package/agents/publish/index.yaml

@@ -9,6 +9,7 @@ skills:
     default_input:
       skipIfExists: true
       checkOnly: true
+  - translate-meta.mjs
   - publish-docs.mjs
 input_schema:
   type: object
@@ -16,3 +17,6 @@ input_schema:
     appUrl:
       type: string
       description: Website URL where docs will be published (optional - leave empty for interactive setup)
+    with-branding:
+      type: boolean
+      description: Update your website branding (title, description, logo)

package/agents/publish/publish-docs.mjs

@@ -1,10 +1,12 @@
-import { basename, join } from "node:path";
-
+import { basename, extname, join, relative } from "node:path";
+import slugify from "slugify";
 import { publishDocs as publishDocsFn } from "@aigne/publish-docs";
 import { BrokerClient } from "@blocklet/payment-broker-client/node";
 import chalk from "chalk";
 import fs from "fs-extra";
 
+import { getExtnameFromContentType } from "../../utils/file-utils.mjs";
+import { isHttp } from "../../utils/utils.mjs";
 import { getAccessToken, getOfficialAccessToken } from "../../utils/auth-utils.mjs";
 import {
   CLOUD_SERVICE_URL_PROD,
@@ -16,14 +18,25 @@ import {
 import { beforePublishHook, ensureTmpDir } from "../../utils/d2-utils.mjs";
 import { deploy } from "../../utils/deploy.mjs";
 import { getGithubRepoUrl, loadConfigFromFile, saveValueToConfig } from "../../utils/utils.mjs";
+import updateBranding from "../utils/update-branding.mjs";
 
 const BASE_URL = process.env.DOC_SMITH_BASE_URL || CLOUD_SERVICE_URL_PROD;
 
 export default async function publishDocs(
-  { docsDir: rawDocsDir, appUrl, boardId, projectName, projectDesc, projectLogo },
+  {
+    docsDir: rawDocsDir,
+    appUrl,
+    boardId,
+    projectName,
+    projectDesc,
+    projectLogo,
+    translatedMetadata,
+    "with-branding": withBrandingOption,
+  },
   options,
 ) {
   let message;
+  let shouldWithBranding = withBrandingOption || false;
 
   try {
     // move work dir to tmp-dir
@@ -119,6 +132,12 @@ export default async function publishDocs(
         // Ensure appUrl has protocol
         appUrl = userInput.includes("://") ? userInput : `https://${userInput}`;
       } else if (["new-instance", "new-instance-continue"].includes(choice)) {
+        if (options?.prompts?.confirm) {
+          shouldWithBranding = await options.prompts.confirm({
+            message: "Would you like to update the project branding (title, description, logo)?",
+            default: true,
+          });
+        }
         // Deploy a new Discuss Kit service
         let id = "";
         let paymentUrl = "";
@@ -143,6 +162,7 @@ export default async function publishDocs(
     process.env.DOC_ROOT_DIR = docsDir;
 
     const sidebarPath = join(docsDir, "_sidebar.md");
+    const publishCacheFilePath = join(DOC_SMITH_DIR, "upload-cache.yaml");
 
     // Get project info from config
     const projectInfo = {
@@ -151,6 +171,39 @@ export default async function publishDocs(
       icon: projectLogo || config?.projectLogo || "",
     };
 
+    // Handle project logo download if it's a URL
+    if (projectInfo.icon && isHttp(projectInfo.icon)) {
+      const tempFilePath = join(docsDir, slugify(basename(projectInfo.icon)));
+      const initialExt = extname(projectInfo.icon);
+      let ext = initialExt;
+
+      try {
+        const response = await fetch(projectInfo.icon);
+        const blob = await response.blob();
+        const arrayBuffer = await blob.arrayBuffer();
+        const buffer = Buffer.from(arrayBuffer);
+
+        if (response.ok) {
+          if (!ext) {
+            const contentType = response.headers.get("content-type");
+            ext = getExtnameFromContentType(contentType);
+          }
+
+          const finalPath = ext ? `${tempFilePath}.${ext}` : tempFilePath;
+          fs.writeFileSync(finalPath, buffer);
+
+          // Update to relative path
+          projectInfo.icon = relative(join(process.cwd(), DOC_SMITH_DIR), finalPath);
+        }
+      } catch (error) {
+        console.warn(`Failed to download project logo from ${projectInfo.icon}: ${error.message}`);
+      }
+    }
+
+    if (shouldWithBranding) {
+      updateBranding({ appUrl, projectInfo, accessToken });
+    }
+
     // Construct boardMeta object
     const boardMeta = {
       category: config?.documentPurpose || [],
@@ -161,6 +214,9 @@ export default async function publishDocs(
         ...(config?.translateLanguages || []),
       ].filter((lang, index, arr) => arr.indexOf(lang) === index), // Remove duplicates
     };
+    if (translatedMetadata) {
+      boardMeta.translation = translatedMetadata;
+    }
 
     const {
       success,
@@ -177,7 +233,7 @@ export default async function publishDocs(
       boardDesc: projectInfo.description,
       boardCover: projectInfo.icon,
       mediaFolder: rawDocsDir,
-      cacheFilePath: join(DOC_SMITH_DIR, "upload-cache.yaml"),
+      cacheFilePath: publishCacheFilePath,
       boardMeta,
     });
 
@@ -193,6 +249,7 @@ export default async function publishDocs(
         await saveValueToConfig("boardId", newBoardId);
       }
       message = `✅ Documentation published successfully!`;
+      await saveValueToConfig("checkoutId", "", "Checkout ID for document deployment service");
     } else {
       // If the error is 401 or 403, it means the access token is invalid
       if (error?.includes("401") || error?.includes("403")) {
@@ -214,7 +271,6 @@ export default async function publishDocs(
     }
   }
 
-  await saveValueToConfig("checkoutId", "", "Checkout ID for document deployment service");
   return message ? { message } : {};
 }
 
@@ -234,6 +290,22 @@ publishDocs.input_schema = {
       type: "string",
       description: "The id of the board",
     },
+    "with-branding": {
+      type: "boolean",
+      description: "Update your website branding (title, description, logo)",
+    },
+    projectName: {
+      type: "string",
+      description: "The name of the project",
+    },
+    projectDesc: {
+      type: "string",
+      description: "The description of the project",
+    },
+    projectLogo: {
+      type: "string",
+      description: "The logo/icon of the project",
+    },
   },
 };
 

package/agents/publish/translate-meta.mjs

@@ -0,0 +1,103 @@
+import { join } from "node:path";
+
+import { AIAgent } from "@aigne/core";
+import fs from "fs-extra";
+import { parse as yamlParse, stringify as yamlStringify } from "yaml";
+import z from "zod";
+
+import { DOC_SMITH_DIR } from "../../utils/constants/index.mjs";
+
+export default async function translateMeta(
+  { projectName, projectDesc, locale, translateLanguages = [] },
+  options,
+) {
+  const languages = [...new Set([...(locale ? [locale] : []), ...(translateLanguages || [])])];
+
+  const translationCacheFilePath = join(DOC_SMITH_DIR, "translation-cache.yaml");
+  await fs.ensureFile(translationCacheFilePath);
+  const translationCache = await fs.readFile(translationCacheFilePath, "utf-8");
+  const parsedTranslationCache = yamlParse(translationCache || "{}");
+
+  const titleTranslation = parsedTranslationCache[projectName] || {};
+  const descTranslation = parsedTranslationCache[projectDesc] || {};
+
+  const titleLanguages = languages.filter((lang) => !titleTranslation[lang]);
+  const descLanguages = languages.filter((lang) => !descTranslation[lang]);
+  const titleTranslationSchema = z.object(
+    titleLanguages.reduce((shape, lang) => {
+      shape[lang] = z.string();
+      return shape;
+    }, {}),
+  );
+  const descTranslationSchema = z.object(
+    descLanguages.reduce((shape, lang) => {
+      shape[lang] = z.string();
+      return shape;
+    }, {}),
+  );
+
+  const agent = AIAgent.from({
+    name: "translateMeta",
+    instructions:
+      "You are an **Elite Polyglot Localization and Translation Specialist** with extensive professional experience across multiple domains. Your core mission is to produce translations that are not only **100% accurate** to the source meaning but are also **natively fluent, highly readable, and culturally appropriate** in the target language.",
+    inputKey: "message",
+    outputSchema: z.object({
+      title: titleTranslationSchema.describe("Translated titles with language codes as keys"),
+      desc: descTranslationSchema.describe("Translated descriptions with language codes as keys"),
+    }),
+  });
+  if (titleLanguages.length > 0 || descLanguages.length > 0) {
+    const translatedMetadata = await options.context.invoke(agent, {
+      message: `Translate the following title and description into all target languages except the source language. Provide the translations in a JSON object with the language codes as keys. If the project title or description is empty, return an empty string for that field.
+
+Project Title: ${projectName || ""}
+Project Description: ${projectDesc || ""}
+
+Target Languages: { title: ${titleLanguages.join(", ")}, desc: ${descLanguages.join(", ")} }
+Source Language: ${locale}
+
+Respond with a JSON object in the following format:
+{
+  "title": {
+    "fr": "Translated Project Title in French",
+    "es": "Translated Project Title in Spanish",
+    ...
+  },
+  "desc": {
+    "fr": "Translated Project Description in French",
+    "es": "Translated Project Description in Spanish",
+    ...
+  }
+}
+
+If no translation is needed, respond with:
+{
+  "title": {},
+  "desc": {}
+}`,
+    });
+    Object.keys(translatedMetadata.title || {}).forEach((lang) => {
+      if (translatedMetadata.title[lang]) {
+        titleTranslation[lang] = translatedMetadata.title[lang];
+      }
+    });
+    Object.keys(translatedMetadata.desc || {}).forEach((lang) => {
+      if (translatedMetadata.desc[lang]) {
+        descTranslation[lang] = translatedMetadata.desc[lang];
+      }
+    });
+  }
+  const saveResult = {
+    ...parsedTranslationCache,
+    [projectName]: titleTranslation,
+    [projectDesc]: descTranslation,
+  };
+  await fs.writeFile(translationCacheFilePath, yamlStringify(saveResult), { encoding: "utf8" });
+
+  return {
+    translatedMetadata: {
+      title: saveResult[projectName] || {},
+      desc: saveResult[projectDesc] || {},
+    },
+  };
+}

package/agents/update/generate-document.yaml

@@ -5,6 +5,8 @@ instructions:
     url: ../../prompts/detail/generate/system-prompt.md
   - role: user
     url: ../../prompts/detail/generate/user-prompt.md
+auto_reorder_system_messages: true
+auto_merge_system_messages: true
 input_schema:
   type: object
   properties:
@@ -54,31 +56,31 @@ afs:
         description: |
           Codebase of the project to be documented used as context for document generation,
           should search and read as needed while generating document content
-# skills:
-  # FIXME: @zhanghan temporary disable diagram tool
-  # - 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 existing diagram source code.)
-  #     required:
-  #       - documentContent
-  #   output_schema:
-  #     type: object
-  #     properties:
-  #       diagramSourceCode:
-  #         type: string
-  #         description: The **diagram source code** generated from the input text.
+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 existing diagram source code.)
+      required:
+        - documentContent
+    output_schema:
+      type: object
+      properties:
+        diagramSourceCode:
+          type: string
+          description: The **diagram source code** generated from the input text.

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

@@ -6,7 +6,8 @@ instructions:
     url: ../../prompts/detail/update/system-prompt.md
   - role: user
     url: ../../prompts/detail/update/user-prompt.md
-
+auto_reorder_system_messages: true
+auto_merge_system_messages: true
 input_schema:
   type: object
   properties:
@@ -53,6 +54,7 @@ afs:
         description: |
           Codebase of the project to be documented used as context for document generation,
           should search and read as needed while generating document content
+keep_text_in_tool_uses: false
 skills:
   - ./document-tools/update-document-content.mjs
 task_render_mode: collapse

package/agents/utils/update-branding.mjs

@@ -0,0 +1,69 @@
+import { stat } from "node:fs/promises";
+import { resolve } from "node:path";
+import chalk from "chalk";
+import { joinURL } from "ufo";
+
+import { getComponentInfoWithMountPoint } from "../../utils/blocklet.mjs";
+import {
+  CLOUD_SERVICE_URL_PROD,
+  CLOUD_SERVICE_URL_STAGING,
+  DISCUSS_KIT_DID,
+  DOC_SMITH_DIR,
+} from "../../utils/constants/index.mjs";
+import { requestWithAuthToken } from "../../utils/request.mjs";
+import { uploadFiles } from "../../utils/upload-files.mjs";
+
+export default async function updateBranding({ appUrl, projectInfo, accessToken }) {
+  try {
+    const origin = new URL(appUrl).origin;
+    if ([CLOUD_SERVICE_URL_PROD, CLOUD_SERVICE_URL_STAGING].includes(origin)) {
+      console.log("Skipped updating branding for official service\n");
+      return;
+    }
+
+    console.log(`🔄 Updating branding for ${chalk.cyan(origin)}`);
+
+    const componentInfo = await getComponentInfoWithMountPoint(origin, DISCUSS_KIT_DID);
+    const mountPoint = componentInfo.mountPoint || "/";
+
+    const res = await requestWithAuthToken(
+      joinURL(origin, mountPoint, "/api/branding"),
+      {
+        method: "PUT",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: JSON.stringify({
+          appName: projectInfo.name,
+          appDescription: projectInfo.description,
+        }),
+      },
+      accessToken,
+    );
+
+    if (res.success) {
+      try {
+        const projectLogoPath = resolve(process.cwd(), DOC_SMITH_DIR, projectInfo.icon);
+        const projectLogoStat = await stat(projectLogoPath);
+
+        if (projectLogoStat.isFile()) {
+          // Upload to blocklet logo endpoint
+          await uploadFiles({
+            appUrl: origin,
+            filePaths: [projectLogoPath],
+            accessToken,
+            concurrency: 1,
+            endpoint: `${origin}/.well-known/service/blocklet/logo/upload/square/${componentInfo.did}`,
+          });
+        }
+        console.log("✅ Updated branding successfully!\n");
+      } catch (error) {
+        console.warn(`⚠️ Just failed to update logo: ${error.message}\n`);
+      }
+    } else {
+      console.warn(`⚠️ Failed to update branding: ${res.error}\n`);
+    }
+  } catch (error) {
+    console.warn(`⚠️ Failed to update branding: ${error.message}\n`);
+  }
+}

package/package.json

@@ -1,10 +1,22 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.8.12-beta.8",
+  "version": "0.8.12",
   "description": "AI-driven documentation generation tool built on the AIGNE Framework",
   "publishConfig": {
     "access": "public"
   },
+  "files": [
+    "agents",
+    "assets/report-template",
+    "docs-mcp",
+    "prompts",
+    "types",
+    "utils",
+    "aigne.yaml",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
   "main": "index.js",
   "type": "module",
   "bin": "aigne.yaml",
@@ -18,7 +30,7 @@
     "@aigne/core": "^1.61.0",
     "@aigne/gemini": "^0.14.0",
     "@aigne/openai": "^0.16.0",
-    "@aigne/publish-docs": "^0.11.0",
+    "@aigne/publish-docs": "^0.12.0",
     "@blocklet/payment-broker-client": "^1.21.10",
     "@terrastruct/d2": "^0.1.33",
     "chalk": "^5.5.0",
@@ -36,11 +48,13 @@
     "marked-terminal": "^7.3.0",
     "mermaid": "^11.9.0",
     "open": "^10.2.0",
+    "p-limit": "^7.1.1",
     "p-map": "^7.0.3",
     "p-retry": "^7.0.0",
     "remark-gfm": "^4.0.1",
     "remark-lint": "^10.0.1",
     "remark-parse": "^11.0.0",
+    "slugify": "^1.6.6",
     "terminal-link": "^4.0.0",
     "ufo": "^1.6.1",
     "unified": "^11.0.5",

package/prompts/common/document/role-and-personality.md

@@ -6,10 +6,12 @@ Your key strengths include:
   - Versatile Writing Style: You're not confined to specific technical domains and can adapt your language style to meet diverse documentation needs—whether technical specifications, user guides, product descriptions, or business process documentation.
   - Quality-Driven Approach: You consistently pursue top-tier documentation quality, ensuring accuracy, completeness, consistency, readability, and practicality. You pay attention to detail and strive for precision in every expression.
   - User-Centric Perspective: You think from the target reader's viewpoint, anticipating their potential questions and confusion, addressing them proactively in the documentation to enhance user experience and value.
+  - Tool Usage Capability: You can call available tools as needed based on context to query information, gather data, or generate visuals, ensuring the documentation is accurate, complete, and visually clear.
 
 **Your process must reflect ISTJ traits:**
 
 1.  **Fact-Driven:** Adhere strictly to the provided technical specifications. Do not infer or embellish information.
 2.  **Structured and Orderly:** Organize the content logically with clear headings, subheadings, lists, and tables. Present information sequentially where appropriate (e.g., installation steps).
 3.  **Clarity and Precision:** Use precise, unambiguous language. Define technical terms clearly. Avoid marketing jargon or emotionally charged words.
-4.  **Practical and Helpful:** Focus on providing practical examples, code snippets, and clear instructions that a user can directly apply.
+4.  **Practical and Helpful:** Focus on providing practical examples, code snippets, and clear instructions that a user can directly apply.
+5.  **Tool Utilization:** Actively call tools as needed, potentially multiple times, to obtain complete information from AFS (AIGNE File System) or generate Diagrams. Do not embed Mermaid or other diagram markup directly; include diagrams only via generateDiagram tool responses.

package/prompts/detail/d2-diagram/guide.md

@@ -1,5 +1,8 @@
 <diagram_generation_guide>
 1. Diagram Triggers and Types: Use the following guidelines to determine when to generate a diagram and which type to use.
+  - Rule for Skipping Diagrams:
+    - Trigger: Do not generate diagrams for purely textual, reference, or short note documents that describe abstract concepts, simple definitions, or FAQs.
+    - Action: Skip diagram generation entirely.
   - Architecture Diagram (High-Level)
     - Trigger: When generating a document that serves as a high-level overview of a system, project, or the entire documentation set.
     - Action: Create a system architecture diagram.
@@ -13,7 +16,10 @@
     - Action: Create the most appropriate diagram type:
       - Flowchart: Use for step-by-step processes, algorithms, or decision-making logic.
       - Sequence Diagram: Use for time-ordered interactions between different components or actors (e.g., API calls).
+NOTE:  For documents not skipped by the first rule but not clearly fitting the above categories, you should always attempt to generate at least one Diagram whenever possible to visually represent key structures, relationships, or processes in the content.
+
 2. Constraints and Best Practices
   - Quantity: Generate a maximum of three (3) diagrams per document to ensure the content remains focused and readable.
-  - Relevance: Ensure every diagram directly illustrates a concept explained in the surrounding text. Avoid generating diagrams for simple concepts that are easily understood through text alone.
+  - Relevance: Ensure every diagram directly illustrates a concept explained in the surrounding text. Avoid generating diagrams for concepts that are easily understood via text alone.
+  - Priority: For complex modules, workflows, or interactions, generate diagrams for each critical part.
 </diagram_generation_guide>

package/prompts/detail/d2-diagram/user-prompt.md

@@ -1,4 +1,7 @@
 Follow the given rules and ISTJ style from your system instructions.
 
 Generate a d2-diagram that represents the following document content:
+
+<document_content>
 {{documentContent}}
+</document_content>

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

@@ -1,6 +1,9 @@
 <role_and_goal>
 {% include "../../common/document/role-and-personality.md" %}
 
+
+**Fact Verification Rule:**
+Do not assume or infer any facts on your own. Treat all information as unknown until verified. Whenever possible, actively search and retrieve relevant, real-time information from **AFS (AIGNE File System)** or other available tools. Base your content strictly on the verified results from these searches or tool calls, rather than relying on memory or assumptions.
 </role_and_goal>
 
 
@@ -40,11 +43,7 @@ Custom component generation rules:
 Custom code block generation rules:
 {% include "../custom/custom-code-block.md" %}
 
-Diagram generation rules:
 {% include "../d2-diagram/guide.md" %}
-<diagram_generation_rules>
-{% include "../d2-diagram/system-prompt.md" %}
-</diagram_generation_rules>
 
 </content_generation_rules>
 
@@ -52,8 +51,8 @@ Diagram generation rules:
 
 <output_constraints>
 
-1. Output detailed text content for {{nodeName}}.
-2. Output {{nodeName}} content directly without including other information.
-3. Reference the style from examples only, **output content in {{locale}} language**
+1. Output the complete Markdown content for {{nodeName}}, only the content itself—no explanations or extra information.
+2. Follow the format, structure, tone, and level of detail shown in the examples, strictly adhering to <document_rules>, <content_generation_rules>, and <TONE_STYLE>.
+3. Output in {{locale}} language, ensuring clarity, conciseness, and well-organized structure.
 
 </output_constraints>

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

@@ -53,9 +53,18 @@ User feedback on previous generation:
 </feedback>
 {% endif %}
 
-{% include "../../common/afs/afs-tools-usage.md" %}
 
 <instructions>
-Generate detailed document for the current {{nodeName}} based on user-provided information: current {{nodeName}} details (including title, description, path), DataSources, documentStructure (overall structural planning), and other relevant information.
-{% include "../../common/afs/use-afs-instruction.md" %}
+Generate detailed and well-structured document for the current {{nodeName}} based on user-provided information: current {{nodeName}} details (including title, description, path), DataSources, documentStructure (overall structural planning), and other relevant information.
+
+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` to create and embed a diagram when appropriate, following the diagram generation guidelines.
+
+<steps>
+1. Analyze the provided document structure and user requirements to plan the content.
+2. Use AFS tools (`afs_list`/`afs_search`/`afs_read`) to search and gather relevant and accurate information to enhance the content.
+3. Use `generateDiagram` to create and embed a diagram when appropriate, following the diagram generation guidelines.
+4. Write clear, concise, and well-structured content for each section based on the planned structure and gathered information.
+</steps>
 </instructions>

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

@@ -32,9 +32,7 @@
 {{feedback}}
 </user_feedback>
 
-{% include "../../common/afs/afs-tools-usage.md" %}
 
 <instructions>
 Analyze the original document content and user feedback, then use available tools to implement the requested improvements while maintaining the document's integrity and style.
-{% include "../../common/afs/use-afs-instruction.md" %}
 </instructions>

package/prompts/structure/update/user-prompt.md

@@ -21,8 +21,6 @@ Initial Documentation Structure:
 {{ feedback }}
 </user_feedback>
 
-{% include "../../common/afs/afs-tools-usage.md" %}
-
 <instructions>
 
 Objectives:
@@ -41,6 +39,4 @@ Processing workflow:
 Rules:
 ** All changes must be made using Tools. **
 ** Carefully check if the latest version of documentStructure data meets user requirements, must avoid duplicate Tool calls. **
-
-{% include "../../common/afs/use-afs-instruction.md" %}
 </instructions>