@aigne/doc-smith 0.8.10-beta → 0.8.10-beta.1

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

@@ -1,7 +1,7 @@
 # Project information for documentation publishing
 projectName: AIGNE DocSmith
 projectDesc: AIGNE DocSmith is a powerful, AI-driven documentation generation tool built on the AIGNE Framework. It automates the creation of detailed, structured, and multi-language documentation directly from your source code.
-projectLogo: https://docsmith.aigne.io/image-bin/uploads/a7910a71364ee15a27e86f869ad59009.svg
+projectLogo: https://docsmith.aigne.io/image-bin/uploads/9645caf64b4232699982c4d940b03b90.svg
 
 # =============================================================================
 # Documentation Configuration
@@ -68,3 +68,5 @@ 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: ""

package/.aigne/doc-smith/preferences.yml

@@ -9,7 +9,7 @@ rules:
     active: true
     scope: document
     rule: When describing publishing options, should use plain text instead of custom components, and recommend users to run their own Discuss Kit instance while providing relevant links.
-    feedback: Publishing options should not use custom components: recommend users to run their own Discuss Kit instance in the text, and add Discuss Kit related links
+    feedback: "Publishing options should not use custom components: recommend users to run their own Discuss Kit instance in the text, and add Discuss Kit related links"
     createdAt: 2025-09-07T02:18:22.237Z
   - id: pref_039b58c47bdf95c9
     active: true
@@ -21,12 +21,12 @@ rules:
     active: true
     scope: document
     rule: When describing Discuss Kit, must clearly state that it is a non-open-source service running on the official platform, not a self-hosted instance.
-    feedback: In the core features description about document publishing, show the official platform link, run your own Discuss Kit instance, not self-hosted: Discuss Kit is not open source.
+    feedback: "In the core features description about document publishing, show the official platform link, run your own Discuss Kit instance, not self-hosted: Discuss Kit is not open source."
     createdAt: 2025-09-07T01:59:12.876Z
   - id: pref_0c239f619329089f
     active: true
     scope: document
-    rule: In the core features section, should use plain list format and add descriptions and links for AIGNE Hub and Discuss Kit.
+    rule: "In the core features section, should use plain list format and add descriptions and links for AIGNE Hub and Discuss Kit."
     feedback: Core features section should not use custom component lists, change to plain lists, add descriptions and links for AIGNE Hub and Discuss Kit to help users understand these two products
     createdAt: 2025-09-07T01:53:22.969Z
     paths:
@@ -34,7 +34,7 @@ rules:
   - id: pref_4e8aa735b11d8484
     active: true
     scope: document
-    rule: In the 'How It Works' document, only show DocSmith implementation details, should not include AIGNE Framework information.
+    rule: "In the 'How It Works' document, only show DocSmith implementation details, should not include AIGNE Framework information."
     feedback: How it works section does not need to show AIGNE Framework, only need to show DocSmith implementation
     createdAt: 2025-09-06T13:15:10.272Z
     paths:

package/.aigne/doc-smith/upload-cache.yaml

@@ -679,3 +679,183 @@ fcb9e91eb5d96bb427a2cea837c52772d4150f92d644850b6a4602bc43a2043b:
     https://docsmith.aigne.io:
       url: https://docsmith.aigne.io/image-bin/uploads/fcb9e91eb5d96bb4.svg
       upload_time: 2025-09-09T08:52:51.108Z
