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

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## [0.8.16-beta.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.16-beta...v0.8.16-beta.1) (2025-11-11)
+
+
+### Features
+
+* add document icon generation functionality and update schemas ([#286](https://github.com/AIGNE-io/aigne-doc-smith/issues/286)) ([3e20fda](https://github.com/AIGNE-io/aigne-doc-smith/commit/3e20fdaf8a6e4713ed0756f52c620180c8b47f35))
+* support auto open evaluation report ([#287](https://github.com/AIGNE-io/aigne-doc-smith/issues/287)) ([93a64d5](https://github.com/AIGNE-io/aigne-doc-smith/commit/93a64d5bfb4602532efe5cc33cc90494e2b0cb48))
+
+
+### Bug Fixes
+
+* tune prompts increase document expressiveness ([#284](https://github.com/AIGNE-io/aigne-doc-smith/issues/284)) ([eb79742](https://github.com/AIGNE-io/aigne-doc-smith/commit/eb79742d0782405d6143ac0271359cd8ae97286b))
+
+## [0.8.16-beta](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.15...v0.8.16-beta) (2025-11-10)
+
+
+### Features
+
+* enable AFS for chat agent & improve chat skills ([#281](https://github.com/AIGNE-io/aigne-doc-smith/issues/281)) ([b1c770e](https://github.com/AIGNE-io/aigne-doc-smith/commit/b1c770e60c8866dd08d41ebdd52817c14dd3dd41))
+* implement document title streamlining functionality ([#276](https://github.com/AIGNE-io/aigne-doc-smith/issues/276)) ([918edb8](https://github.com/AIGNE-io/aigne-doc-smith/commit/918edb8f1b2dc03572c4125971092ef0023cd7b3))
+
+
+### Bug Fixes
+
+* update chat model from aignehub/gemini-2.5-pro to google/gemini-2.5-pro ([#283](https://github.com/AIGNE-io/aigne-doc-smith/issues/283)) ([3559a56](https://github.com/AIGNE-io/aigne-doc-smith/commit/3559a56e49ca3105fd800110b67b3cb3346e3096))
+
 ## [0.8.15](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.15-beta.16...v0.8.15) (2025-11-07)
 
 ## [0.8.15-beta.16](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.15-beta.15...v0.8.15-beta.16) (2025-11-07)

package/agents/chat/chat-system.md

@@ -0,0 +1,32 @@
+You are a professional document generation assistant that helps users create, modify, and manage documentation through interactive chat. Your primary role is to understand user requirements and intelligently call upon various specialized skills to complete documentation tasks efficiently.
+
+Core Capabilities:
+- Generate comprehensive documentation from user inputs and specifications
+- Regenerate and refine document details based on feedback
+- Translate and localize documentation content
+- Publish and manage team documentation workflows
+- Provide interactive guidance throughout the document creation process
+
+Interaction Guidelines:
+- Engage users in a professional yet friendly manner
+- Ask clarifying questions to understand specific documentation needs
+- Suggest appropriate skills and workflows based on user requests
+- Provide clear explanations of available capabilities and processes
+- Maintain context throughout multi-step documentation tasks
+- Offer proactive suggestions for improving document quality and structure
+
+<skill_usage>
+- afs_xxx skills: AFS(AIGNE File System) skills provide capabilities to explore, read, write and manage files and virtual modules within the AIGNE environment.
+  You can use these skills to access source files and other resources needed for documentation tasks.
+- listDocs: This skill lists all available documentation files in the system.
+  You can use this skill to get an overview of existing documents before creating or modifying documentation. for documentation tasks,
+  you should use this skill rather than afs_read to list documentation files.
+- generateDocument: This skill generates new documentation or updates existing documents structure based on user inputs and specifications,
+  You can use this skill to create comprehensive documents from scratch or based on existing templates or update document structure as per user requirements.
+- updateDocument: This skill updates existing documentation content with new information or revisions provided by the user.
+  You can use this skill to refine and enhance documents content based on feedback or additional details.
+- publish: This skill publishes completed documentation to an online website to make it accessible to the intended audience.
+  You can use this skill to manage the publication process and ensure documents are properly formatted and available.
+- translate: This skill translates documentation content into different languages for localization purposes.
+  You can use this skill to adapt documents for diverse audiences by providing translations in the required languages.
+</skill_usage>

package/agents/chat/index.yaml

@@ -1,30 +1,22 @@
 type: ai
 name: chat
 description: Start interactive document generation assistant
-instructions: |
-  You are a professional document generation assistant that helps users create, modify, and manage documentation through interactive chat. Your primary role is to understand user requirements and intelligently call upon various specialized skills to complete documentation tasks efficiently.
-
-  Core Capabilities:
-  - Generate comprehensive documentation from user inputs and specifications
-  - Regenerate and refine document details based on feedback
-  - Translate and localize documentation content
-  - Publish and manage team documentation workflows
-  - Provide interactive guidance throughout the document creation process
-
-  Interaction Guidelines:
-  - Engage users in a professional yet friendly manner
-  - Ask clarifying questions to understand specific documentation needs
-  - Suggest appropriate skills and workflows based on user requests
-  - Provide clear explanations of available capabilities and processes
-  - Maintain context throughout multi-step documentation tasks
-  - Offer proactive suggestions for improving document quality and structure
+instructions:
+  url: ./chat-system.md
 input_key: message
-memory: true
+afs:
+  modules:
+    - module: system-fs
+      options:
+        path: .
+        mount: /source
+        description: Project root directory for document generation
+afs_config:
+  inject_History: true
 skills:
-  - ../init/index.mjs
-  - ../generate/index.yaml
-  - ../update/index.yaml
+  - ./skills/generate-document.yaml
+  - ./skills/update-document.yaml
   - ../publish/index.yaml
   - ../translate/index.yaml
-  - ../utils/docs-fs-actor.yaml
   - ../utils/exit.mjs
+  - ../utils/list-docs.mjs

package/agents/chat/skills/generate-document.yaml

@@ -0,0 +1,15 @@
+type: team
+name: generateDocument
+description: Generate complete documentation for your project, or update/delete existing documents or structure based on user feedback
+input_schema:
+  type: object
+  properties:
+    feedback:
+      type: string
+      description: How to generate or update the document content
+  required:
+    - feedback
+skills:
+  - url: ../../generate/index.yaml
+    default_input:
+      isChat: true

package/agents/chat/skills/update-document.yaml

@@ -0,0 +1,24 @@
+type: team
+name: updateDocument
+description: Update a existing document based on user feedback
+input_schema:
+  type: object
+  properties:
+    docs:
+      type: array
+      items:
+        type: string
+      description: Documents to update, must from listDocs output
+    feedback:
+      type: string
+      description: Tell us what to change in this content
+    reset:
+      type: boolean
+      description: Regenerate the document from scratch, ignoring previous versions
+  required:
+    - docs
+    - feedback
+skills:
+  - url: ../../update/index.yaml
+    default_input:
+      isChat: true

package/agents/evaluate/generate-report.mjs

@@ -1,6 +1,9 @@
 import { writeFile } from "node:fs/promises";
 import { join } from "node:path";
 import { pick } from "@aigne/core/utils/type-utils.js";
+import isInCi from "is-in-ci";
+import openTerminal from "open";
+
 import { DOC_SMITH_DIR } from "../../utils/constants/index.mjs";
 import {
   copyHtmlReportTemplate,
@@ -35,6 +38,7 @@ export default async function generateEvaluationReport({
   readerKnowledgeLevel,
   documentationDepth,
   targetAudience,
+  open = true,
 }) {
   const timestamp = new Date().toISOString();
   const timestampForFolder = generateTimestampForFolder();
@@ -69,6 +73,9 @@ export default async function generateEvaluationReport({
 
   // Generate success message
   const message = generateReportSuccessMessage(toRelativePath(jsonReportPath), htmlReportPath);
+  if (open && !isInCi) {
+    openTerminal(htmlReportPath);
+  }
 
   return {
     message,

package/agents/evaluate/index.yaml

@@ -37,3 +37,9 @@ skills:
     mode: sequential
   - ./generate-report.mjs
 mode: sequential
+input_schema:
+  type: object
+  properties:
+    open:
+      type: boolean
+      description: Auto open generated report

package/agents/generate/check-need-generate-structure.mjs

@@ -1,6 +1,7 @@
 import chalk from "chalk";
 import { getActiveRulesForScope } from "../../utils/preferences-utils.mjs";
 import { getProjectInfo, loadConfigFromFile, saveValueToConfig } from "../../utils/utils.mjs";
+import streamlineDocumentTitlesIfNeeded from "../utils/streamline-document-titles-if-needed.mjs";
 
 export default async function checkNeedGenerateStructure(
   { originalDocumentStructure, forceRegenerate, ...rest },
@@ -70,6 +71,9 @@ export default async function checkNeedGenerateStructure(
     feedback: finalFeedback || "",
   });
 
+  await streamlineDocumentTitlesIfNeeded({ documentStructure: result.documentStructure }, options);
+  options.context.userContext.streamlinedDocumentTitles = true;
+
   let message = "";
 
   // Check and save project information
@@ -92,8 +96,10 @@ export default async function checkNeedGenerateStructure(
           result.projectName !== projectInfo.name &&
           !projectInfo.fromGitHub
         ) {
-          await saveValueToConfig("projectName", result.projectName);
-          message += `Project name: \`${result.projectName}\``;
+          // Remove leading and trailing spaces (middle spaces are preserved and count toward limit)
+          const trimmedProjectName = result.projectName.trim();
+          await saveValueToConfig("projectName", trimmedProjectName);
+          message += `Project name: \`${trimmedProjectName}\``;
           hasUpdated = true;
         }
 
@@ -102,8 +108,10 @@ export default async function checkNeedGenerateStructure(
           result.projectDesc !== projectInfo.description &&
           !projectInfo.fromGitHub
         ) {
-          await saveValueToConfig("projectDesc", result.projectDesc);
-          message += `\nProject description: \`${result.projectDesc}\``;
+          // Remove leading and trailing spaces (middle spaces are preserved and count toward limit)
+          const trimmedProjectDesc = result.projectDesc.trim();
+          await saveValueToConfig("projectDesc", trimmedProjectDesc);
+          message += `\nProject description: \`${trimmedProjectDesc}\``;
           hasUpdated = true;
         }
 

package/agents/generate/document-structure-tools/add-document.mjs

@@ -3,6 +3,8 @@ import {
   getAddDocumentOutputJsonSchema,
   validateAddDocumentInput,
 } from "../../../types/document-structure-schema.mjs";
+import streamlineDocumentTitlesIfNeeded from "../../utils/streamline-document-titles-if-needed.mjs";
+import generateDocumentIconIfNeeded from "../../utils/generate-document-icon-if-needed.mjs";
 
 export default async function addDocument(input, options) {
   // Validate input using Zod schema
@@ -56,9 +58,15 @@ export default async function addDocument(input, options) {
     sourceIds: [...sourceIds], // Create a copy of the array
   };
 
-  // Add the document to the structure
+  // Streamline document titles if needed (will streamline the new document if title > 18 characters)
+  await streamlineDocumentTitlesIfNeeded({ documentStructure: [newDocument] }, options);
+
+  // Add the document to the structure first
   const updatedStructure = [...documentStructure, newDocument];
 
+  // Generate icon for root-level documents if needed
+  await generateDocumentIconIfNeeded({ documentStructure: updatedStructure }, options);
+
   const successMessage = `addDocument executed successfully.
   Successfully added document '${title}' with path '${path}'.
   Check if the latest version of documentStructure meets user feedback, if so, just return 'success'.`;

package/agents/generate/document-structure-tools/update-document.mjs

@@ -3,6 +3,8 @@ import {
   getUpdateDocumentOutputJsonSchema,
   validateUpdateDocumentInput,
 } from "../../../types/document-structure-schema.mjs";
+import streamlineDocumentTitlesIfNeeded from "../../utils/streamline-document-titles-if-needed.mjs";
+import generateDocumentIconIfNeeded from "../../utils/generate-document-icon-if-needed.mjs";
 
 export default async function updateDocument(input, options) {
   // Validate input using Zod schema
@@ -44,10 +46,26 @@ export default async function updateDocument(input, options) {
     ...(sourceIds !== undefined && { sourceIds: [...sourceIds] }), // Create a copy of the array
   };
 
+  if (!options.context.userContext.streamlinedDocumentTitles) {
+    // Streamline document titles if needed (will streamline the updated document if title > 18 characters)
+    await streamlineDocumentTitlesIfNeeded({ documentStructure: [updatedDocument] }, options);
+    options.context.userContext.streamlinedDocumentTitles = true;
+  }
+
   // Update the document in the structure
   const updatedStructure = [...documentStructure];
   updatedStructure[documentIndex] = updatedDocument;
 
+  // Generate/update icon for root-level documents if needed
+  // Pass original document for comparison to detect title/description changes
+  await generateDocumentIconIfNeeded(
+    {
+      documentStructure: updatedStructure,
+      originalItems: [originalDocument],
+    },
+    options,
+  );
+
   const updates = [];
   if (title !== undefined) updates.push(`title to '${title}'`);
   if (description !== undefined) updates.push("description");

package/agents/generate/draw-diagram.yaml

@@ -2,9 +2,9 @@ name: drawDiagram
 description: Generate a D2 diagram from document content.
 instructions:
   - role: system
-    url: ../../prompts/detail/d2-diagram/system-prompt.md
+    url: ../../prompts/detail/diagram/system-prompt.md
   - role: user
-    url: ../../prompts/detail/d2-diagram/user-prompt.md
+    url: ../../prompts/detail/diagram/user-prompt.md
 input_schema:
   type: object
   properties:

package/agents/generate/generate-structure.yaml

@@ -54,10 +54,10 @@ skills:
           properties:
             projectName:
               type: string
-              description: Project name identified from your content sources
+              description: Project name identified from your content sources. Max 40 characters (any language, each character = 1). Leading/trailing spaces removed. Generate complete name within limit.
             projectDesc:
               type: string
-              description: Brief project description generated from content analysis (under 50 words)
+              description: Brief project description from content analysis. Max 160 characters (any language, each character = 1). Leading/trailing spaces removed. Generate complete description within limit.
             structures:
               type: array
               description: List of document structure items to add or update
@@ -109,6 +109,7 @@ skills:
             path: refinedItem.path,
             parentId: refinedItem.parentPath || null,  // Convert parentPath to parentId
             sourceIds: originalItem?.sourceIds || [],
+            ...(refinedItem.icon && { icon: refinedItem.icon }), // Preserve icon if updated during refinement
           }
 
           return newItem

package/agents/generate/user-review-document-structure.mjs

@@ -1,6 +1,7 @@
 import { getActiveRulesForScope } from "../../utils/preferences-utils.mjs";
 import { recordUpdate } from "../../utils/history-utils.mjs";
 import { buildDocumentTree } from "../../utils/docs-finder-utils.mjs";
+import equal from "fast-deep-equal";
 
 function formatDocumentStructure(structure) {
   const { rootNodes } = buildDocumentTree(structure);
@@ -49,25 +50,27 @@ export default async function userReviewDocumentStructure({ documentStructure, .
   }
 
   // Print current documentation structure in a user-friendly format
-  printDocumentStructure(documentStructure);
-
-  // Ask user if they want to review the documentation structure
-  const needReview = await options.prompts.select({
-    message: "Would you like to refine the documentation structure?",
-    choices: [
-      {
-        name: "No, looks good",
-        value: "no",
-      },
-      {
-        name: "Yes, optimize the structure (e.g. rename 'Getting Started' to 'Quick Start', move 'API Reference' before 'Configuration')",
-        value: "yes",
-      },
-    ],
-  });
-
-  if (needReview === "no") {
-    return { documentStructure };
+  if (!rest.isChat) {
+    printDocumentStructure(documentStructure);
+
+    // Ask user if they want to review the documentation structure
+    const needReview = await options.prompts.select({
+      message: "Would you like to refine the documentation structure?",
+      choices: [
+        {
+          name: "No, looks good",
+          value: "no",
+        },
+        {
+          name: "Yes, optimize the structure (e.g. rename 'Getting Started' to 'Quick Start', move 'API Reference' before 'Configuration')",
+          value: "yes",
+        },
+      ],
+    });
+
+    if (needReview === "no") {
+      return { documentStructure };
+    }
   }
 
   let currentStructure = documentStructure;
@@ -81,15 +84,17 @@ export default async function userReviewDocumentStructure({ documentStructure, .
     iterationCount++;
 
     // Ask for feedback
-    const feedback = await options.prompts.input({
-      message:
-        "How would you like to improve the structure?\n" +
-        "Examples:\n" +
-        "  • Add a new document 'Troubleshooting'\n" +
-        "  • Remove the 'Legacy Features' document\n" +
-        "  • Move 'Installation' to the top of the structure\n\n" +
-        "  Press Enter to finish reviewing:",
-    });
+    const feedback = rest.isChat
+      ? rest.feedback
+      : await options.prompts.input({
+          message:
+            "How would you like to improve the structure?\n" +
+            "Examples:\n" +
+            "  • Add a new document 'Troubleshooting'\n" +
+            "  • Remove the 'Legacy Features' document\n" +
+            "  • Move 'Installation' to the top of the structure\n\n" +
+            "  Press Enter to finish reviewing:",
+        });
 
     // If no feedback, break the loop
     if (!feedback?.trim()) {
@@ -115,7 +120,7 @@ export default async function userReviewDocumentStructure({ documentStructure, .
 
     try {
       // Call refineDocumentStructure agent with feedback
-      await options.context.invoke(refineAgent, {
+      const { message } = await options.context.invoke(refineAgent, {
         ...rest,
         dataSourceChunk: rest.dataSources[0].dataSourceChunk,
         feedback: feedback.trim(),
@@ -125,6 +130,12 @@ export default async function userReviewDocumentStructure({ documentStructure, .
 
       currentStructure = options.context.userContext.currentStructure;
 
+      if (rest.isChat && equal(currentStructure, documentStructure)) {
+        throw new Error(
+          `The suggested structure changes did not modify the existing documentation structure. ${message}`,
+        );
+      }
+
       // Check if feedback should be saved as user preference
       const feedbackRefinerAgent = options.context.agents["checkFeedbackRefiner"];
       if (feedbackRefinerAgent) {
@@ -147,6 +158,10 @@ export default async function userReviewDocumentStructure({ documentStructure, .
 
       // Print current documentation structure in a user-friendly format
       printDocumentStructure(currentStructure);
+
+      if (rest.isChat) {
+        break;
+      }
     } catch (error) {
       console.error("Error processing your feedback:");
       console.error(`Type: ${error.name}`);

package/agents/init/index.mjs

@@ -403,8 +403,9 @@ async function _init(
 
   // Save project info to config
   const projectInfo = await getProjectInfo();
-  input.projectName = projectInfo.name;
-  input.projectDesc = projectInfo.description;
+  // Remove leading and trailing spaces (middle spaces are preserved and count toward limit)
+  input.projectName = projectInfo.name.trim();
+  input.projectDesc = projectInfo.description.trim();
   input.projectLogo = projectInfo.icon;
 
   // Generate YAML content
@@ -453,8 +454,9 @@ export function generateYAML(input) {
   // Create the main configuration object that will be safely serialized
   const config = {
     // Project information (safely handled by yaml library)
-    projectName: input.projectName || "",
-    projectDesc: input.projectDesc || "",
+    // Remove leading and trailing spaces (middle spaces are preserved and count toward limit)
+    projectName: (input.projectName || "").trim(),
+    projectDesc: (input.projectDesc || "").trim(),
     projectLogo: input.projectLogo || "",
 
     thinking: {

package/agents/media/load-media-description.mjs

@@ -160,9 +160,10 @@ export default async function loadMediaDescription(input, options) {
   }
 
   // Build enhanced assetsContent with descriptions
-  let enhancedAssetsContent = "# Available Media Assets for Documentation\n\n";
+  let enhancedAssetsContent;
 
   if (mediaFiles.length > 0) {
+    enhancedAssetsContent = "# Available Media Assets for Documentation\n\n";
     const assets = mediaFiles.map((x) => {
       const mediaHash = mediaHashMap.get(x.path);
       const description = cache[mediaHash]?.description;

package/agents/schema/document-structure-item.yaml

@@ -16,6 +16,9 @@ properties:
     description: Associated sourceId from `<data_sources>` for subsequent translation and content generation, must come from sourceId in `<data_sources>`, cannot have fake ids, **cannot be empty**
     items:
       type: string
+  icon:
+    type: string
+    description: Lucide icon name for root-level documents (just support lucide:icon-name, not support other icon collections)
 required:
   - title
   - description

package/agents/schema/document-structure-refine-item.yaml

@@ -14,6 +14,9 @@ properties:
   parentPath:
     type: string
     description: Parent node path, if null indicates it is a top-level node
+  icon: 
+    type: string
+    description: Iconify icon name, e.g., lucide:book, lucide:rocket, lucide:* etc.
 required:
   - title
   - description

package/agents/schema/document-structure.yaml

@@ -19,6 +19,9 @@ items:
       description: Associated sourceId from `<data_sources>` for subsequent translation and content generation, must come from sourceId in `<data_sources>`, cannot have fake ids, **cannot be empty**
       items:
         type: string
+    icon:
+      type: string
+      description: Lucide icon name for root-level documents (just support lucide:icon-name, not support other icon collections)
   required:
     - title
     - description

package/agents/update/pre-check-generate-diagram.yaml

@@ -3,7 +3,7 @@ description: Pre-check for generating diagram
 model:
   reasoning_effort: 1
 instructions:
-  url: ../../prompts/detail/d2-diagram/pre-check.md
+  url: ../../prompts/detail/diagram/pre-check.md
 input_schema:
   type: object
   properties: