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

package/prompts/detail/update-document.md

@@ -17,9 +17,9 @@ Your task is to analyze the original document content and user feedback, then us
 {% set operation_type = "optimizing" %}
 {% include "../common/document/user-preferences.md" %}
 
-<original_content>
+<page_content>
 {{originalContent}}
-</original_content>
+</page_content>
 
 <user_feedback>
 {{feedback}}
@@ -114,17 +114,17 @@ Processing workflow:
 - Analyze user feedback to understand the exact intent and scope of changes
 - Generate a unified diff patch that implements the requested improvements
 - Use the available tool to apply the changes and get the final content
+- Tool calls only need to return toolCalls information
 - Ensure all modifications maintain document quality and consistency
-- Provide clear feedback about what changes were made
+- Return 'success' when the latest version of content meets user feedback
 
 Tool usage guidelines:
 
 **updateDocumentContent**: Use this tool to apply changes to the document content
 - Generate a precise unified diff patch based on the user feedback
 - The diff should include context lines for accurate application
-- Only consider content within <original_content> tag when calculating line numbers, ensure line number calculation is accurate
+- Only consider content within <page_content> tag when calculating line numbers, ensure line number calculation is accurate
 - Test the patch application to ensure it works correctly
-- Return the final updated content
 
 Error handling:
 - If user intent is unclear, ask for clarification
@@ -133,11 +133,7 @@ Error handling:
 </task_instructions>
 
 <output_format>
-Your response should:
-
-The final output should include:
-- `updatedContent`: The final updated markdown content after applying all modifications
-- `operationSummary`: A clear explanation of the modifications made based on the user feedback
-
-**Always use tool return results** - When all tool calls are complete, directly use the result from the updateDocumentContent tool as your final updatedContent.
+** Only output operation execution status **:
+- Only return 'success' if operation executed successfully
+- Return brief error message if operation failed
 </output_format>

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

@@ -13,10 +13,11 @@ Processing workflow:
 - Determine which tools to use based on the user's requirements
 - Execute the appropriate operations using available tools
 - Ensure all modifications maintain documentation structure integrity
+- Return 'success' when the latest version of websiteStructure meets user feedback
 
 Rules:
-** 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. **
+** All changes must be made using Tools. **
+** Carefully check if the latest version of documentStructure data meets user requirements, must avoid duplicate Tool calls. **
 
 Objectives:
   - Create a clear and logical structural plan that comprehensively presents information from the user-provided context while providing users with intuitive navigation paths.
@@ -83,12 +84,12 @@ Analyze the user feedback to determine the intended operation:
 
 Operation execution rules:
 
-- **Always analyze the user feedback first** to understand the exact intent
-- **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 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
+- Always analyze the user feedback first to understand the exact intent
+- Use only the appropriate tools based on the determined operation type
+- Tool calls only need to return toolCalls information
+- 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 documentation structure, use the documentation structure returned by Tools as the latest version
 
 Tool usage guidelines:
 
@@ -115,4 +116,7 @@ Error handling:
 - If required information is missing, request the needed details
 - If operation would break constraints, explain the issue and suggest alternatives
 
+** Only output operation execution status **:
+- Only return 'success' if operation executed successfully
+- Return brief error message if operation failed
 </output_constraints>

package/prompts/utils/feedback-refiner.md

@@ -33,10 +33,10 @@ 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`
-- Documentation Structure adjustments, adding new documents, and moving document positions are always one-time operations → `save=false`
+- Documentation Structure adjustments, adding new documents, update document, delete document, 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`
+- Writing styles, structural conventions, translation conventions that are broadly applicable and should be consistently executed in the future → `save=true`
 
 **Duplication check (do not save)**:
 - If `existingPreferences` already contains **similar or covering** rules for current feedback intent, then `save=false`