+1e4dff10610c71c41890b1e677af71a8a483eaffcdfe03d9ed5260bd01275d58:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/9aa45f34ddbfb189d0dabb4fd6bbdee773e1b93d9c437dce0119935afa0cbe32.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/1e4dff10610c71c4.svg
+      upload_time: 2025-09-15T08:31:20.831Z
+0575876331f46833cf4dd9919b11ba3b41a384b6c2c69d5868e49effb2dc5fc5:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/52bef7d565debaef43ee7eec2181c24d087a909405b3fafa759a45df5c087b18.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/0575876331f46833.svg
+      upload_time: 2025-09-15T08:31:22.707Z
+64fd55e9b8127285f39db001cffd796151340469b506a967eaab3b54bdccc26c:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/2fc9edefc1348df7031dc376b12bccc42fae98451f86c83ff92c144924f5ab80.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/64fd55e9b8127285.svg
+      upload_time: 2025-09-15T08:31:24.378Z
+84a9a489d9cab8353ca1ffa3309b1e12580be7dd40f6fe71909fb7a0a97e0856:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/28fd7c1acbf3166f9d6aec06f4fa31db3a5d96b26de0d80af857cc0f3b28d82e.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/84a9a489d9cab835.svg
+      upload_time: 2025-09-15T08:31:24.599Z
+bc4517d39ff669f3185b66f2fa6586cb195110cd3733039f49cfc099b70240dd:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/cbd2943d78da17df4ae1827dcf37320523afa2c754455540d0eefd72fae932d5.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/bc4517d39ff669f3.svg
+      upload_time: 2025-09-15T08:31:24.649Z
+d7551f9fce676609f6b1ed3fc966814acbe8fc4cddd08c939e269f6da6e01b18:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/6c2d5fd0b11bbea82be0e2634bb0fef087603fe950b10e6cf4c988e7f27bd507.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/d7551f9fce676609.svg
+      upload_time: 2025-09-15T08:31:24.893Z
+fd265f3486512dd4bd8509cf1e43b2457850176bb5fc856d0261e30ff1f28aa1:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/81305e5c9e3adbe30da63e27bdc9bdfdbf46edce579434558145f26fe60ee99a.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/fd265f3486512dd4.svg
+      upload_time: 2025-09-15T08:31:25.415Z
+3cbcedb39de9e0d0de56d7d699615a00beae800e341f9dff0be1f9831b9d7220:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/38c86557c522c4e0150b80d205f347add34996779e47e586457fb086dfc64c5c.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/3cbcedb39de9e0d0.svg
+      upload_time: 2025-09-15T08:31:25.671Z
+0eaf5f51d9d723e7cbf2577c2da3e82f471e3e3fc2f106d19f56a891778a3aef:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/8ca47d9e0fa8750203b418be8586f656662ea30b9259ddeb143ffd5c49d568a0.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/0eaf5f51d9d723e7.svg
+      upload_time: 2025-09-15T08:31:25.715Z
+4438da955604257d8a8db5dd1fa933378b3b87012c4a885d9b88764869563427:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/d82f93e726c285f14a42585aaeabcec650682a8ad7e5c9798922437436600e1e.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/4438da955604257d.svg
+      upload_time: 2025-09-15T08:31:25.905Z
+5bba835a63c0caf9c1cea14ce600904dbe0db237d6c62a45f552a926cf8008bc:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/395b6511ffa01359e34b1d1c22abae82139b2eb988d0e34b015228aed03b39a3.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/5bba835a63c0caf9.svg
+      upload_time: 2025-09-15T08:31:26.052Z
+d35ddf8b96aa36f4e32fde88e3ad00253ce35decd0ecabf8d3d2af50f1f5710d:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/864048a2d47a45193018b5caf8608c3b5f159761a97eac9c4813a3d9e07da885.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/d35ddf8b96aa36f4.svg
+      upload_time: 2025-09-15T08:31:26.866Z
+16dbd59009ffd80ebf82f766446f6e1925e832cbfe9df5a547702a7f250bf2b3:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/48d69eddbbe4263ddbe0c3f7f2f396f6d3cc56a063cd6c536edd817e2e6154fa.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/16dbd59009ffd80e.svg
+      upload_time: 2025-09-15T08:31:27.064Z
+12f7cdf80192f9a3909a72873eed14bbd88b58c92c68154ed3f9088e7777b552:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/97707cf8ac1f5f503254b3814f1004619869459ddcc4c289ebb789d5336a7686.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/12f7cdf80192f9a3.svg
+      upload_time: 2025-09-15T08:31:27.074Z
+7c243e620bad76070d4fe26b584cc6134cdcfb92cd87a9f1e5fdc36169390c7f:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/c277aa9275295ad1e691085c63be4ead6a6eea9262589ca1f7437b2b49a45214.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/7c243e620bad7607.svg
+      upload_time: 2025-09-15T08:31:27.291Z
+d4cbfef7bd18e8b58a0e932d99ebe50790d3098faad337920ffd447e2239bc53:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/f4afbd5d17fe6d77f0210c7d65dd71fe7ae0039f47200b2f176162d1550ddc41.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/d4cbfef7bd18e8b5.svg
+      upload_time: 2025-09-15T08:31:27.311Z
+78530f0fea4c7c9bbd061f01aa94108a894fbb739cadf50af0f92966b7654a2e:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/e9846ccaea32a3caa0fe807983decc8efe088a3bd879f4b97078f30c0aa93b8b.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/78530f0fea4c7c9b.svg
+      upload_time: 2025-09-15T08:31:27.522Z
+b48ffb9056a7961973b77dd7c75d1ac03c6f8425b5eec1222d991586faf00fad:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/b0455fe35b77e2f8140f3fc86e537449c5b2c4bd90ac5f692e4c31d912ddd14e.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/b48ffb9056a79619.svg
+      upload_time: 2025-09-15T08:31:28.288Z
+f6391f1418793dda4601a83ed00566007b14d79de8d350a0f611526dd2c6bd96:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/ddd293213f319d5d381eee32f0526468445a7ccd6d16c2b2aae2f54ec632e156.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/f6391f1418793dda.svg
+      upload_time: 2025-09-15T08:31:28.487Z
+4ca65083aa5011b1bb359648c9bcd25ca8e4e0f9db8d7c1d78bbcc57a893f519:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/57d33cb81570f720b9ba6a44584a8d70545aa761f6917ce7c03896ea995a7b9c.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/4ca65083aa5011b1.svg
+      upload_time: 2025-09-15T08:31:28.498Z
+a0f49cec9cb0581454143380c04f0f5e9de21cf4dd2c8e88920b25ad73d5ecb9:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/6adde2cae9254e1d6163c4eb26060b7c5ccfdb7e3f330050fa0830fb940437bf.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/a0f49cec9cb05814.svg
+      upload_time: 2025-09-15T08:31:29.934Z
+5f6eff6f75c2d5727eb5188146c7de5852500a0c8c53f568cce08bf0574932f1:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/bb951d89940cdcd26babb821411293ac121b1d18ab7d8fa98f0d76a0518fe722.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/5f6eff6f75c2d572.svg
+      upload_time: 2025-09-15T08:31:31.521Z
+bb38d805dca014fba865d76cf9236c4bb5d25000d6022a529efabc85ac697826:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/6c404f0415cfabaf16f2d27507c976e0cdc1b8e3a043848542b32a12205c68f7.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/bb38d805dca014fb.svg
+      upload_time: 2025-09-15T09:19:15.767Z
+e125a9bee97a1559f4a05f639fd32338c4b91fd5d9f821cdca9b4a8a225b7282:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/be505db11bcffbd1cfe4df9dfc522d3b9aff3cf7bb72768881ed090be634240a.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/e125a9bee97a1559.svg
+      upload_time: 2025-09-15T09:19:16.217Z
+581f7aa1f8d93d59a04fd6b2fa3eeb1410649942fdc300a62228444ca910fa48:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/31c9b92f2b30a114fad120e2b2ae150ab4f9e239a6560fba2668179b73a446c0.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/581f7aa1f8d93d59.svg
+      upload_time: 2025-09-15T09:19:16.597Z
+9ca1a93a7f9fe0057cb9a9bf5bad0202d0ef3cd28f6b1857b82e16ccce8d5133:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/1edf15b8b1ff3d8607f13fecfcd627773f1284d15cafa8ca0bac0c6624bbb154.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/9ca1a93a7f9fe005.svg
+      upload_time: 2025-09-15T09:19:17.160Z
+2f9c174f56c0e5533ed64108ac3762af640e31d249a82640e4e54c81590b753c:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/b908079f1cc54afc4c1c5a6a886d7e091e468015796d3dbb168be328abc22510.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/2f9c174f56c0e553.svg
+      upload_time: 2025-09-15T09:19:17.499Z
+ca88fe5d71038ea7ae1b513eff9e36f3a0c7575b9a987962b41b8c0c8b7833ba:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/38dcd78d8fed89db3e10cd132992104c6c1931422e822d7dcc985219e28468f8.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/ca88fe5d71038ea7.svg
+      upload_time: 2025-09-15T09:19:18.564Z
+81b3f8028f9876b12d157e9061c71c41d271ee3518993332ada253a2d81117f7:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/b9e214140048bde93680e60ceede78e480d37d5087007768f2d916c62a6d152f.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/81b3f8028f9876b1.svg
+      upload_time: 2025-09-15T09:19:18.680Z
+6b09e27f6cd19989639bca1f59ede5c7d07ea521c87a463a7cd8cf7106dc8917:
+  local_path: .aigne/doc-smith/.tmp/assets/d2/832e17e386da95eb568a10a5769cee0698954324d044ae449fc7ce6bc96d87a8.svg
+  sites:
+    https://docsmith.aigne.io:
+      url: https://docsmith.aigne.io/image-bin/uploads/6b09e27f6cd19989.svg
+      upload_time: 2025-09-15T09:19:20.715Z

