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

package/.aigne/doc-smith/config.yaml

@@ -67,8 +67,6 @@ docsDir: ./docs  # Directory to save generated documentation
 sourcesPath:  # Source code paths to analyze
   - ./
 lastGitHead: f3f14b93e6b2e6beb42b2f368c2560ab050dfd03
-appUrl: https://docsmith.aigne.io
 # ⚠️ Warning: boardId is auto-generated by system, please do not edit manually
 boardId: "docsmith"
-# Checkout ID for document deployment service
-checkoutId: ""
+appUrl: https://docsmith.aigne.io

package/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.8.11-beta.3"
+  ".": "0.8.11-beta.5"
 }

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [0.8.11-beta.5](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.11-beta.4...v0.8.11-beta.5) (2025-10-01)
+
+
+### Features
+
+* add user role requirement for publish and custom rule support ([#151](https://github.com/AIGNE-io/aigne-doc-smith/issues/151)) ([95866f9](https://github.com/AIGNE-io/aigne-doc-smith/commit/95866f9fcb2ca697da42e950e9011b29913726d4))
+* split d2 diagram generate as independent tool ([#152](https://github.com/AIGNE-io/aigne-doc-smith/issues/152)) ([8e9b811](https://github.com/AIGNE-io/aigne-doc-smith/commit/8e9b811dc6108bb19ab8a1853afb4cab92af1d62))
+
+## [0.8.11-beta.4](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.11-beta.3...v0.8.11-beta.4) (2025-09-30)
+
+
+### Features
+
+* add check-only option for agents with selection input ([#147](https://github.com/AIGNE-io/aigne-doc-smith/issues/147)) ([3340988](https://github.com/AIGNE-io/aigne-doc-smith/commit/3340988e67ffef7e1087d560930b3cf98c860693))
+
+
+### Bug Fixes
+
+* improve error handling in choose-docs utility ([#145](https://github.com/AIGNE-io/aigne-doc-smith/issues/145)) ([7052ffc](https://github.com/AIGNE-io/aigne-doc-smith/commit/7052ffc106817144bff815422dced7faa4dfc3e8))
+* translation prompt tuned; translate comments only in code blocks ([#149](https://github.com/AIGNE-io/aigne-doc-smith/issues/149)) ([30ce2c0](https://github.com/AIGNE-io/aigne-doc-smith/commit/30ce2c0e43c01b6588b4ada84aafecfd83c1b23b))
+
 ## [0.8.11-beta.3](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.11-beta.2...v0.8.11-beta.3) (2025-09-29)
 
 

package/agents/clear/index.yaml

@@ -7,6 +7,7 @@ skills:
   - url: ../init/index.mjs
     default_input:
       skipIfExists: true
+      checkOnly: true
   - ./choose-contents.mjs
 input_schema:
   type: object

package/agents/evaluate/index.yaml

@@ -5,6 +5,7 @@ skills:
   - url: ../init/index.mjs
     default_input:
       skipIfExists: true
+      checkOnly: true
   - ../utils/load-sources.mjs
   - ../utils/format-document-structure.mjs
   - type: transform

package/agents/generate/check-d2-diagram-valid.mjs

@@ -0,0 +1,26 @@
+import { checkContent } from "../../utils/d2-utils.mjs";
+
+export default async function checkD2DiagramIsValid({ d2DiagramSourceCode }) {
+  try {
+    await checkContent({ content: d2DiagramSourceCode });
+    return {
+      isValid: true,
+    };
+  } catch (err) {
+    return {
+      isValid: false,
+      error: err.message,
+    };
+  }
+}
+
+checkD2DiagramIsValid.input_schema = {
+  type: "object",
+  properties: {
+    d2DiagramSourceCode: {
+      type: "string",
+      description: "Source code of d2 diagram",
+    },
+  },
+  required: ["d2DiagramSourceCode"],
+};

package/agents/generate/generate-d2-diagram.yaml

@@ -0,0 +1,23 @@
+name: drawD2Diagram
+description: Generate a D2 diagram from document content.
+instructions:
+  - role: system
+    url: ../../prompts/detail/d2-diagram/rules-system.md
+  - role: user
+    url: ../../prompts/detail/d2-diagram/rules-user.md
+input_schema:
+  type: object
+  properties:
+    documentContent:
+      type: string
+      description: Source code of current document (without the D2 diagram)
+  required:
+    - documentContent
+output_schema:
+  type: object
+  properties:
+    d2DiagramSourceCode:
+      type: string
+      description: Source code to draw D2 diagram
+  required:
+    - d2DiagramSourceCode

package/agents/generate/merge-d2-diagram.yaml

@@ -0,0 +1,39 @@
+name: mergeD2DiagramToDocument
+description: Merge D2 Diagram source code into document
+instructions: |
+  You are an AI assistant that helps to merge d2 diagram into document.
+
+  <datasources>
+  {{ content }}
+  </datasources>
+  <datasources>
+  {{ d2DiagramSourceCode }}
+  </datasources>
+
+  Given the source content of a document and the D2 diagram source code, your task is to:
+  - **Keep the original content as soon as possible.**
+  - D2 diagram source code should wrap by ```d2 and ``` in markdown format.
+  - Should find proper position to insert the D2 diagram in the document, usually after the first paragraph or after the section that describes the diagram.
+  - If there is no suitable position, append it to the end of the document.
+  - If there is no D2 diagram source code, return the original document content without any changes.
+input_schema:
+  type: object
+  properties:
+    content:
+      type: string
+      description: Source content of the document
+    d2DiagramSourceCode:
+      type: string
+      description: Source content of D2 Diagram
+  required:
+    - content
+    - d2DiagramSourceCode
+output_schema:
+  type: object
+  properties:
+    content:
+      type: string
+      description: Merged content of the document with D2 diagram
+  required:
+    - content
+

package/agents/init/index.mjs

@@ -32,9 +32,32 @@ const _PRESS_ENTER_TO_FINISH = "Press Enter to finish";
  * @returns {Promise<Object>}
  */
 export default async function init(
-  { outputPath = ".aigne/doc-smith", fileName = "config.yaml", skipIfExists = false, appUrl },
+  {
+    outputPath = ".aigne/doc-smith",
+    fileName = "config.yaml",
+    skipIfExists = false,
+    appUrl,
+    checkOnly = false,
+  },
   options,
 ) {
+  // Check if we're in checkOnly mode
+  if (checkOnly) {
+    const filePath = join(outputPath, fileName);
+    const configContent = await readFile(filePath, "utf8").catch(() => null);
+
+    if (!configContent || configContent.trim() === "") {
+      console.log(`⚠️ No configuration found.`);
+      console.log(
+        `🚀 Run ${chalk.cyan("aigne doc init")} to set up your documentation configuration.`,
+      );
+      process.exit(0);
+    }
+
+    // Config exists, load and return it
+    return loadConfig({ config: filePath, appUrl });
+  }
+
   if (skipIfExists) {
     const filePath = join(outputPath, fileName);
     const configContent = await readFile(filePath, "utf8").catch(() => null);
@@ -53,7 +76,7 @@ export default async function init(
 
   // 1. Primary purpose - what's the main outcome you want readers to achieve?
   const purposeChoices = await options.prompts.checkbox({
-    message: "📝 [1/8]: What should your documentation help readers achieve?",
+    message: "📝 [1/9]: What should your documentation help readers achieve?",
     choices: Object.entries(DOCUMENT_STYLES)
       .filter(([key]) => key !== "custom") // Remove custom option for multiselect
       .map(([key, style]) => ({
@@ -101,7 +124,7 @@ export default async function init(
 
   // 2. Target audience - who will be reading this most often?
   const audienceChoices = await options.prompts.checkbox({
-    message: "👥 [2/8]: Who will be reading your documentation?",
+    message: "👥 [2/9]: Who will be reading your documentation?",
     choices: Object.entries(TARGET_AUDIENCES)
       .filter(([key]) => key !== "custom") // Remove custom option for multiselect
       .map(([key, audience]) => ({
@@ -120,7 +143,15 @@ export default async function init(
   // Save target audience choices as keys
   input.targetAudienceTypes = audienceChoices;
 
-  // 3. Reader knowledge level - what do readers typically know when they arrive?
+  // 3. Custom rules - any specific requirements for the documentation?
+  const rulesInput = await options.prompts.input({
+    message:
+      "📋 [3/9]: Any custom rules or requirements for your documentation? (Optional, press Enter to skip)",
+    default: "",
+  });
+  input.rules = rulesInput.trim();
+
+  // 4. Reader knowledge level - what do readers typically know when they arrive?
   // Determine default based on selected purposes using mapping
   const mappedPurpose = prioritizedPurposes.find(
     (purpose) => PURPOSE_TO_KNOWLEDGE_MAPPING[purpose],
@@ -135,7 +166,7 @@ export default async function init(
   );
 
   const knowledgeChoice = await options.prompts.select({
-    message: "🧠 [3/8]: How much do readers already know about your project?",
+    message: "🧠 [4/9]: How much do readers already know about your project?",
     choices: Object.entries(filteredKnowledgeOptions).map(([key, level]) => ({
       name: `${level.name}`,
       description: level.description,
@@ -180,7 +211,7 @@ export default async function init(
   );
 
   const depthChoice = await options.prompts.select({
-    message: "📊 [4/8]: How detailed should your documentation be?",
+    message: "📊 [5/9]: How detailed should your documentation be?",
     choices: Object.entries(filteredDepthOptions).map(([key, depth]) => ({
       name: `${depth.name}`,
       description: depth.description,
@@ -198,7 +229,7 @@ export default async function init(
 
   // Let user select primary language from supported list
   const primaryLanguageChoice = await options.prompts.select({
-    message: "🌐 [5/8]: What's your main documentation language?",
+    message: "🌐 [6/9]: What's your main documentation language?",
     choices: SUPPORTED_LANGUAGES.map((lang) => ({
       name: `${lang.label} - ${lang.sample}`,
       value: lang.code,
@@ -215,7 +246,7 @@ export default async function init(
   );
 
   const translateLanguageChoices = await options.prompts.checkbox({
-    message: "🔄 [6/8]: Which languages should we translate to?",
+    message: "🔄 [7/9]: Which languages should we translate to?",
     choices: availableTranslationLanguages.map((lang) => ({
       name: `${lang.label} - ${lang.sample}`,
       value: lang.code,
@@ -226,13 +257,13 @@ export default async function init(
 
   // 7. Documentation directory
   const docsDirInput = await options.prompts.input({
-    message: `📁 [7/8]: Where should we save your documentation?`,
+    message: `📁 [8/9]: Where should we save your documentation?`,
     default: `${outputPath}/docs`,
   });
   input.docsDir = docsDirInput.trim() || `${outputPath}/docs`;
 
   // 8. Content sources
-  console.log("\n🔍 [8/8]: Content Sources");
+  console.log("\n🔍 [9/9]: Content Sources");
   console.log(
     "What folders/files should we analyze for documentation? (e.g., ./src, ./docs, ./README.md)",
   );
@@ -377,7 +408,7 @@ export function generateYAML(input) {
     documentationDepth: input.documentationDepth || "",
 
     // Custom rules and target audience (empty for user to fill)
-    rules: "",
+    rules: input.rules || "",
     targetAudience: "",
 
     // Language settings

package/agents/publish/index.yaml

@@ -8,6 +8,7 @@ skills:
   - url: ../init/index.mjs
     default_input:
       skipIfExists: true
+      checkOnly: true
   - publish-docs.mjs
 input_schema:
   type: object

package/agents/publish/publish-docs.mjs

@@ -5,13 +5,17 @@ import chalk from "chalk";
 import fs from "fs-extra";
 
 import { getAccessToken } from "../../utils/auth-utils.mjs";
-import { DISCUSS_KIT_STORE_URL, TMP_DIR, TMP_DOCS_DIR } from "../../utils/constants/index.mjs";
+import {
+  DEFAULT_APP_URL,
+  DISCUSS_KIT_STORE_URL,
+  DOC_SMITH_DIR,
+  TMP_DIR,
+  TMP_DOCS_DIR,
+} from "../../utils/constants/index.mjs";
 import { beforePublishHook, ensureTmpDir } from "../../utils/d2-utils.mjs";
 import { deploy } from "../../utils/deploy.mjs";
 import { getGithubRepoUrl, loadConfigFromFile, saveValueToConfig } from "../../utils/utils.mjs";
 
-const DEFAULT_APP_URL = "https://docsmith.aigne.io";
-
 export default async function publishDocs(
   { docsDir: rawDocsDir, appUrl, boardId, projectName, projectDesc, projectLogo },
   options,
@@ -19,9 +23,7 @@ export default async function publishDocs(
   // move work dir to tmp-dir
   await ensureTmpDir();
 
-  const hasDocSmithBaseUrl = !!process.env.DOC_SMITH_BASE_URL;
-
-  const docsDir = join(".aigne", "doc-smith", TMP_DIR, TMP_DOCS_DIR);
+  const docsDir = join(DOC_SMITH_DIR, TMP_DIR, TMP_DOCS_DIR);
   await fs.rm(docsDir, { recursive: true, force: true });
   await fs.mkdir(docsDir, {
     recursive: true,
@@ -61,22 +63,18 @@ export default async function publishDocs(
           name: `${chalk.blue("Your existing website")} - Integrate and publish directly on your current site (setup required)`,
           value: "custom",
         },
-        ...(hasCachedCheckoutId && hasDocSmithBaseUrl
+        ...(hasCachedCheckoutId
           ? [
               {
-                name: `${chalk.yellow("Resume previous website setup")} - ${chalk.green("Already paid.")} Continue where you left off. Your payment is already processed.`,
+                name: `${chalk.yellow("Resume previous website setup")} - ${chalk.green("Already paid.")} Continue where you left off. Your payment has already been processed.`,
                 value: "new-instance-continue",
               },
             ]
           : []),
-        ...(hasDocSmithBaseUrl
-          ? [
-              {
-                name: `${chalk.blue("New website")} - ${chalk.yellow("Paid service.")} We'll help you set up a brand-new website with custom domain and hosting. Great if you want a professional presence.`,
-                value: "new-instance",
-              },
-            ]
-          : []),
+        {
+          name: `${chalk.blue("New website")} - ${chalk.yellow("Paid service.")} We'll help you set up a brand-new website with custom domain and hosting. Great if you want a professional presence.`,
+          value: "new-instance",
+        },
       ],
     });
 
@@ -100,7 +98,7 @@ export default async function publishDocs(
       });
       // Ensure appUrl has protocol
       appUrl = userInput.includes("://") ? userInput : `https://${userInput}`;
-    } else if (hasDocSmithBaseUrl && ["new-instance", "new-instance-continue"].includes(choice)) {
+    } else if (["new-instance", "new-instance-continue"].includes(choice)) {
       // Deploy a new Discuss Kit service
       try {
         let id = "";
@@ -118,8 +116,7 @@ export default async function publishDocs(
         token = ltToken;
       } catch (error) {
         const errorMsg = error?.message || "Unknown error occurred";
-        console.error(`${chalk.red("❌ Failed to publish to website:")} ${errorMsg}`);
-        return { message: `❌ Publish failed: ${errorMsg}` };
+        return { message: `${chalk.red("❌ Failed to publish to website:")} ${errorMsg}` };
       }
     }
   }
@@ -168,7 +165,7 @@ export default async function publishDocs(
       boardDesc: projectInfo.description,
       boardCover: projectInfo.icon,
       mediaFolder: rawDocsDir,
-      cacheFilePath: join(".aigne", "doc-smith", "upload-cache.yaml"),
+      cacheFilePath: join(DOC_SMITH_DIR, "upload-cache.yaml"),
       boardMeta,
     });
 

package/agents/translate/index.yaml

@@ -5,6 +5,7 @@ skills:
   - url: ../init/index.mjs
     default_input:
       skipIfExists: true
+      checkOnly: true
   - ../utils/load-sources.mjs
   - type: transform
     task_render_mode: hide

package/agents/update/generate-document.yaml

@@ -48,3 +48,28 @@ output_schema:
       type: string
   required:
     - content
+skills:
+  - type: team
+    task_render_mode: collapse
+    name: generateD2DiagramContent
+    skills:
+      - ../generate/generate-d2-diagram.yaml
+    reflection:
+      reviewer: ../generate/check-d2-diagram-valid.mjs
+      is_approved: isValid
+      max_iterations: 5
+      return_last_on_max_iterations: true
+    input_schema:
+      type: object
+      properties:
+        documentContent:
+          type: string
+          description: Source code of current document (without the D2 diagram)
+      required:
+        - documentContent
+    output_schema:
+      type: object
+      properties:
+        d2DiagramSourceCode:
+          type: string
+          description: Source code for the D2 diagram

package/agents/update/index.yaml

@@ -7,6 +7,7 @@ skills:
   - url: ../init/index.mjs
     default_input:
       skipIfExists: true
+      checkOnly: true
   - ../utils/load-sources.mjs
   - type: transform
     task_render_mode: hide

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

@@ -1,6 +1,7 @@
 type: team
 name: updateSingleDocument
 skills:
+  - ../utils/transform-detail-datasources.mjs
   - ../update/user-review-document.mjs
   - type: transform
     task_render_mode: hide

package/agents/utils/choose-docs.mjs

@@ -34,18 +34,33 @@ export default async function chooseDocs(
       );
 
       if (mainLanguageFiles.length === 0) {
-        throw new Error("No documents found in the docs directory");
+        throw new Error(
+          "No documents found in the docs directory. Please run `aigne docs generate` to generate the documents",
+        );
       }
 
+      // Convert files to choices with titles
+      const choices = mainLanguageFiles.map((file) => {
+        // Convert filename to flat path to find corresponding document structure item
+        const flatName = file.replace(/\.md$/, "").replace(/\.\w+(-\w+)?$/, "");
+        const docItem = documentExecutionStructure.find((item) => {
+          const itemFlattenedPath = item.path.replace(/^\//, "").replace(/\//g, "-");
+          return itemFlattenedPath === flatName;
+        });
+
+        // Use title if available, otherwise fall back to filename
+        const displayName = docItem?.title || file;
+
+        return {
+          name: displayName,
+          value: file,
+        };
+      });
+
       // Let user select multiple files
       selectedFiles = await options.prompts.checkbox({
         message: getActionText(isTranslate, "Select documents to {action}:"),
         source: (term) => {
-          const choices = mainLanguageFiles.map((file) => ({
-            name: file,
-            value: file,
-          }));
-
           if (!term) return choices;
 
           return choices.filter((choice) => choice.name.toLowerCase().includes(term.toLowerCase()));
@@ -65,12 +80,8 @@ export default async function chooseDocs(
       // Process selected files and convert to found items
       foundItems = await processSelectedFiles(selectedFiles, documentExecutionStructure, docsDir);
     } catch (error) {
-      console.error(error);
       throw new Error(
-        getActionText(
-          isTranslate,
-          "Please provide a docs parameter to specify which documents to {action}",
-        ),
+        getActionText(isTranslate, `\nFailed to select documents to {action}: ${error.message}`),
       );
     }
   } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.8.11-beta.3",
+  "version": "0.8.11-beta.5",
   "description": "AI-driven documentation generation tool built on the AIGNE Framework",
   "publishConfig": {
     "access": "public"
@@ -19,7 +19,7 @@
     "@aigne/gemini": "^0.14.0",
     "@aigne/openai": "^0.16.0",
     "@aigne/publish-docs": "^0.11.0",
-    "@blocklet/payment-broker-client": "^1.20.20",
+    "@blocklet/payment-broker-client": "^1.21.5",
     "@terrastruct/d2": "^0.1.33",
     "chalk": "^5.5.0",
     "cli-highlight": "^2.1.11",

package/prompts/detail/{d2-chart/rules.md → d2-diagram/rules-system.md}

@@ -1,12 +1,51 @@
-<d2_generate_constraints>
 # D2 Diagram Generation Expert Guide
 
 ## Preamble: LLM Role and Core Objective
 
-You are an expert software architect and a master of the D2 (Declarative Diagramming) language. Your primary function is to translate abstract descriptions of software systems, components, and processes into precise, readable, and visually effective D2 diagram code.
+You are an AI diagram generator with the personality of an **ISTJ (The Logistician)**. 
+You are reliable, rule-abiding, and methodical. Your goal is to produce **clear, precise, and logically structured d2-diagram code** that accurately represents the given description. 
 
 Your core directive is to produce D2 code that is not only syntactically correct but also semantically meaningful and adheres to the highest standards of technical diagramming. The generated output must follow all instructions, constraints, and best practices detailed in this document. You will operate in a zero-tolerance mode for syntactical errors, especially concerning predefined keyword values. The fundamental principle is the separation of concerns: the logical structure of the diagram must be defined independently of its visual styling. The following chapters are structured to enforce this principle.
 
+You value **order, consistency, and factual accuracy** over abstract or decorative styles. 
+Your diagrams should focus on **readability, structural correctness, and practical use in technical documentation**.
+
+**ISTJ-style guiding principles for your diagram generation:**
+
+1. **Fact-Driven and Accurate:**  
+   - Adhere strictly to the provided description and rules.  
+   - Do not assume or add elements that are not explicitly described.  
+
+2. **Structured and Orderly:**  
+   - Organize diagram elements in a logical, hierarchical order (e.g., top-down for processes, left-to-right for data flows).  
+   - Group related nodes consistently.  
+   - Maintain clear flow and avoid unnecessary crossing lines.  
+
+3. **Clarity and Precision:**  
+   - Use simple, standard shapes and consistent node labeling.  
+   - Ensure every arrow or connection has a clear meaning (e.g., data flow, control flow).  
+   - Avoid ambiguous or decorative text.  
+
+4. **Standards and Consistency:**  
+   - Follow best practices for technical diagrams (e.g., rectangular boxes for processes, cylinders for data storage, labeled arrows for flows).  
+   - Maintain consistent spacing, alignment, and sizing in the diagram code.  
+
+5. **Practical and Maintainable:**  
+   - Ensure the generated d2 code is concise, easy to edit, and reproducible.  
+   - Provide comments in the d2 code (if necessary) to clarify sections or complex relationships.  
+   - Avoid unnecessary stylistic complexity that may hinder future maintenance.
+
+**Output Requirements:**
+- Output only valid d2-diagram code.
+- Do not include explanatory text outside of the code block.
+- Ensure the diagram reflects a clean, professional, ISTJ-style technical drawing.
+- output must be wrap with 
+```md
+\`\`\`d2\n...\n\`\`\`
+```
+
+
+
 ## Chapter 1: Core Instructions for D2 Diagram Generation
 
 This chapter establishes the foundational rules for generating the structure and logic of a D2 diagram. It prioritizes semantic correctness and adherence to diagramming principles over aesthetic concerns, which are addressed in Chapter 2.
@@ -1090,6 +1129,3 @@ Session.t2 -> Session.t2: "Update and remove status effects"
 Session.t2 -> Lua: "Trigger OnPlayerTurn"
 User.t2 <- Session.t2
 ```
-
-
-</d2_generate_constraints>

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

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

package/prompts/detail/document-rules.md

@@ -19,9 +19,8 @@ Documentation Generation Rules:
 - When describing multiple properties of the same object, wrap the outermost `<x-field>` elements with `<x-field-group>` elements. Note that nested `<x-field>` elements do not need wrapping
 - All interface and method documentation must include **response data examples**
 - For simple list data, use Markdown tables to present information clearly and improve readability
-- Validate output Markdown for completeness, ensuring tables and d2 diagrams are properly formatted
-- **Content Integrity**: Generate complete, syntactically correct code blocks (d2, JSON, etc.). Perform self-validation to ensure all code blocks, lists, and tables are properly closed without truncation
-- **Code Block Atomicity**: Treat code blocks (e.g., ```d2 ... ```) as indivisible units. Generate them completely from opening marker (```d2) to closing marker (```) without interruption
+- Validate output Markdown for completeness, ensuring tables are properly formatted
+- **Content Integrity**: Generate complete, syntactically correct code blocks (JSON, etc.). Perform self-validation to ensure all code blocks, lists, and tables are properly closed without truncation
 - **Markdown Syntax Validation**: Ensure correct Markdown formatting, particularly table separators (e.g., `|---|---|---|`) that match column counts
 - Use README files for reference only—extract the most current and comprehensive information directly from source code
 - Omit tag information from document headers as it's processed programmatically

package/prompts/detail/generate-document.md

@@ -37,8 +37,14 @@ Custom component generation rules:
 Custom code block generation rules:
 {% include "custom/custom-code-block.md" %}
 
-D2 Diagram Generation Expert Guide:
-{% include "d2-chart/rules.md" %}
+Diagram generate guide:
+Evaluate for each document whether diagrams are necessary.
+- Use diagrams to clarify complex concepts and diversify the presentation of the page.
+- The document overview page must include an architecture diagram that illustrates the entire document structure.
+- For the first page of each section, include a structural diagram of the current module when it adds clarity.
+- For individual article pages, consider detailed flowcharts when the content or overall architecture warrants them.
+- The number of diagrams is flexible, but aim for 0-3 diagrams as a practical range.
+
 </content_generation_rules>
 
 {% if glossary %}

package/prompts/detail/update-document.md

@@ -70,8 +70,6 @@ Custom component optimization rules:
 Custom code block optimization rules:
 {% include "custom/custom-code-block.md" %}
 
-D2 Diagram optimization rules:
-{% include "d2-chart/rules.md" %}
 </content_optimization_rules>
 
 {% if glossary %}
@@ -95,7 +93,7 @@ parentId: {{parentId}}
 </current_document>
 
 <datasources>
-{{ datasources }}
+{{ detailDataSources }}
 
 {{ additionalInformation }}
 

package/prompts/translate/code-block.md

@@ -0,0 +1,16 @@
+<code_block_rules>
+The following formats are considered Code Blocks:
+  - Wrapped with ```
+  - Supports configurations: language, title, icon, where title and icon are optional
+  - content can be code, command line examples, text or any other content
+
+<code_block_sample>
+```{language} [{title}] [icon={icon}]
+{content}
+```
+</code_block_sample>
+
+Code Block Translation: 
+- For D2 code blocks, only translate labels
+- For other language code blocks, **only translate comments starting with #, keep all other content unchanged without translation**
+</code_block_rules>