@aigne/doc-smith 0.8.15-beta.1 → 0.8.15-beta.11

package/agents/utils/load-sources.mjs

@@ -4,11 +4,11 @@ import path from "node:path";
 import imageSize from "image-size";
 import {
   buildSourcesContent,
-  calculateFileStats,
   loadFilesFromPaths,
   readFileContents,
   getMimeType,
-  checkIsRemoteFile,
+  isRemoteFile,
+  calculateTokens,
 } from "../../utils/file-utils.mjs";
 import {
   getCurrentGitHead,
@@ -21,6 +21,7 @@ import {
   DEFAULT_INCLUDE_PATTERNS,
 } from "../../utils/constants/index.mjs";
 import { isOpenAPISpecFile } from "../../utils/openapi/index.mjs";
+import { loadDocumentStructure } from "../../utils/docs-finder-utils.mjs";
 
 export default async function loadSources(
   {
@@ -144,7 +145,7 @@ export default async function loadSources(
     files.map(async (file) => {
       const ext = path.extname(file).toLowerCase();
 
-      if (mediaExtensions.includes(ext) && !checkIsRemoteFile(file)) {
+      if (mediaExtensions.includes(ext) && !isRemoteFile(file)) {
         // This is a media file
         const relativePath = path.relative(docsDir, file);
         const fileName = path.basename(file);
@@ -170,7 +171,7 @@ export default async function loadSources(
             if (dimensions.width < minImageWidth) {
               filteredImageCount++;
               console.log(
-                `Filtered image: ${fileName} (${dimensions.width}x${dimensions.height}px < ${minImageWidth}px minimum)`,
+                `Ignored image: ${fileName} (${dimensions.width}x${dimensions.height}px < ${minImageWidth}px minimum)`,
               );
               return;
             }
@@ -195,13 +196,10 @@ export default async function loadSources(
   }
 
   // Read all source files using the utility function
-  let sourceFiles = await readFileContents(sourceFilesPaths, process.cwd());
-
-  // Count tokens and lines using utility function
-  const { totalTokens, totalLines } = calculateFileStats(sourceFiles);
-
-  // check if totalTokens is too large
-  const isLargeContext = totalTokens > INTELLIGENT_SUGGESTION_TOKEN_THRESHOLD;
+  let sourceFiles = (await readFileContents(sourceFilesPaths, process.cwd())).map((i) => ({
+    ...i,
+    tokens: calculateTokens(`\n${i.sourceId}\n${i.content}`),
+  }));
 
   // filter OpenAPI doc should after check isLargeContext
   sourceFiles = sourceFiles.filter((file) => {
@@ -214,48 +212,32 @@ export default async function loadSources(
     return !isOpenAPI;
   });
 
-  const httpFileList = [];
+  const totalTokens = sourceFiles.reduce((sum, file) => sum + file.tokens, 0);
+  const totalLines = sourceFiles.reduce(
+    (sum, file) => sum + file.content.split("\n").filter(Boolean).length,
+    0,
+  );
+
+  const dataSources = splitSourcesToChunks(sourceFiles, INTELLIGENT_SUGGESTION_TOKEN_THRESHOLD).map(
+    (i) => ({ dataSourceChunk: buildSourcesContent(i) }),
+  );
+
+  const remoteFileList = [];
 
   sourceFiles.forEach((file) => {
-    if (checkIsRemoteFile(file.sourceId)) {
-      httpFileList.push(file);
+    if (isRemoteFile(file.sourceId)) {
+      remoteFileList.push(file);
     }
   });
   if (options?.context?.userContext) {
-    options.context.userContext.httpFileList = httpFileList;
+    options.context.userContext.remoteFileList = remoteFileList;
   }
 
-  // Build allSources string using utility function
-  const allSources = buildSourcesContent(sourceFiles, isLargeContext);
   // all files path
   const allFilesPaths = sourceFiles.map((x) => `- ${toRelativePath(x.sourceId)}`).join("\n");
 
   // Get the last documentation structure
-  let originalDocumentStructure;
-  if (outputDir) {
-    const documentStructurePath = path.join(outputDir, "structure-plan.json");
-    try {
-      const documentExecutionStructure = await readFile(documentStructurePath, "utf8");
-      if (documentExecutionStructure?.trim()) {
-        try {
-          // Validate that the content looks like JSON before parsing
-          const trimmedContent = documentExecutionStructure.trim();
-          if (trimmedContent.startsWith("{") || trimmedContent.startsWith("[")) {
-            originalDocumentStructure = JSON.parse(documentExecutionStructure);
-          } else {
-            console.warn(`structure-plan.json contains non-JSON content, skipping parse`);
-          }
-        } catch (err) {
-          console.error(`Failed to parse structure-plan.json: ${err.message}`);
-        }
-      }
-    } catch (err) {
-      if (err.code !== "ENOENT") {
-        console.warn(`Error reading structure-plan.json: ${err.message}`);
-      }
-      // The file does not exist or is not readable, originalDocumentStructure remains undefined
-    }
-  }
+  const originalDocumentStructure = await loadDocumentStructure(outputDir);
 
   // Get the last output result of the specified path
   let content;
@@ -308,7 +290,7 @@ export default async function loadSources(
   }
 
   return {
-    datasources: allSources,
+    dataSources,
     content,
     originalDocumentStructure,
     files,
@@ -316,7 +298,6 @@ export default async function loadSources(
     totalTokens,
     totalLines,
     mediaFiles,
-    isLargeContext,
     allFilesPaths,
   };
 }
@@ -364,8 +345,14 @@ loadSources.input_schema = {
 loadSources.output_schema = {
   type: "object",
   properties: {
-    datasources: {
-      type: "string",
+    dataSources: {
+      type: "array",
+      items: {
+        type: "object",
+        properties: {
+          dataSourceChunk: { type: "string" },
+        },
+      },
     },
     files: {
       type: "array",
@@ -396,3 +383,33 @@ loadSources.output_schema = {
 };
 
 loadSources.task_render_mode = "hide";
+
+function splitSourcesToChunks(sources, maxTokens) {
+  const chunks = [];
+
+  let currentChunk = [];
+  let currentTokens = 0;
+
+  for (const source of sources) {
+    const sourceTokens = source.tokens;
+
+    if (currentTokens + sourceTokens > maxTokens) {
+      // Start a new chunk
+      if (currentChunk.length > 0) {
+        chunks.push(currentChunk);
+      }
+      currentChunk = [source];
+      currentTokens = sourceTokens;
+    } else {
+      // Add to current chunk
+      currentChunk.push(source);
+      currentTokens += sourceTokens;
+    }
+  }
+
+  if (currentChunk.length > 0) {
+    chunks.push(currentChunk);
+  }
+
+  return chunks;
+}

package/agents/utils/{save-docs.mjs → post-generate.mjs}

@@ -1,4 +1,4 @@
-import { readdir, unlink, writeFile } from "node:fs/promises";
+import { readdir, unlink } from "node:fs/promises";
 import { join } from "node:path";
 import { shutdownMermaidWorkerPool } from "../../utils/mermaid-worker-pool.mjs";
 import { getCurrentGitHead, saveGitHeadToConfig } from "../../utils/utils.mjs";
@@ -10,7 +10,7 @@ import { getCurrentGitHead, saveGitHeadToConfig } from "../../utils/utils.mjs";
  * @param {Array<string>} [params.translateLanguages] - Translation languages
  * @returns {Promise<Array<{ path: string, success: boolean, error?: string }>>}
  */
-export default async function saveDocs({
+export default async function postGenerate({
   documentExecutionStructure: documentStructure,
   docsDir,
   translateLanguages = [],
@@ -26,15 +26,6 @@ export default async function saveDocs({
     console.warn("Failed to save git HEAD:", err.message);
   }
 
-  // Generate _sidebar.md
-  try {
-    const sidebar = generateSidebar(documentStructure);
-    const sidebarPath = join(docsDir, "_sidebar.md");
-    await writeFile(sidebarPath, sidebar, "utf8");
-  } catch (err) {
-    console.error("Failed to save _sidebar.md:", err.message);
-  }
-
   // Clean up invalid .md files that are no longer in the documentation structure
   try {
     await cleanupInvalidFiles(documentStructure, docsDir, translateLanguages, locale);
@@ -140,43 +131,3 @@ async function cleanupInvalidFiles(documentStructure, docsDir, translateLanguage
 }
 
 // Generate sidebar content, support nested structure, and the order is consistent with documentStructure
-function generateSidebar(documentStructure) {
-  // Build tree structure
-  const root = {};
-  for (const { path, title, parentId } of documentStructure) {
-    const relPath = path.replace(/^\//, "");
-    const segments = relPath.split("/");
-    let node = root;
-    for (let i = 0; i < segments.length; i++) {
-      const seg = segments[i];
-      if (!node[seg])
-        node[seg] = {
-          __children: {},
-          __title: null,
-          __fullPath: segments.slice(0, i + 1).join("/"),
-          __parentId: parentId,
-        };
-      if (i === segments.length - 1) node[seg].__title = title;
-      node = node[seg].__children;
-    }
-  }
-  // Recursively generate sidebar text, the link path is the flattened file name
-  function walk(node, parentSegments = [], indent = "") {
-    let out = "";
-    for (const key of Object.keys(node)) {
-      const item = node[key];
-      const fullSegments = [...parentSegments, key];
-      const flatFile = `${fullSegments.join("-")}.md`;
-      if (item.__title) {
-        const realIndent = item.__parentId === null ? "" : indent;
-        out += `${realIndent}* [${item.__title}](/${flatFile})\n`;
-      }
-      const children = item.__children;
-      if (Object.keys(children).length > 0) {
-        out += walk(children, fullSegments, `${indent}  `);
-      }
-    }
-    return out;
-  }
-  return walk(root).replace(/\n+$/, "");
-}

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

@@ -0,0 +1,27 @@
+import { saveDocTranslation as _saveDocTranslation } from "../../utils/utils.mjs";
+
+export default async function saveDocTranslation({
+  path,
+  docsDir,
+  translation,
+  language,
+  labels,
+  isShowMessage = false,
+}) {
+  await _saveDocTranslation({
+    path,
+    docsDir,
+    language,
+    translation,
+    labels,
+  });
+
+  if (isShowMessage) {
+    const message = `✅ Translation completed successfully.`;
+    return { message };
+  }
+
+  return {};
+}
+
+saveDocTranslation.task_render_mode = "hide";

package/agents/utils/{save-single-doc.mjs → save-doc.mjs}

@@ -1,24 +1,22 @@
 import { shutdownMermaidWorkerPool } from "../../utils/mermaid-worker-pool.mjs";
-import { saveDocWithTranslations } from "../../utils/utils.mjs";
+import { saveDoc as _saveDoc } from "../../utils/utils.mjs";
 
-export default async function saveSingleDoc({
+export default async function saveDoc({
   path,
   content,
   docsDir,
-  translates,
   labels,
   locale,
-  isTranslate = false,
+  feedback,
   isShowMessage = false,
+  ...rest
 }) {
-  const _results = await saveDocWithTranslations({
+  await _saveDoc({
     path,
     content,
     docsDir,
-    translates,
     labels,
     locale,
-    isTranslate,
   });
 
   if (isShowMessage) {
@@ -29,13 +27,20 @@ export default async function saveSingleDoc({
       console.warn("Failed to shutdown mermaid worker pool:", error.message);
     }
 
-    const message = isTranslate
-      ? `✅ Translation completed successfully`
-      : `✅ Document updated successfully`;
+    const message = `✅ Document updated successfully.`;
     return { message };
   }
 
-  return {};
+  return {
+    path,
+    content,
+    docsDir,
+    labels,
+    locale,
+    feedback,
+    isShowMessage,
+    ...rest,
+  };
 }
 
-saveSingleDoc.task_render_mode = "hide";
+saveDoc.task_render_mode = "hide";

package/agents/utils/save-sidebar.mjs

@@ -0,0 +1,38 @@
+import { join } from "node:path";
+import fs from "fs-extra";
+import { buildDocumentTree } from "../../utils/docs-finder-utils.mjs";
+
+export default async function saveSidebar({ documentStructure, docsDir }) {
+  // Generate _sidebar.md
+  try {
+    const sidebar = generateSidebar(documentStructure);
+    const sidebarPath = join(docsDir, "_sidebar.md");
+
+    await fs.ensureDir(docsDir);
+    await fs.writeFile(sidebarPath, sidebar, "utf8");
+  } catch (err) {
+    console.error("Failed to save _sidebar.md:", err.message);
+  }
+  return {};
+}
+
+// Recursively generate sidebar text, the link path is the flattened file name
+function walk(nodes, indent = "") {
+  let out = "";
+  for (const node of nodes) {
+    const relPath = node.path.replace(/^\//, "");
+    const flatFile = `${relPath.split("/").join("-")}.md`;
+    const realIndent = node.parentId === null ? "" : indent;
+    out += `${realIndent}* [${node.title}](/${flatFile})\n`;
+
+    if (node.children && node.children.length > 0) {
+      out += walk(node.children, `${indent}  `);
+    }
+  }
+  return out;
+}
+
+function generateSidebar(documentStructure) {
+  const { rootNodes } = buildDocumentTree(documentStructure);
+  return walk(rootNodes).replace(/\n+$/, "");
+}

package/agents/utils/{transform-detail-datasources.mjs → transform-detail-data-sources.mjs}

@@ -1,11 +1,11 @@
 import fs from "node:fs";
+import { isRemoteFile } from "../../utils/file-utils.mjs";
 import { normalizePath, toRelativePath } from "../../utils/utils.mjs";
-import { checkIsRemoteFile } from "../../utils/file-utils.mjs";
 
-export default function transformDetailDatasources({ sourceIds }, options = {}) {
+export default function transformDetailDataSource({ sourceIds }, options = {}) {
   // Read file content for each sourceId, ignoring failures
   let openAPISpec;
-  const httpFileList = options?.context?.userContext?.httpFileList || [];
+  const remoteFileList = options?.context?.userContext?.remoteFileList || [];
   const contents = (sourceIds || [])
     .filter((id) => {
       const openApiSourceId = options?.context?.userContext?.openAPISpec?.sourceId;
@@ -17,8 +17,8 @@ export default function transformDetailDatasources({ sourceIds }, options = {})
     })
     .map((id) => {
       try {
-        if (checkIsRemoteFile(id)) {
-          const findFile = httpFileList.find((f) => f.sourceId === id);
+        if (isRemoteFile(id)) {
+          const findFile = remoteFileList.find((f) => f.sourceId === id);
           if (findFile) {
             return `// sourceId: ${id}\n${findFile.content}\n`;
           }
@@ -37,9 +37,9 @@ export default function transformDetailDatasources({ sourceIds }, options = {})
     .filter(Boolean);
 
   return {
-    detailDataSources: contents.join(""),
+    detailDataSource: contents.join(""),
     openAPISpec,
   };
 }
 
-transformDetailDatasources.task_render_mode = "hide";
+transformDetailDataSource.task_render_mode = "hide";

package/aigne.yaml

@@ -1,8 +1,9 @@
 #!/usr/bin/env aigne
 
-chat_model:
-  provider: google
-  name: gemini-2.5-pro
+model:
+  model: aignehub/gemini-2.5-pro # reasoning_effort 128-32768
+  # https://github.com/AIGNE-io/aigne-framework/blob/main/models/gemini/src/gemini-chat-model.ts#L115
+  reasoning_effort: 502
   # name: gemini-2.5-flash
   temperature: 0.8
 agents:
@@ -11,14 +12,13 @@ agents:
 
   # Documentation Structure Generation
   - ./agents/generate/generate-structure.yaml
-  - ./agents/generate/generate-structure-without-tools.yaml
   - ./agents/generate/update-document-structure.yaml
   - ./agents/generate/check-need-generate-structure.mjs
   - ./agents/generate/refine-document-structure.yaml
   - ./agents/generate/check-document-structure.yaml
   - ./agents/generate/user-review-document-structure.mjs
   - ./agents/generate/index.yaml
-  
+
   # Documentation Structure Tools
   - ./agents/generate/document-structure-tools/add-document.mjs
   - ./agents/generate/document-structure-tools/delete-document.mjs
@@ -47,6 +47,7 @@ agents:
 
   # Publishing
   - ./agents/publish/publish-docs.mjs
+  - ./agents/publish/translate-meta.mjs
   - ./agents/publish/index.yaml
 
   # Media
@@ -65,9 +66,11 @@ agents:
 
   # Utilities
   - ./agents/utils/load-sources.mjs
-  - ./agents/utils/save-docs.mjs
-  - ./agents/utils/transform-detail-datasources.mjs
-  - ./agents/utils/save-single-doc.mjs
+  - ./agents/utils/post-generate.mjs
+  - ./agents/utils/save-sidebar.mjs
+  - ./agents/utils/transform-detail-data-sources.mjs
+  - ./agents/utils/save-doc.mjs
+  - ./agents/utils/save-doc-translation.mjs
   - ./agents/utils/save-output.mjs
   - ./agents/utils/format-document-structure.mjs
   - ./agents/utils/find-item-by-path.mjs
@@ -92,6 +95,11 @@ agents:
   - ./agents/evaluate/document-structure.yaml
   - ./agents/evaluate/document.yaml
   - ./agents/evaluate/code-snippet.mjs
+
+  # Diagram
+  - ./agents/generate/merge-diagram.yaml
+  - ./agents/update/generate-diagram.yaml
+  - ./agents/update/check-generate-diagram.mjs
 cli:
   chat: ./agents/chat/index.yaml
   agents:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.8.15-beta.1",
+  "version": "0.8.15-beta.11",
   "description": "AI-driven documentation generation tool built on the AIGNE Framework",
   "publishConfig": {
     "access": "public"
@@ -48,6 +48,7 @@
     "marked": "^15.0.12",
     "marked-terminal": "^7.3.0",
     "mermaid": "^11.9.0",
+    "minimatch": "^10.1.1",
     "open": "^10.2.0",
     "p-limit": "^7.1.1",
     "p-map": "^7.0.3",
@@ -56,6 +57,7 @@
     "remark-lint": "^10.0.1",
     "remark-parse": "^11.0.0",
     "terminal-link": "^4.0.0",
+    "typescript": "^5.9.3",
     "ufo": "^1.6.1",
     "unified": "^11.0.5",
     "unist-util-visit": "^5.0.0",

package/prompts/common/document/content-rules-core.md

@@ -2,12 +2,12 @@ Target Audience: {{targetAudience}}
 
 Content Generation Rules:
 
-- Use only information from DataSources, never fabricate or supplement content not present in the sources
+- Use only information from `<detail_data_source>`, never fabricate or supplement content not present in the sources
 - Combine the current {{nodeName}} title and description to create a well-structured content plan that is rich, organized, and engaging
 - Content style must match the target audience
-- Clearly differentiate content from other {{nodeName}} items in the documentStructure to avoid duplication and highlight this {{nodeName}}'s unique value
+- Clearly differentiate content from other {{nodeName}} items in the `<document_structure>` to avoid duplication and highlight this {{nodeName}}'s unique value
 {% if enforceInfoCompleteness %}
-- If DataSources lack sufficient information, return an error message requesting users to provide additional content. Ensure page content is sufficiently rich, don't hesitate to ask users for supplementary information
+- If `<detail_data_source>` lack sufficient information, return an error message requesting users to provide additional content. Ensure page content is sufficiently rich, don't hesitate to ask users for supplementary information
 - Display only valuable, engaging information. If information is insufficient, prompt users to provide more details
 {% endif %}
 - Output complete information including all content planned for the {{nodeName}}
@@ -15,6 +15,6 @@ Content Generation Rules:
 - Maintain a strict, sequential heading hierarchy; no skipping (e.g., no jump from level-1 to level-3).
 - Format markdown output with proper line breaks and spacing for easy reading
 - For list data with many items, prioritize using markdown table for cleaner, more readable presentation
-- Do not mention 'DataSources' in output, your content is for user consumption, and users are unaware of DataSources
-- Do not include file paths from Data Sources in output as they are meaningless to users
-- Avoid phrases like 'current {{nodeName}}'
+- Do not mention `<detail_data_source>` in output, your content is for user consumption, and users are unaware of detailDataSource
+- Do not include file paths from `<data_sources>` in output as they are meaningless to users
+- Avoid phrases like 'current {{nodeName}}'

package/prompts/common/document/media-file-list-usage-rules.md

@@ -0,0 +1,12 @@
+<media_file_list_usage_rules>
+
+**Usage Workflow**
+1. Read the `<media_file_list>` data and take note of each file's `path` and `description` as references.
+2. Combine those descriptions with the current document's content to decide which images should be used and where they should be inserted.
+3. Confirm that every inserted image path comes from `<media_file_list>`. If a path is missing from that list, replace it with one that is included.
+
+**Usage Requirements**
+- Insert images with Markdown syntax: `![Descriptive alt text](<path-from-media_file_list>)`.
+- Never invent, reinterpret, fabricate, normalize, or rewrite any media file path under any circumstances.
+
+</media_file_list_usage_rules>

package/prompts/common/document/openapi-usage-rules.md

@@ -0,0 +1,36 @@
+{% if openAPISpec %}
+<openapi_usage_rules>
+
+**Goal:** Use the provided OpenAPI (Swagger) specification, align it with the current page objective, and leverage it to refine this document.
+
+**OpenAPI File Content:** 
+<openapi_doc>
+
+{{ openAPISpec }}
+
+</openapi_doc>
+
+---
+
+### **Documentation Requirements and Constraints**
+
+1.  **Extract the core content:**
+    * Organize the document by functional modules.
+    * For each path item, include the following elements:
+        * HTTP method and path.
+        * Concise summary.
+        * Detailed description.
+        * Request parameters: name, location (`in`), type, required flag, description.
+        * Request body: describe its structure when present.
+        * Responses: at least the key status codes (e.g., 200, 201, 400, 500) and their schemas.
+
+2.  **Mandatory API description constraints (deduplication rule):**
+    * **Ensure that throughout the document (including preface, overview, etc.), any introduction to the project APIs appears only within this OpenAPI-generated "API reference" section.**
+    * **Never** repeat or expand the interface list elsewhere in the document (for example, "Quick Start" or "Architecture Overview" sections).
+
+---
+
+**Expected output format:** A concise, clear, and easy-to-scan Markdown document.
+
+</openapi_usage_rules>
+{% endif %}

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

@@ -13,5 +13,4 @@ Your key strengths include:
 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.
-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.
+5.  **Tool Utilization:** Actively call tools as needed, potentially multiple times, to obtain complete information from AFS (AIGNE File System).

package/prompts/common/document-structure/conflict-resolution-guidance.md

@@ -1,5 +1,5 @@
 <conflict_resolution_guidance>
-When users select potentially conflicting options, conflict resolution guidance will be provided in user_rules. Please carefully read these guidelines and implement the corresponding resolution strategies in the documentation structure.
+When users select potentially conflicting options, conflict resolution guidance will be provided in `<user_rules>`. Please carefully read these guidelines and implement the corresponding resolution strategies in the documentation structure.
 
 Core principles for conflict resolution:
 1. **Layered need satisfaction**: Simultaneously satisfy multiple purposes and audiences through reasonable documentation structure hierarchy
@@ -13,4 +13,4 @@ Common conflict resolution patterns:
 - **Depth conflicts**: Adopt progressive structures that allow users to choose appropriate depth levels
 
 When generating documentation structure, prioritize conflict resolution strategies to ensure the final structure can harmoniously satisfy all user needs.
-</conflict_resolution_guidance>
+</conflict_resolution_guidance>

package/prompts/common/document-structure/document-structure-rules.md

@@ -1,18 +1,18 @@
 <document_structure_rules>
 The target audience for this document is: {{targetAudience}}
 
-DataSources usage rules:
-1. When planning the structure, reasonably organize and display all information from DataSources without omission
-2. Users may provide limited DataSources. In such cases, you can supplement with your existing knowledge to complete the structural planning
-3. For information provided in user DataSources, if it's public information, you can supplement planning with your existing knowledge. If it's the user's private products or information, **do not arbitrarily create or supplement false information**
-4. If DataSources don't match the target audience, you need to reframe the DataSources to match the target audience
+`<data_sources>` usage rules:
+1. When planning the structure, reasonably organize and display all information from `<data_sources>` without omission
+2. Users may provide limited `<data_sources>`. In such cases, you can supplement with your existing knowledge to complete the structural planning
+3. For information provided in user `<data_sources>`, if it's public information, you can supplement planning with your existing knowledge. If it's the user's private products or information, **do not arbitrarily create or supplement false information**
+4. If `<data_sources>` don't match the target audience, you need to reframe the `<data_sources>` to match the target audience
 
 Structural planning rules:
 
 1. {{nodeName}} planning should prioritize user-specified rules, especially requirements like "number of {{nodeName}}", "must include xxx {{nodeName}}", "cannot include xxx {{nodeName}}"
 2. {{nodeName}} planning should display as much information as possible from the user-provided context
 3. Structure planning should have reasonable hierarchical relationships, with content planned at appropriate levels, avoiding flat layouts with numerous {{nodeName}} items
-4. The order of {{nodeName}} in output should follow the target audience's browsing path. It doesn't need to follow the exact order in DataSources—progress from simple to advanced, from understanding to exploration, with reasonable pathways
+4. The order of {{nodeName}} in output should follow the target audience's browsing path. It doesn't need to follow the exact order in `<data_sources>` progress from simple to advanced, from understanding to exploration, with reasonable pathways
 5. Each {{nodeName}} should have a clear content plan and must not duplicate content from other {{nodeName}} items
 6. Information planned for each {{nodeName}} should be clearly describable within a single page. If there's too much information to display or the concepts are too broad, consider splitting into sub-{{nodeName}} items
 7. If previous documentation structure and user feedback are provided, make only necessary modifications based on user feedback without major changes
@@ -26,7 +26,7 @@ Structural planning rules:
 - Title
 - Description of the important information this {{nodeName}} plans to display, with descriptions tailored to the target audience
 
-2. Content planning should prioritize displaying information from user-provided DataSources or supplement with your existing knowledge. Do not arbitrarily fabricate information.
+2. Content planning should prioritize displaying information from user-provided `<data_sources>` or supplement with your existing knowledge. Do not arbitrarily fabricate information.
 
 {% ifAsync docsType == 'general' %}
   {% include "../../structure/document-rules.md" %}
@@ -41,4 +41,4 @@ Other requirements:
 
 1. Must satisfy user specified rules
 2. Return information using the user's language {{locale}}
-</document_structure_rules>
+</document_structure_rules>

package/prompts/common/document-structure/output-constraints.md

@@ -1,9 +1,9 @@
 <output_constraints>
 
-1. Associated sourceIds should be as comprehensive as possible. You can include as many related datasources as possible.
-  - If datasources contain source code, **include as much related and adjacent source code as possible** to ensure quality of subsequent detail generation.
+1. Associated sourceIds should be as comprehensive as possible. You can include as many related `<data_sources>` as possible.
+  - If `<data_sources>` contain source code, **include as much related and adjacent source code as possible** to ensure quality of subsequent detail generation.
   - First identify the most relevant source code files, then analyze the source code referenced within them. Referenced file paths, referenced files, and files in referenced paths all need to be included in sourceIds
   - For referenced files, analyze another layer of source code files referenced within them and add to sourceIds to ensure complete context for detail generation
 2. **Ensure sourceIds are never empty**. Do not plan {{nodeName}} items without related data sources
 
-</output_constraints>
+</output_constraints>