@aigne/doc-smith 0.8.11-beta.4 → 0.8.11-beta.6

package/prompts/structure/structure-getting-started.md

@@ -1,5 +1,5 @@
 <getting_started_document_structure_rules>
-Based on the provided data sources, plan a Getting Started document structure:
+Based on the provided data sources, plan a Getting Started documentation structure:
   - The entire structure should be complete and continuous, allowing users to follow the documentation step by step to complete a working example
   - Each document section should complete a relatively complete step, avoiding overly long individual sections that create reading pressure for users
   - Provide reference command lines and code as needed to facilitate users following the documentation

package/prompts/structure/update-document-structure.md

@@ -1,7 +1,7 @@
 <role_and_goal>
 
-You are a document structure update specialist with the strategic mindset of an **INTJ** (The Architect).
-You analyze user feedback and intentions to modify existing document structures using specific operations.
+You are a documentation structure update specialist with the strategic mindset of an **INTJ** (The Architect).
+You analyze user feedback and intentions to modify existing documentation structures using specific operations.
 Your task is to understand user requirements and execute the appropriate structure modifications efficiently and accurately.
 
 {% include "../common/document-structure/intj-traits.md" %}
@@ -12,15 +12,15 @@ Processing workflow:
 - Analyze user feedback to understand the specific intent (add, delete, update, or move sections)
 - Determine which tools to use based on the user's requirements
 - Execute the appropriate operations using available tools
-- Ensure all modifications maintain document structure integrity
+- Ensure all modifications maintain documentation structure integrity
 
 Rules:
-** Never generate new document structures directly. All changes must be made using Tools. **
-** Use the document structure returned by Tools as the latest version, check if it satisfies the user's feedback, and if so, return the latest version directly. **
+** Never generate new documentation structures directly. All changes must be made using Tools. **
+** Use the documentation structure returned by Tools as the latest version, check if it satisfies the user's feedback, and if so, return the latest version directly. **
 
 Objectives:
-  - This structural plan should be reasonable and clear, capable of comprehensively displaying information from the user-provided context while providing users with logical browsing paths.
-  - Each {{nodeName}} should include: {{nodeName}} title, a one-sentence introduction to the main information this {{nodeName}} displays, with information presentation and organization methods matching the target audience.
+  - Create a clear and logical structural plan that comprehensively presents information from the user-provided context while providing users with intuitive navigation paths.
+  - Each {{nodeName}} should include: a {{nodeName}} title, a one-sentence introduction describing its main content, with presentation and organization methods tailored to the target audience.
 
 </role_and_goal>
 
@@ -28,7 +28,7 @@ Objectives:
 
 {% include "../common/document-structure/user-preferences.md" %}
 
-Initial Document Structure:
+Initial Documentation Structure:
 <initial_document_structure>
 {{documentStructure}}
 </initial_document_structure>
@@ -87,7 +87,7 @@ Operation execution rules:
 - **Use only the appropriate tools** based on the determined operation type
 - **Validate all required parameters** before calling tools
 - **Maintain data integrity** by ensuring all constraints are met
-- **Only use Tools to update data** Use provided Tools to modify document structure, use the document structure returned by Tools as the latest version
+- **Only use Tools to update data** Use provided Tools to modify documentation structure, use the documentation structure returned by Tools as the latest version
 - **Use Tool return results** When all Tool calls are complete, directly use the result from the last Tool
 
 Tool usage guidelines:

package/prompts/utils/feedback-refiner.md

@@ -33,7 +33,7 @@ Save determination rules:
 **One-time operations (do not save)**:
 - Only corrects current version/typos/individual phrasing/local factual errors with no stable reusable value → `save=false`
 - Fixes that are highly specific to a single line or data point and unlikely to recur (e.g., "change the year from 2020 to 2021") → `save=false`
-- Document structure adjustments, adding new documents, and moving document positions are always one-time operations → `save=false`
+- Documentation Structure adjustments, adding new documents, and moving document positions are always one-time operations → `save=false`
 
 **Reusable policies (save)**:
 - Writing styles, structural conventions, inclusion/exclusion items, translation conventions that are broadly applicable and should be consistently executed in the future → `save=true`

package/tests/agents/clear/choose-contents.test.mjs

@@ -15,7 +15,7 @@ describe("choose-contents", () => {
         path: "/test/docs",
       })),
       clearDocumentStructure: mock(async () => ({
-        message: "Document structure cleared",
+        message: "Documentation Structure cleared",
         cleared: true,
         path: "/test/structure.json",
       })),

package/tests/agents/clear/clear-document-structure.test.mjs

@@ -34,8 +34,8 @@ describe("clear-document-structure", () => {
     }
   });
 
-  test("should clear structure plan only when no docsDir provided", async () => {
-    // Create a test structure plan file
+  test("should clear documentation structure only when no docsDir provided", async () => {
+    // Create a test documentation structure file
     const structurePlan = {
       documents: [
         { path: "/intro", title: "Introduction" },
@@ -46,18 +46,18 @@ describe("clear-document-structure", () => {
 
     const result = await clearDocumentStructure({ workDir: testDir });
 
-    expect(result.message).toContain("Document structure cleared successfully!");
+    expect(result.message).toContain("Documentation Structure cleared successfully!");
     expect(result.hasError).toBe(false);
     expect(result.clearedCount).toBe(1);
 
-    // Verify structure plan file is actually deleted
+    // Verify documentation structure file is actually deleted
     const { pathExists } = await import("../../../utils/file-utils.mjs");
     const exists = await pathExists(structurePlanPath);
     expect(exists).toBe(false);
   });
 
-  test("should clear both structure plan and docs directory when docsDir provided", async () => {
-    // Create structure plan
+  test("should clear both documentation structure and docs directory when docsDir provided", async () => {
+    // Create documentation structure
     await writeFile(structurePlanPath, JSON.stringify({ test: "data" }));
 
     // Create docs directory with files
@@ -67,7 +67,7 @@ describe("clear-document-structure", () => {
 
     const result = await clearDocumentStructure({ workDir: testDir, docsDir });
 
-    expect(result.message).toContain("Document structure cleared successfully!");
+    expect(result.message).toContain("Documentation Structure cleared successfully!");
     expect(result.clearedCount).toBe(2);
 
     // Verify both are deleted
@@ -78,17 +78,17 @@ describe("clear-document-structure", () => {
     expect(docsExists).toBe(false);
   });
 
-  test("should handle non-existent structure plan file", async () => {
-    // Don't create the structure plan file
+  test("should handle non-existent documentation structure file", async () => {
+    // Don't create the documentation structure file
     const result = await clearDocumentStructure({ workDir: testDir });
 
-    expect(result.message).toContain("Document structure already empty.");
+    expect(result.message).toContain("Documentation Structure already empty.");
     expect(result.clearedCount).toBe(0);
     expect(result.hasError).toBe(false);
   });
 
   test("should handle non-existent docs directory", async () => {
-    // Create structure plan but not docs directory
+    // Create documentation structure but not docs directory
     await writeFile(structurePlanPath, JSON.stringify({ test: "data" }));
 
     const nonExistentDocsDir = join(testDir, "non-existent-docs");
@@ -98,10 +98,10 @@ describe("clear-document-structure", () => {
       docsDir: nonExistentDocsDir,
     });
 
-    expect(result.message).toContain("Document structure cleared successfully!");
-    expect(result.clearedCount).toBe(1); // Only structure plan cleared
+    expect(result.message).toContain("Documentation Structure cleared successfully!");
+    expect(result.clearedCount).toBe(1); // Only documentation structure cleared
 
-    // Verify structure plan is deleted
+    // Verify documentation structure is deleted
     const { pathExists } = await import("../../../utils/file-utils.mjs");
     const exists = await pathExists(structurePlanPath);
     expect(exists).toBe(false);
@@ -114,12 +114,12 @@ describe("clear-document-structure", () => {
       // Change to test directory
       process.chdir(testDir);
 
-      // Create structure plan in current directory's structure
+      // Create documentation structure in current directory's structure
       await writeFile(structurePlanPath, JSON.stringify({ test: "data" }));
 
       const result = await clearDocumentStructure({});
 
-      expect(result.message).toContain("Document structure cleared successfully!");
+      expect(result.message).toContain("Documentation Structure cleared successfully!");
       expect(result.clearedCount).toBe(1);
     } finally {
       // Restore original working directory
@@ -159,15 +159,15 @@ describe("clear-document-structure", () => {
 
   test("should have correct task metadata", () => {
     expect(clearDocumentStructure.taskTitle).toBe(
-      "Clear document structure and all generated documents",
+      "Clear documentation structure and all generated documents",
     );
     expect(clearDocumentStructure.description).toBe(
-      "Clear the document structure plan (structure-plan.json) and optionally the documents directory",
+      "Clear the documentation structure (structure-plan.json) and optionally the documents directory",
     );
   });
 
-  test("should handle complex document structures", async () => {
-    // Create complex structure plan
+  test("should handle complex documentation structures", async () => {
+    // Create complex documentation structure
     const complexStructure = {
       documents: [
         {
@@ -289,7 +289,7 @@ describe("clear-document-structure", () => {
     const structureResult = result.results.find((r) => r.type === "structure");
     expect(structureResult).toBeDefined();
     expect(structureResult.cleared).toBe(true);
-    expect(structureResult.message).toContain("structure plan");
+    expect(structureResult.message).toContain("documentation structure");
 
     // Check documents result
     const docsResult = result.results.find((r) => r.type === "documents");
@@ -298,12 +298,12 @@ describe("clear-document-structure", () => {
     expect(docsResult.message).toContain("documents directory");
   });
 
-  test("should handle structure plan file removal errors", async () => {
-    // Create a spy on rm to simulate an error for structure plan
+  test("should handle documentation structure file removal errors", async () => {
+    // Create a spy on rm to simulate an error for documentation structure
     const rmSpy = spyOn(fsPromises, "rm");
     rmSpy.mockImplementation((path, _options) => {
       if (path.includes("structure-plan.json")) {
-        throw new Error("Permission denied for structure plan");
+        throw new Error("Permission denied for documentation structure");
       }
       return Promise.resolve();
     });
@@ -312,19 +312,21 @@ describe("clear-document-structure", () => {
       const result = await clearDocumentStructure({ workDir: testDir });
 
       expect(result.hasError).toBe(true);
-      expect(result.message).toContain("Document structure cleanup finished with some issues.");
+      expect(result.message).toContain(
+        "Documentation Structure cleanup finished with some issues.",
+      );
 
       const structureResult = result.results.find((r) => r.type === "structure");
       expect(structureResult.error).toBe(true);
-      expect(structureResult.message).toContain("Failed to clear document structure plan");
-      expect(structureResult.message).toContain("Permission denied for structure plan");
+      expect(structureResult.message).toContain("Failed to clear documentation structure");
+      expect(structureResult.message).toContain("Permission denied for documentation structure");
     } finally {
       rmSpy.mockRestore();
     }
   });
 
   test("should handle documents directory removal errors", async () => {
-    // Create structure plan file
+    // Create documentation structure file
     await writeFile(structurePlanPath, JSON.stringify({ test: "data" }));
 
     // Create a spy on rm to simulate an error for docs directory
@@ -340,7 +342,9 @@ describe("clear-document-structure", () => {
       const result = await clearDocumentStructure({ workDir: testDir, docsDir });
 
       expect(result.hasError).toBe(true);
-      expect(result.message).toContain("Document structure cleanup finished with some issues.");
+      expect(result.message).toContain(
+        "Documentation Structure cleanup finished with some issues.",
+      );
 
       const docsResult = result.results.find((r) => r.type === "documents");
       expect(docsResult.error).toBe(true);
@@ -362,7 +366,9 @@ describe("clear-document-structure", () => {
       const result = await clearDocumentStructure({ workDir: testDir, docsDir });
 
       expect(result.hasError).toBe(true);
-      expect(result.message).toContain("Document structure cleanup finished with some issues.");
+      expect(result.message).toContain(
+        "Documentation Structure cleanup finished with some issues.",
+      );
       expect(result.results).toHaveLength(2);
 
       // Both operations should have errors

package/tests/agents/evaluate/generate-report.test.mjs

@@ -189,7 +189,7 @@ describe("generateEvaluationReport", () => {
     expect(firstDoc.codeEvaluation).toBe(null);
   });
 
-  test("should handle empty document structure", async () => {
+  test("should handle empty documentation structure", async () => {
     const testData = {
       structureEvaluation: {
         purposeCoverage: {

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

@@ -87,7 +87,7 @@ describe("check-need-generate-structure", () => {
     saveValueToConfigSpy?.mockRestore();
   });
 
-  test("should return original document structure when no regeneration needed", async () => {
+  test("should return original documentation structure when no regeneration needed", async () => {
     // Test when no feedback and no sidebar file exists (default mock behavior)
     const result = await checkNeedGenerateStructure(
       { originalDocumentStructure, docsDir: "./docs" },

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

@@ -335,7 +335,7 @@ describe("add-document", () => {
   });
 
   // EDGE CASES
-  test("should handle empty document structure", async () => {
+  test("should handle empty documentation structure", async () => {
     const result = await addDocument({
       documentStructure: [],
       title: "First Document",
@@ -418,7 +418,7 @@ describe("add-document", () => {
   });
 
   // DATA INTEGRITY TESTS
-  test("should not modify original document structure", async () => {
+  test("should not modify original documentation structure", async () => {
     const originalStructure = [...baseDocumentStructure];
 
     await addDocument({

package/tests/agents/generate/document-structure-tools/delete-document.test.mjs

@@ -197,7 +197,7 @@ describe("delete-document", () => {
   });
 
   // EDGE CASES
-  test("should handle empty document structure", async () => {
+  test("should handle empty documentation structure", async () => {
     const result = await deleteDocument({
       documentStructure: [],
       path: "/any-path",
@@ -210,7 +210,7 @@ describe("delete-document", () => {
     );
   });
 
-  test("should handle document structure with single document", async () => {
+  test("should handle documentation structure with single document", async () => {
     const singleDocStructure = [
       {
         title: "Only Document",
@@ -313,7 +313,7 @@ describe("delete-document", () => {
   });
 
   // DATA INTEGRITY TESTS
-  test("should not modify original document structure", async () => {
+  test("should not modify original documentation structure", async () => {
     const originalStructure = [...baseDocumentStructure];
 
     await deleteDocument({
@@ -390,7 +390,7 @@ describe("delete-document", () => {
     expect(result.deletedDocument).toHaveProperty("sourceIds");
   });
 
-  test("should return updated document structure without deleted document", async () => {
+  test("should return updated documentation structure without deleted document", async () => {
     const originalLength = baseDocumentStructure.length;
     const result = await deleteDocument({
       documentStructure: baseDocumentStructure,

package/tests/agents/generate/document-structure-tools/move-document.test.mjs

@@ -326,7 +326,7 @@ describe("move-document", () => {
     expect(updatedDoc.parentId).not.toBe(originalDoc.parentId);
   });
 
-  test("should handle empty document structure", async () => {
+  test("should handle empty documentation structure", async () => {
     const result = await moveDocument({
       documentStructure: [],
       path: "/any-path",
@@ -339,7 +339,7 @@ describe("move-document", () => {
     );
   });
 
-  test("should handle single document structure", async () => {
+  test("should handle single documentation structure", async () => {
     const singleDocStructure = [
       {
         title: "Only Document",
@@ -363,7 +363,7 @@ describe("move-document", () => {
   });
 
   // DATA INTEGRITY TESTS
-  test("should not modify original document structure", async () => {
+  test("should not modify original documentation structure", async () => {
     const originalStructure = [...baseDocumentStructure];
 
     await moveDocument({

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

@@ -319,7 +319,7 @@ describe("update-document", () => {
     expect(consoleSpy).not.toHaveBeenCalled();
   });
 
-  test("should handle empty document structure", async () => {
+  test("should handle empty documentation structure", async () => {
     const result = await updateDocument({
       documentStructure: [],
       path: "/any-path",
@@ -332,7 +332,7 @@ describe("update-document", () => {
     );
   });
 
-  test("should handle single document structure", async () => {
+  test("should handle single documentation structure", async () => {
     const singleDocStructure = [
       {
         title: "Only Document",
@@ -377,7 +377,7 @@ describe("update-document", () => {
   });
 
   // DATA INTEGRITY TESTS
-  test("should not modify original document structure", async () => {
+  test("should not modify original documentation structure", async () => {
     const originalStructure = [...baseDocumentStructure];
 
     await updateDocument({

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

@@ -71,13 +71,13 @@ describe("user-review-document-structure", () => {
     consoleSpy?.mockRestore();
   });
 
-  test("should return original structure when no document structure provided", async () => {
+  test("should return original structure when no documentation structure provided", async () => {
     const result = await userReviewDocumentStructure({}, mockOptions);
 
     expect(result).toBeDefined();
     expect(result.documentStructure).toBeUndefined();
     expect(mockOptions.prompts.select).not.toHaveBeenCalled();
-    expect(consoleSpy).toHaveBeenCalledWith("No document structure was generated to review.");
+    expect(consoleSpy).toHaveBeenCalledWith("No documentation structure was generated to review.");
   });
 
   test("should return original structure when empty array provided", async () => {
@@ -86,7 +86,7 @@ describe("user-review-document-structure", () => {
     expect(result).toBeDefined();
     expect(result.documentStructure).toEqual([]);
     expect(mockOptions.prompts.select).not.toHaveBeenCalled();
-    expect(consoleSpy).toHaveBeenCalledWith("No document structure was generated to review.");
+    expect(consoleSpy).toHaveBeenCalledWith("No documentation structure was generated to review.");
   });
 
   test("should return original structure when user chooses not to review", async () => {
@@ -110,7 +110,9 @@ describe("user-review-document-structure", () => {
     expect(result.documentStructure).toEqual(documentStructure);
     expect(mockOptions.prompts.select).toHaveBeenCalled();
     expect(mockOptions.prompts.input).toHaveBeenCalled();
-    expect(consoleSpy).toHaveBeenCalledWith(expect.stringContaining("Current Document Structure"));
+    expect(consoleSpy).toHaveBeenCalledWith(
+      expect.stringContaining("Current Documentation Structure"),
+    );
   });
 
   test("should process user feedback and call refineDocumentStructure agent", async () => {
@@ -188,7 +190,7 @@ describe("user-review-document-structure", () => {
 
     expect(result.documentStructure).toEqual(documentStructure);
     expect(consoleSpy).toHaveBeenCalledWith(
-      "Unable to process your feedback - the document structure update feature is unavailable.",
+      "Unable to process your feedback - the documentation structure update feature is unavailable.",
     );
   });
 

package/tests/agents/init/init.test.mjs

@@ -986,11 +986,12 @@ describe("init", () => {
         const mockResponses = {
           checkbox_1: ["getStarted", "findAnswers"], // Document purpose
           checkbox_2: ["developers"], // Target audience
-          select_3: "domainFamiliar", // Reader knowledge level
-          select_4: "balancedCoverage", // Documentation depth
-          select_5: "en", // Primary language
-          checkbox_6: ["zh", "ja"], // Translation languages
-          input_7: join(tempDir, "docs"), // Documentation directory
+          input_3: "Custom rules for documentation", // Custom rules
+          select_4: "domainFamiliar", // Reader knowledge level
+          select_5: "balancedCoverage", // Documentation depth
+          select_6: "en", // Primary language
+          checkbox_7: ["zh", "ja"], // Translation languages
+          input_8: join(tempDir, "docs"), // Documentation directory
           search: "", // Source paths (empty to finish)
         };
 
@@ -1023,6 +1024,7 @@ describe("init", () => {
 
         expect(config.documentPurpose).toEqual(["getStarted", "findAnswers"]);
         expect(config.targetAudienceTypes).toEqual(["developers"]);
+        expect(config.rules).toBe("Custom rules for documentation");
         expect(config.readerKnowledgeLevel).toBe("domainFamiliar");
         expect(config.documentationDepth).toBe("balancedCoverage");
         expect(config.locale).toBe("en");
@@ -1042,11 +1044,12 @@ describe("init", () => {
           checkbox_1: ["mixedPurpose"], // Document purpose - triggers follow-up
           checkbox: ["completeTasks", "findAnswers"], // Top priorities after mixedPurpose
           checkbox_2: ["developers", "devops"], // Target audience
-          select_3: "experiencedUsers", // Reader knowledge level
-          select_4: "comprehensive", // Documentation depth
-          select_5: "zh-CN", // Primary language
-          checkbox_6: ["en"], // Translation languages
-          input_7: join(tempDir, "documentation"), // Documentation directory
+          input_3: "Custom rules for documentation", // Custom rules
+          select_4: "experiencedUsers", // Reader knowledge level
+          select_5: "comprehensive", // Documentation depth
+          select_6: "zh-CN", // Primary language
+          checkbox_7: ["en"], // Translation languages
+          input_8: join(tempDir, "documentation"), // Documentation directory
           search: "", // Source paths (empty to finish)
         };
 
@@ -1071,6 +1074,7 @@ describe("init", () => {
 
         expect(config.documentPurpose).toEqual(["completeTasks", "findAnswers"]);
         expect(config.targetAudienceTypes).toEqual(["developers", "devops"]);
+        expect(config.rules).toBe("Custom rules for documentation");
         expect(config.readerKnowledgeLevel).toBe("experiencedUsers");
         expect(config.documentationDepth).toBe("comprehensive");
         expect(config.locale).toBe("zh-CN");
@@ -1087,11 +1091,12 @@ describe("init", () => {
         const mockResponses = {
           checkbox_1: ["getStarted"], // Document purpose
           checkbox_2: ["endUsers"], // Target audience
-          select_3: "completeBeginners", // Reader knowledge level
-          select_4: "essentialOnly", // Documentation depth
-          select_5: "en", // Primary language
-          checkbox_6: [], // No translation languages
-          input_7: join(tempDir, "simple-docs"), // Documentation directory
+          input_3: "Custom rules for documentation", // Custom rules
+          select_4: "completeBeginners", // Reader knowledge level
+          select_5: "essentialOnly", // Documentation depth
+          select_6: "en", // Primary language
+          checkbox_7: [], // No translation languages
+          input_8: join(tempDir, "simple-docs"), // Documentation directory
           search: "", // Source paths (empty to finish)
         };
 
@@ -1115,6 +1120,7 @@ describe("init", () => {
 
         expect(config.documentPurpose).toEqual(["getStarted"]);
         expect(config.targetAudienceTypes).toEqual(["endUsers"]);
+        expect(config.rules).toBe("Custom rules for documentation");
         expect(config.readerKnowledgeLevel).toBe("completeBeginners");
         expect(config.documentationDepth).toBe("essentialOnly");
         expect(config.locale).toBe("en");
@@ -1298,7 +1304,7 @@ describe("init", () => {
         let validateCalled = false;
         const mockPrompts = {
           checkbox: (options) => {
-            if (options.message.includes("[1/8]") && options.validate) {
+            if (options.message.includes("[1/9]") && options.validate) {
               // Test the validation function directly
               const validationResult = options.validate([]);
               expect(validationResult).toBe(
@@ -1336,10 +1342,10 @@ describe("init", () => {
         let audienceValidateCalled = false;
         const mockPrompts = {
           checkbox: (options) => {
-            if (options.message.includes("[1/8]")) {
+            if (options.message.includes("[1/9]")) {
               return Promise.resolve(["getStarted"]); // Valid document purpose
             }
-            if (options.message.includes("[2/8]") && options.validate) {
+            if (options.message.includes("[2/9]") && options.validate) {
               // Test the validation function for target audience
               const validationResult = options.validate([]);
               expect(validationResult).toBe("Please choose at least one audience.");
@@ -1374,7 +1380,7 @@ describe("init", () => {
         let priorityValidateCalled = false;
         const mockPrompts = {
           checkbox: (options) => {
-            if (options.message.includes("[1/8]")) {
+            if (options.message.includes("[1/9]")) {
               return Promise.resolve(["mixedPurpose"]); // Trigger follow-up question
             }
             // This is the follow-up priority selection