@@ -71,7 +71,7 @@ Example 1 (Keyword Preservation):
 Example 2:
 - Input: stage=document_structure, paths=[], feedback="Add 'Next Steps' at the end of overview and tutorials with 2-3 links."
 - Output:
-{"rule":"Add 'Next Steps' section at the end of overview and tutorial documents with 2-3 links within the repository.","scope":"structure","save":true,"limitToInputPaths":false,"reason":"This feedback suggests a new structural convention (adding a 'Next Steps' section). This is a classic reusable policy that should be applied to future documents of a certain type. Therefore, `save` is `true` and the scope is `structure`."}
+{"rule":"Add 'Next Steps' section at the end of overview and tutorial documents with 2-3 links within the repository.","scope":"structure","save":false,"limitToInputPaths":false,"reason":"This feedback is about adjusting document structure by adding a new section. According to save rules, documentation structure adjustments are always one-time operations, so `save` should be `false`. The scope remains `structure` as it affects document organization."}
 
 Example 3:
 - Input: stage=translation_refine, paths=[], feedback="Don't translate variable names and code."

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

@@ -158,7 +158,7 @@ describe("move-document", () => {
     expect(result.documentStructure).toEqual(baseDocumentStructure);
     expect(result.originalDocument).toBeUndefined();
     expect(result.updatedDocument).toBeUndefined();
-    expect(consoleSpy).toHaveBeenCalledWith("Error: Cannot move document - path: Required");
+    expect(consoleSpy).toHaveBeenCalledWith("⚠️  Cannot move document: path: Required");
   });
 
   test("should return error when path is empty string", async () => {
@@ -169,7 +169,7 @@ describe("move-document", () => {
     });
 
     expect(result.documentStructure).toEqual(baseDocumentStructure);
-    expect(consoleSpy).toHaveBeenCalledWith("Error: Cannot move document - path: Path is required");
+    expect(consoleSpy).toHaveBeenCalledWith("⚠️  Cannot move document: path: Path is required");
   });
 
   test("should return error when document does not exist", async () => {
@@ -181,7 +181,7 @@ describe("move-document", () => {
 
     expect(result.documentStructure).toEqual(baseDocumentStructure);
     expect(consoleSpy).toHaveBeenCalledWith(
-      "Error: Cannot move document - Document '/nonexistent-document' does not exist. Please select an existing document to move.",
+      "⚠️  Cannot move document: Document '/nonexistent-document' does not exist. Please select an existing document to move.",
     );
   });
 
@@ -194,7 +194,7 @@ describe("move-document", () => {
 
     expect(result.documentStructure).toEqual(baseDocumentStructure);
     expect(consoleSpy).toHaveBeenCalledWith(
-      "Error: Cannot move document - Target parent document '/nonexistent-parent' does not exist. Please select an existing parent document.",
+      "⚠️  Cannot move document: Target parent document '/nonexistent-parent' does not exist. Please select an existing parent document.",
     );
   });
 
@@ -208,7 +208,7 @@ describe("move-document", () => {
 
     expect(result.documentStructure).toEqual(baseDocumentStructure);
     expect(consoleSpy).toHaveBeenCalledWith(
-      "Error: Cannot move document - Moving '/api' under '/api/auth' would create an invalid hierarchy. Please select a parent that is not nested under the document being moved.",
+      "⚠️  Cannot move document: Moving '/api' under '/api/auth' would create an invalid hierarchy. Please select a parent that is not nested under the document being moved.",
     );
   });
 
@@ -221,7 +221,7 @@ describe("move-document", () => {
 
     expect(result.documentStructure).toEqual(baseDocumentStructure);
     expect(consoleSpy).toHaveBeenCalledWith(
-      "Error: Cannot move document - Moving '/api' under '/api/auth/oauth' would create an invalid hierarchy. Please select a parent that is not nested under the document being moved.",
+      "⚠️  Cannot move document: Moving '/api' under '/api/auth/oauth' would create an invalid hierarchy. Please select a parent that is not nested under the document being moved.",
     );
   });
 
@@ -278,7 +278,7 @@ describe("move-document", () => {
 
     expect(result.documentStructure).toEqual(complexStructure);
     expect(consoleSpy).toHaveBeenCalledWith(
-      "Error: Cannot move document - Moving '/api' under '/api/auth/oauth/scopes' would create an invalid hierarchy. Please select a parent that is not nested under the document being moved.",
+      "⚠️  Cannot move document: Moving '/api' under '/api/auth/oauth/scopes' would create an invalid hierarchy. Please select a parent that is not nested under the document being moved.",
     );
   });
 
@@ -335,7 +335,7 @@ describe("move-document", () => {
 
     expect(result.documentStructure).toEqual([]);
     expect(consoleSpy).toHaveBeenCalledWith(
-      "Error: Cannot move document - Document '/any-path' does not exist. Please select an existing document to move.",
+      "⚠️  Cannot move document: Document '/any-path' does not exist. Please select an existing document to move.",
     );
   });
 
@@ -358,7 +358,7 @@ describe("move-document", () => {
 
     expect(result.documentStructure).toEqual(singleDocStructure);
     expect(consoleSpy).toHaveBeenCalledWith(
-      "Error: Cannot move document - Target parent document '/nonexistent' does not exist. Please select an existing parent document.",
+      "⚠️  Cannot move document: Target parent document '/nonexistent' does not exist. Please select an existing parent document.",
     );
   });
 

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

@@ -49,6 +49,9 @@ describe("user-review-document-structure", () => {
         invoke: mock(async () => ({
           documentStructure: documentStructure,
         })),
+        userContext: {
+          currentStructure: [],
+        },
       },
     };
 
@@ -132,9 +135,13 @@ describe("user-review-document-structure", () => {
       .mockImplementationOnce(async () => feedback)
       .mockImplementationOnce(async () => ""); // Exit loop on second call
 
-    mockOptions.context.invoke.mockImplementation(async () => ({
-      documentStructure: refinedStructure,
-    }));
+    mockOptions.context.invoke.mockImplementation(async () => {
+      // Simulate the agent updating the shared context
+      mockOptions.context.userContext.currentStructure = refinedStructure;
+      return {
+        documentStructure: refinedStructure,
+      };
+    });
 
     const result = await userReviewDocumentStructure({ documentStructure }, mockOptions);
 
@@ -242,11 +249,25 @@ describe("user-review-document-structure", () => {
       .mockImplementationOnce(async () => secondFeedback)
       .mockImplementationOnce(async () => ""); // Exit loop
 
-    mockOptions.context.invoke
-      .mockImplementationOnce(async () => ({ documentStructure: firstRefinedStructure })) // refineDocumentStructure 1st call
-      .mockImplementationOnce(async () => ({})) // checkFeedbackRefiner 1st call
-      .mockImplementationOnce(async () => ({ documentStructure: finalRefinedStructure })) // refineDocumentStructure 2nd call
-      .mockImplementationOnce(async () => ({})); // checkFeedbackRefiner 2nd call
+    let invokeCount = 0;
+    mockOptions.context.invoke.mockImplementation(async () => {
+      invokeCount++;
+      if (invokeCount === 1) {
+        // refineDocumentStructure 1st call
+        mockOptions.context.userContext.currentStructure = firstRefinedStructure;
+        return { documentStructure: firstRefinedStructure };
+      } else if (invokeCount === 2) {
+        // checkFeedbackRefiner 1st call
+        return {};
+      } else if (invokeCount === 3) {
+        // refineDocumentStructure 2nd call
+        mockOptions.context.userContext.currentStructure = finalRefinedStructure;
+        return { documentStructure: finalRefinedStructure };
+      } else {
+        // checkFeedbackRefiner 2nd call
+        return {};
+      }
+    });
 
     const result = await userReviewDocumentStructure({ documentStructure }, mockOptions);