package/.release-please-manifest.json

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

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [0.8.10-beta.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.10-beta...v0.8.10-beta.1) (2025-09-18)
+
+
+### Features
+
+* support document structure review workflow ([#117](https://github.com/AIGNE-io/aigne-doc-smith/issues/117)) ([ec7ae80](https://github.com/AIGNE-io/aigne-doc-smith/commit/ec7ae80b26a1b66928bddef7ac401f633a0f5a2b))
+
+
+### Bug Fixes
+
+* improve English language consistency and clarity ([#118](https://github.com/AIGNE-io/aigne-doc-smith/issues/118)) ([74c9e8e](https://github.com/AIGNE-io/aigne-doc-smith/commit/74c9e8e19a78767c32da772133662818b8e50715))
+* update doc-smith logo ([#114](https://github.com/AIGNE-io/aigne-doc-smith/issues/114)) ([52ab351](https://github.com/AIGNE-io/aigne-doc-smith/commit/52ab3519d98533f26c1a18203be51e0965c586bc))
+
 ## [0.8.10-beta](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.9...v0.8.10-beta) (2025-09-16)
 
 

package/README.md

@@ -17,7 +17,7 @@ As shown in the diagram, DocSmith integrates seamlessly with other [AIGNE](https
 
 ## Features
 
-- **Automated Generate Document Structure:** Intelligently analyzes your codebase to generate a comprehensive and logical document structure.
+- **Automated Document Structure Generation:** Intelligently analyzes your codebase to generate a comprehensive and logical document structure.
 - **AI-Powered Content Generation:** Populates the document structure with detailed, high-quality content.
 - **Multi-Language Support:** Seamlessly translates your documentation into 12 languages including English, Chinese, Japanese, Korean, Spanish, French, German, Portuguese, Russian, Italian, and Arabic.
 - **AIGNE Hub Integration:** Use [AIGNE Hub](https://www.aigne.io/en/hub) as your LLM provider without needing your own API keys, with easy switching between different large language models.
@@ -231,7 +231,7 @@ Publish your documentation to Discuss Kit platforms:
 aigne doc publish
 ```
 
-**Interactive Publishing:** When run `aigne doc publish` will present an interactive menu for you to choose between:
+**Interactive Publishing:** When you run `aigne doc publish`, it will present an interactive menu for you to choose between:
 - **Official Platform:** [docsmith.aigne.io](https://docsmith.aigne.io/app/)
 - **Own Instance:** Your own deployed [Discuss Kit](https://store.blocklet.dev/blocklets/z8ia1WEiBZ7hxURf6LwH21Wpg99vophFwSJdu) instance
 

package/RELEASE.md

@@ -1,10 +1,10 @@
 ### Release a beta version
 
-Create normal pr, release-please will auto create a beta version PR.  
+Create a normal PR, and release-please will automatically create a beta version PR.  
 Merge that PR when appropriate.
 
 ### Release a prod version
 
-When you want publish a prod version, you can run `git commit --allow-empty -m "chore: release x.x.x" -m "Release-As: x.x.x"` to main.  
-release-please will update PR to release to specific version (without beta).  
+When you want to publish a production version, you can run `git commit --allow-empty -m "chore: release x.x.x" -m "Release-As: x.x.x"` to main.  
+release-please will update the PR to release to a specific version (without beta).  
 Merge that PR when appropriate.

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

@@ -1,5 +1,6 @@
 import { access } from "node:fs/promises";
 import { join } from "node:path";
+import chalk from "chalk";
 import { getActiveRulesForScope } from "../../utils/preferences-utils.mjs";
 import {
   getCurrentGitHead,
@@ -13,23 +14,45 @@ export default async function checkNeedGenerateStructure(
   { originalDocumentStructure, feedback, lastGitHead, docsDir, forceRegenerate, ...rest },
   options,
 ) {
-  // Check if we need to regenerate document structure
-  let shouldRegenerate = false;
-  let finalFeedback = feedback;
-  let submittedFeedback = feedback;
-
-  // Prompt for feedback if originalDocumentStructure exists and no feedback provided
-  if (originalDocumentStructure && !feedback) {
-    const userFeedback = await options.prompts.input({
-      message: "How can we improve the documentation structure? (press Enter to skip):",
+  // Check if originalDocumentStructure is empty and prompt user
+  if (!originalDocumentStructure) {
+    const choice = await options.prompts.select({
+      message:
+        "Your project configuration is complete. Would you like to generate the document structure now?",
+      choices: [
+        {
+          name: "Generate now - Start building the document structure",
+          value: "generate",
+        },
+        {
+          name: "Review configuration first - Modify settings before generating",
+          value: "later",
+        },
+      ],
     });
 
-    if (userFeedback?.trim()) {
-      finalFeedback = userFeedback.trim();
-      submittedFeedback = userFeedback.trim();
+    if (choice === "later") {
+      console.log(`\nConfiguration file: ${chalk.cyan("./.aigne/doc-smith/config.yaml")}`);
+      console.log(
+        "Review and modify your configuration as needed, then run 'aigne doc generate' to continue.",
+      );
+
+      // In test environment, return a special result instead of exiting
+      if (process.env.NODE_ENV === "test") {
+        return {
+          userDeferred: true,
+          documentStructure: null,
+        };
+      }
+
+      process.exit(0);
     }
   }
 
+  // Check if we need to regenerate document structure
+  let shouldRegenerate = false;
+  let finalFeedback = feedback;
+
   // If no feedback and originalDocumentStructure exists, check for git changes
   if (originalDocumentStructure) {
     // If no lastGitHead, check if _sidebar.md exists to determine if we should regenerate
@@ -85,7 +108,7 @@ export default async function checkNeedGenerateStructure(
     };
   }
 
-  const panningAgent = options.context.agents["refineDocumentStructure"];
+  const planningAgent = options.context.agents["refineDocumentStructure"];
 
   // Get user preferences for document structure and global scope
   const structureRules = getActiveRulesForScope("structure", []);
@@ -98,11 +121,11 @@ export default async function checkNeedGenerateStructure(
   // Convert rule texts to string format for passing to the agent
   const userPreferences = ruleTexts.length > 0 ? ruleTexts.join("\n\n") : "";
 
-  const result = await options.context.invoke(panningAgent, {
-    feedback: finalFeedback || "",
+  const result = await options.context.invoke(planningAgent, {
+    ...rest,
     originalDocumentStructure,
     userPreferences,
-    ...rest,
+    feedback: finalFeedback || "",
   });
 
   let message = "";
@@ -144,7 +167,7 @@ export default async function checkNeedGenerateStructure(
         }
 
         if (hasUpdated) {
-          message = `\n### Auto-updated Project Info to \`.aigne/doc-smith/config.yaml\`\n\n${message}\n\n`;
+          message = `\n### Project Information Updated\n\nSaved to \`.aigne/doc-smith/config.yaml\`:\n\n${message}\n\n`;
         }
       }
     } catch (error) {
@@ -155,7 +178,6 @@ export default async function checkNeedGenerateStructure(
   return {
     ...result,
     feedback: "", // clear feedback
-    documentStructureFeedback: submittedFeedback,
     projectInfoMessage: message,
     originalDocumentStructure: originalDocumentStructure
       ? originalDocumentStructure

package/agents/generate/index.yaml

@@ -10,6 +10,7 @@ skills:
       skipIfExists: true
   - ../utils/load-sources.mjs
   - ./check-need-generate-structure.mjs
+  - ./user-review-document-structure.mjs
   - url: ../utils/save-output.mjs
     default_input:
       saveKey: documentStructure

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

@@ -0,0 +1,168 @@
+import { getActiveRulesForScope } from "../../utils/preferences-utils.mjs";
+
+function formatDocumentStructure(structure) {
+  // Build a tree structure for better display
+  const nodeMap = new Map();
+  const rootNodes = [];
+
+  // First pass: create node map
+  structure.forEach((node) => {
+    nodeMap.set(node.path, {
+      ...node,
+      children: [],
+    });
+  });
+
+  // Second pass: build tree structure
+  structure.forEach((node) => {
+    if (node.parentId) {
+      const parent = nodeMap.get(node.parentId);
+      if (parent) {
+        parent.children.push(nodeMap.get(node.path));
+      } else {
+        rootNodes.push(nodeMap.get(node.path));
+      }
+    } else {
+      rootNodes.push(nodeMap.get(node.path));
+    }
+  });
+
+  function printNode(node, depth = 0) {
+    const INDENT_SPACES = "  ";
+    const FOLDER_ICON = "📁";
+    const FILE_ICON = "📄";
+    const indent = INDENT_SPACES.repeat(depth);
+    const prefix = depth === 0 ? FOLDER_ICON : FILE_ICON;
+
+    console.log(`${indent}${prefix} ${node.title}`);
+
+    if (node.children && node.children.length > 0) {
+      node.children.forEach((child) => {
+        printNode(child, depth + 1);
+      });
+    }
+  }
+
+  return { rootNodes, printNode };
+}
+
+export default async function userReviewDocumentStructure({ documentStructure, ...rest }, options) {
+  // Check if document structure exists
+  if (!documentStructure || !Array.isArray(documentStructure) || documentStructure.length === 0) {
+    console.log("No document structure was generated to review.");
+    return { documentStructure };
+  }
+
+  // Ask user if they want to review the document structure
+  const needReview = await options.prompts.select({
+    message:
+      "Would you like to review the document structure?\n  You can modify titles, reorganize sections, or refine content outlines.",
+    choices: [
+      {
+        name: "Looks good - proceed with current structure",
+        value: "no",
+      },
+      {
+        name: "Review and provide feedback",
+        value: "yes",
+      },
+    ],
+  });
+
+  if (needReview === "no") {
+    return { documentStructure };
+  }
+
+  let currentStructure = documentStructure;
+
+  const MAX_ITERATIONS = 100;
+  let iterationCount = 0;
+  while (iterationCount < MAX_ITERATIONS) {
+    iterationCount++;
+
+    // Print current document structure in a user-friendly format
+    console.log(`\n${"=".repeat(50)}`);
+    console.log("Current Document Structure");
+    console.log("=".repeat(50));
+
+    const { rootNodes, printNode } = formatDocumentStructure(currentStructure);
+
+    if (rootNodes.length === 0) {
+      console.log("No document structure found.");
+    } else {
+      rootNodes.forEach((node) => printNode(node));
+    }
+
+    console.log(`${"=".repeat(50)}\n`);
+
+    // Ask for feedback
+    const feedback = await options.prompts.input({
+      message:
+        "How would you like to improve the structure?\n" +
+        "  • Rename, reorganize, add, or remove sections\n" +
+        "  • Adjust content outlines for clarity\n\n" +
+        "  Press Enter to finish reviewing:",
+    });
+
+    // If no feedback, break the loop
+    if (!feedback?.trim()) {
+      break;
+    }
+
+    // Get the refineDocumentStructure agent
+    const refineAgent = options.context.agents["refineDocumentStructure"];
+    if (!refineAgent) {
+      console.log(
+        "Unable to process your feedback - the structure refinement feature is unavailable.",
+      );
+      console.log("Please try again later or contact support if this continues.");
+      break;
+    }
+
+    // Get user preferences
+    const structureRules = getActiveRulesForScope("structure", []);
+    const globalRules = getActiveRulesForScope("global", []);
+    const allApplicableRules = [...structureRules, ...globalRules];
+    const ruleTexts = allApplicableRules.map((rule) => rule.rule);
+    const userPreferences = ruleTexts.length > 0 ? ruleTexts.join("\n\n") : "";
+
+    try {
+      // Call refineDocumentStructure agent with feedback
+      const result = await options.context.invoke(refineAgent, {
+        ...rest,
+        feedback: feedback.trim(),
+        originalDocumentStructure: currentStructure,
+        userPreferences,
+      });
+
+      if (result.documentStructure) {
+        currentStructure = result.documentStructure;
+      }
+
+      // Check if feedback should be saved as user preference
+      const feedbackRefinerAgent = options.context.agents["checkFeedbackRefiner"];
+      if (feedbackRefinerAgent) {
+        try {
+          await options.context.invoke(feedbackRefinerAgent, {
+            documentStructureFeedback: feedback.trim(),
+            stage: "structure",
+          });
+        } catch (refinerError) {
+          console.warn("Could not save feedback as user preference:", refinerError.message);
+          console.warn("Your feedback was applied but not saved as a preference.");
+        }
+      }
+    } catch (error) {
+      console.error("Error processing your feedback:");
+      console.error(`Type: ${error.name}`);
+      console.error(`Message: ${error.message}`);
+      console.error(`Stack: ${error.stack}`);
+      console.log("\nPlease try rephrasing your feedback or continue with the current structure.");
+      break;
+    }
+  }
+
+  return { documentStructure: currentStructure };
+}
+
+userReviewDocumentStructure.taskTitle = "User review and modify document structure";

package/agents/update/generate-and-translate-document.yaml

@@ -1,6 +1,6 @@
 type: team
 name: generateAndTranslateDocument
-description: Generate document and translate
+description: Generate and translate documents
 skills:
   - ../utils/transform-detail-datasources.mjs
   - type: team
@@ -70,12 +70,12 @@ input_schema:
       type: array
       items:
         type: string
-        description: Included file names
+        description: Included file name patterns
     excludePatterns:
       type: array
       items:
         type: string
-        description: Excluded file names
+        description: Excluded file name patterns
     outputDir:
       type: string
       description: Output directory

package/agents/utils/check-feedback-refiner.mjs

@@ -77,3 +77,5 @@ checkFeedbackRefiner.input_schema = {
     },
   },
 };
+
+checkFeedbackRefiner.taskRenderMode = "collapse";

package/agents/utils/save-docs.mjs

@@ -42,38 +42,32 @@ export default async function saveDocs({
     console.error("Failed to cleanup invalid .md files:", err.message);
   }
 
-  const message = `## ✅ Documentation Generated Successfully!
+  const message = `# ✅ Documentation Generated Successfully!
 
-  Successfully generated **${documentStructure.length}** documents and saved to:
-  \`${docsDir}\`
-  ${projectInfoMessage || ""}
-  ### 🚀 Next Steps
+Generated **${documentStructure.length}** documents and saved to: \`${docsDir}\`
+${projectInfoMessage || ""}
+## 🚀 Next Steps
 
-  1. Publish Documentation
+**Publish Your Documentation**
 
-     \`\`\`bash
-     aigne doc publish
-     \`\`\`
+Generate a shareable preview link for your team:
 
-     Get an online preview link to share with your team
+  \`aigne doc publish\`
 
-  ### 🔧 Optional Improvements
+## 🔧 Optional Actions
 
-  1. Update Specific Documents
+**Update Specific Documents**
 
-     \`\`\`bash
-     aigne doc update
-     \`\`\`
+Regenerate content for individual documents:
 
-     Regenerate content for specific documents
+  \`aigne doc update\`
 
-  2. Provide Structure Feedback
-     \`\`\`bash
-     aigne doc generate --feedback "Your feedback on document structure"
-     \`\`\`
-     Improve the overall documentation structure
+**Refine Document Structure**
+
+Review and improve your documentation organization:
+
+  \`aigne doc generate\`
 
-  ---
   `;
 
   // Shutdown mermaid worker pool to ensure clean exit