@aigne/doc-smith 0.8.5 → 0.8.6

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [0.8.6](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.5...v0.8.6) (2025-09-11)
+
+
+### Features
+
+* add deploy unit tests and improve publish workflow with better logging ([e33a94b](https://github.com/AIGNE-io/aigne-doc-smith/commit/e33a94bef5eda09398901fa1f953e662ae5fbd16))
+* **publish:** display publish url for the default publish processing ([9d1d018](https://github.com/AIGNE-io/aigne-doc-smith/commit/9d1d0180dc9c8bb0a4393a893eed2395eec300ab))
+
+
+### Bug Fixes
+
+* **deploy:** ensure log is saved after await to prevent save failure ([793343f](https://github.com/AIGNE-io/aigne-doc-smith/commit/793343fc7f96ab962e70eb310cb07f4e7eaec9e0))
+
+
+### Miscellaneous Chores
+
+* release 0.8.6 ([1e25cb4](https://github.com/AIGNE-io/aigne-doc-smith/commit/1e25cb49a26d8bcc3c83ec36120b6bad4042cadf))
+
 ## [0.8.5](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.4...v0.8.5) (2025-09-10)
 
 

package/agents/action-success.mjs

@@ -9,7 +9,7 @@ export default async function actionSuccess({ action }) {
   }
 
   return {
-    message: `✅ ${action} successfully`,
+    message: `${action}`,
   };
 }
 

package/agents/check-structure-plan.mjs

@@ -21,7 +21,7 @@ export default async function checkStructurePlan(
   // Prompt for feedback if originalStructurePlan exists and no feedback provided
   if (originalStructurePlan && !feedback) {
     const userFeedback = await options.prompts.input({
-      message: "Please provide feedback for structure planning (press Enter to skip):",
+      message: "How can we improve the documentation structure? (press Enter to skip):",
     });
 
     if (userFeedback?.trim()) {

package/agents/detail-regenerator.yaml

@@ -2,7 +2,7 @@ type: team
 name: update
 alias:
   - up
-description: Optimize and regenerate individual document content and translations
+description: Update specific documents and their translations
 skills:
   - url: ./input-generator.mjs
     default_input:
@@ -39,24 +39,24 @@ skills:
       stage: document_refine
   - url: ./action-success.mjs
     default_input:
-      action: "Document updated"
+      action: "✅ Documents updated successfully"
 input_schema:
   type: object
   properties:
     glossary:
       type: string
-      description: Glossary of terms for consistent terminology, use @<file> to read from a file
+      description: Glossary file for consistent terminology (use @filename.md)
     docs:
       type: array
       items:
         type: string
-      description: Document paths to translate
+      description: Documents to update
     feedback:
       type: string
-      description: Feedback for content improvement
+      description: Tell us what to change in this content
     reset:
       type: boolean
-      description: Ignore previous results and regenerate content from scratch
+      description: Start fresh - ignore previous versions
 output_schema:
   type: object
   properties:

package/agents/docs-generator.yaml

@@ -3,7 +3,7 @@ name: generate
 alias:
   - gen
   - g
-description: Automatically generates comprehensive project documentation
+description: Generate complete documentation for your project
 skills:
   - url: ./input-generator.mjs
     default_input:
@@ -47,13 +47,13 @@ input_schema:
   properties:
     glossary:
       type: string
-      description: Glossary of terms for consistent terminology, use @<file> to read from a file
+      description: Glossary file for consistent terminology (use @filename.md)
     feedback:
       type: string
-      description: Feedback for structure planning adjustments
+      description: Tell us how to improve the documentation structure
     forceRegenerate:
       type: boolean
-      description: Force regenerate all documentation
+      description: Rebuild all documentation from scratch
   required:
     - config
 mode: sequential

package/agents/feedback-refiner.yaml

@@ -1,5 +1,5 @@
 name: feedbackRefiner
-description: Analyzes a user's specific feedback on generated documentation and refines it into a general, reusable preference rule for future use.
+description: Learn from your feedback to improve future documentation
 
 # The instructions file contains the core logic (the prompt) for this Agent.
 instructions:
@@ -10,18 +10,18 @@ input_schema:
   properties:
     feedback:
       type: string
-      description: User's original feedback
+      description: Tell us what you think about the documentation
     stage:
       type: string
-      description: The command/scenario that generated the feedback (used to infer scope), possible values. structure_planning, document_refine, translation_refine
+      description: Which part of the process this feedback is about (structure_planning, document_refine, translation_refine)
     paths:
       type: array
       items:
         type: string
-      description: Optional. Document paths specified by the user in the current command
+      description: Specific documents this feedback applies to (optional)
     existingPreferences:
       type: string
-      description: Optional. YAML format string of currently saved user preference rules, used to avoid duplicate saving of similar rules
+      description: Your existing preferences to avoid duplicates (optional)
   required: 
     - feedback
     - stage
@@ -31,19 +31,19 @@ output_schema:
   properties:
     rule:
       type: string
-      description: Refine and summarize user feedback into a general rule
+      description: General rule created from your feedback
     scope:
       type: string
-      description: Rule scope. global, structure, document, translation
+      description: Where this rule applies (global, structure, document, translation)
     save:
       type: boolean
-      description: Whether to save as persistent preference (true=save; false=one-time, do not save)
+      description: Should we remember this preference for next time?
     limitToInputPaths:
       type: boolean
-      description: Whether to limit to the "paths specified in current input" when used subsequently
+      description: Apply only to the specific documents mentioned?
     reason:
       type: string
-      description: Explanation of why the save decision was made and how the rule and scope were derived
+      description: Why we made this decision and how the rule was created
   required:
     - rule
     - scope

package/agents/find-item-by-path.mjs

@@ -89,7 +89,7 @@ export default async function findItemByPath(
   if (!userFeedback) {
     const feedbackMessage = getActionText(
       isTranslate,
-      "Please provide feedback for the {action} (press Enter to skip):",
+      "How should we improve this {action}? (press Enter to skip):",
     );
 
     userFeedback = await options.prompts.input({

package/agents/find-items-by-paths.mjs

@@ -90,7 +90,7 @@ export default async function selectedDocs(
   if (!userFeedback) {
     const feedbackMessage = getActionText(
       isTranslate,
-      "Please provide feedback for the {action} (press Enter to skip):",
+      "How should we improve this {action}? (press Enter to skip):",
     );
 
     userFeedback = await options.prompts.input({

package/agents/input-generator.mjs

@@ -44,14 +44,14 @@ export default async function init(
   }
 
   console.log("🚀 Welcome to AIGNE DocSmith!");
-  console.log("Let's create your documentation configuration.\n");
+  console.log("Let's set up your documentation preferences.\n");
 
   // Collect user information
   const input = {};
 
   // 1. Primary purpose - what's the main outcome you want readers to achieve?
   const purposeChoices = await options.prompts.checkbox({
-    message: "📝 [1/8]: What is the primary goal for your readers? (Select all that apply)",
+    message: "📝 [1/8]: What should your documentation help readers achieve?",
     choices: Object.entries(DOCUMENT_STYLES)
       .filter(([key]) => key !== "custom") // Remove custom option for multiselect
       .map(([key, style]) => ({
@@ -61,7 +61,7 @@ export default async function init(
       })),
     validate: (input) => {
       if (input.length === 0) {
-        return "Please select at least one purpose.";
+        return "Please choose at least one goal for your documentation.";
       }
       return true;
     },
@@ -81,10 +81,10 @@ export default async function init(
         })),
       validate: (input) => {
         if (input.length === 0) {
-          return "Please select at least one priority.";
+          return "Please choose at least one priority.";
         }
         if (input.length > 2) {
-          return "Please select maximum 2 priorities.";
+          return "Please choose maximum 2 priorities.";
         }
         return true;
       },
@@ -99,7 +99,7 @@ export default async function init(
 
   // 2. Target audience - who will be reading this most often?
   const audienceChoices = await options.prompts.checkbox({
-    message: "👥 [2/8]: Who is the primary audience for this documentation?",
+    message: "👥 [2/8]: Who will be reading your documentation?",
     choices: Object.entries(TARGET_AUDIENCES)
       .filter(([key]) => key !== "custom") // Remove custom option for multiselect
       .map(([key, audience]) => ({
@@ -109,7 +109,7 @@ export default async function init(
       })),
     validate: (input) => {
       if (input.length === 0) {
-        return "Please select at least one audience.";
+        return "Please choose at least one audience.";
       }
       return true;
     },
@@ -133,7 +133,7 @@ export default async function init(
   );
 
   const knowledgeChoice = await options.prompts.select({
-    message: "🧠 [3/8]: What is your reader's typical starting knowledge level?",
+    message: "🧠 [3/8]: How much do readers already know about your project?",
     choices: Object.entries(filteredKnowledgeOptions).map(([key, level]) => ({
       name: `${level.name}`,
       description: level.description,
@@ -178,7 +178,7 @@ export default async function init(
   );
 
   const depthChoice = await options.prompts.select({
-    message: "📊 [4/8]: How comprehensive should the documentation be?",
+    message: "📊 [4/8]: How detailed should your documentation be?",
     choices: Object.entries(filteredDepthOptions).map(([key, depth]) => ({
       name: `${depth.name}`,
       description: depth.description,
@@ -196,7 +196,7 @@ export default async function init(
 
   // Let user select primary language from supported list
   const primaryLanguageChoice = await options.prompts.select({
-    message: "🌐 [5/8]: Choose primary documentation language:",
+    message: "🌐 [5/8]: What's your main documentation language?",
     choices: SUPPORTED_LANGUAGES.map((lang) => ({
       name: `${lang.label} - ${lang.sample}`,
       value: lang.code,
@@ -213,7 +213,7 @@ export default async function init(
   );
 
   const translateLanguageChoices = await options.prompts.checkbox({
-    message: "🔄 [6/8]: Select translation languages:",
+    message: "🔄 [6/8]: Which languages should we translate to?",
     choices: availableTranslationLanguages.map((lang) => ({
       name: `${lang.label} - ${lang.sample}`,
       value: lang.code,
@@ -224,21 +224,23 @@ export default async function init(
 
   // 7. Documentation directory
   const docsDirInput = await options.prompts.input({
-    message: `📁 [7/8]: Where to save generated docs:`,
+    message: `📁 [7/8]: Where should we save your documentation?`,
     default: `${outputPath}/docs`,
   });
   input.docsDir = docsDirInput.trim() || `${outputPath}/docs`;
 
-  // 8. Source code paths
-  console.log("\n🔍 [8/8]: Source Code Paths");
-  console.log("Enter paths to analyze for documentation (e.g., ./src, ./lib)");
-  console.log("💡 You can also enter glob patterns (e.g., src/**/*.js, **/*.md)");
-  console.log("💡 If no paths are configured, './' will be used as default");
+  // 8. Content sources
+  console.log("\n🔍 [8/8]: Content Sources");
+  console.log(
+    "What folders/files should we analyze for documentation? (e.g., ./src, ./docs, ./README.md)",
+  );
+  console.log("💡 Advanced: Use patterns like src/**/*.js or docs/**/*.md for specific files");
+  console.log("💡 Leave empty to scan everything");
 
   const sourcePaths = [];
   while (true) {
     const selectedPath = await options.prompts.search({
-      message: "Path or glob pattern:",
+      message: "File/folder path or pattern:",
       source: async (input) => {
         if (!input || input.trim() === "") {
           return [
@@ -330,15 +332,13 @@ export default async function init(
     await mkdir(dirPath, { recursive: true });
 
     await writeFile(filePath, yamlContent, "utf8");
-    console.log(`\n🎉 Configuration saved to: ${chalk.cyan(filePath)}`);
+    console.log(`\n✅ Setup complete! Configuration saved to: ${chalk.cyan(filePath)}`);
     // Print YAML content for user review
     console.log(chalk.cyan("---"));
     console.log(chalk.cyan(yamlContent));
     console.log(chalk.cyan("---"));
     console.log("💡 You can edit the configuration file anytime to modify settings.\n");
-    console.log(
-      `🚀 Run ${chalk.cyan("'aigne doc generate'")} to start documentation generation!\n`,
-    );
+    console.log(`🚀 Ready to generate docs? Run: ${chalk.cyan("aigne doc generate")}\n`);
 
     return {};
   } catch (error) {

package/agents/manage-prefs.mjs

@@ -8,7 +8,7 @@ function listPreferences() {
   const preferences = readPreferences();
 
   if (preferences.rules.length === 0) {
-    return { message: "No preferences found." };
+    return { message: "No saved preferences found." };
   }
 
   let message = "# User Preferences\n\n";
@@ -53,7 +53,7 @@ async function removePreferences(id, options) {
   if (!targetIds || targetIds.length === 0) {
     // Interactive selection
     if (preferences.rules.length === 0) {
-      return { message: "No preferences found to remove." };
+      return { message: "No preferences available to remove." };
     }
 
     const choices = preferences.rules.map((rule) => ({
@@ -63,18 +63,18 @@ async function removePreferences(id, options) {
     }));
 
     targetIds = await options.prompts.checkbox({
-      message: "Select preferences to remove:",
+      message: "Choose preferences to delete:",
       choices,
       validate: (answer) => {
         if (answer.length === 0) {
-          return "Please select at least one preference to remove";
+          return "Please choose at least one preference to delete";
         }
         return true;
       },
     });
 
     if (!targetIds || targetIds.length === 0) {
-      return { message: "No preferences selected for removal." };
+      return { message: "No preferences selected for deletion." };
     }
   }
 
@@ -108,7 +108,7 @@ async function togglePreferences(id, options) {
   if (!targetIds || targetIds.length === 0) {
     // Interactive selection
     if (preferences.rules.length === 0) {
-      return { message: "No preferences found to toggle." };
+      return { message: "No preferences available to toggle." };
     }
 
     const choices = preferences.rules.map((rule) => ({
@@ -118,18 +118,18 @@ async function togglePreferences(id, options) {
     }));
 
     targetIds = await options.prompts.checkbox({
-      message: "Select preferences to toggle active status:",
+      message: "Choose preferences to enable/disable:",
       choices,
       validate: (answer) => {
         if (answer.length === 0) {
-          return "Please select at least one preference to toggle";
+          return "Please choose at least one preference to toggle";
         }
         return true;
       },
     });
 
     if (!targetIds || targetIds.length === 0) {
-      return { message: "No preferences selected for toggling." };
+      return { message: "No preferences selected to toggle." };
     }
   }
 
@@ -172,7 +172,7 @@ export default async function prefs({ list, remove, toggle, id }, options) {
     return await togglePreferences(id, options);
   }
 
-  return { message: "Please specify an action: --list, --remove, or --toggle." };
+  return { message: "Please choose an action: --list, --remove, or --toggle." };
 }
 
 prefs.input_schema = {
@@ -180,24 +180,24 @@ prefs.input_schema = {
   properties: {
     list: {
       type: "boolean",
-      description: "List all preferences",
+      description: "Show all saved preferences",
     },
     remove: {
       type: "boolean",
-      description: "Remove preferences",
+      description: "Delete saved preferences",
     },
     toggle: {
       type: "boolean",
-      description: "Toggle preferences active status",
+      description: "Enable/disable preferences",
     },
     id: {
       type: "array",
       items: {
         type: "string",
       },
-      description: "Preference IDs to manage",
+      description: "Specific preference IDs to work with",
     },
   },
 };
 
-prefs.description = "Manage user preferences learned from feedback";
+prefs.description = "Manage your saved documentation preferences";

package/agents/publish-docs.mjs

@@ -53,21 +53,17 @@ export default async function publishDocs(
       message: "Select platform to publish your documents:",
       choices: [
         {
-          name:
-            chalk.blue("Publish to docsmith.aigne.io") +
-            " - free, but your documents will be publicly accessible, recommended for open-source projects",
+          name: `${chalk.blue("DocSmith Cloud (docsmith.aigne.io)")} – ${chalk.green("Free")} hosting. Your documents will be publicly accessible. Best for open-source projects or community sharing.`,
           value: "default",
         },
         {
-          name: `${chalk.blue("Publish to your existing website")} - use your current website`,
+          name: `${chalk.blue("Your existing website")} - Integrate and publish directly on your current site (setup required)`,
           value: "custom",
         },
         ...(hasCachedCheckoutId && hasDocSmithBaseUrl
           ? [
               {
-                name:
-                  chalk.yellow("Continue your previous website setup") +
-                  " - resume from where you left off",
+                name: `${chalk.yellow("Resume previous website setup")} - ${chalk.green("Already paid.")} Continue where you left off. Your payment is already processed.`,
                 value: "new-instance-continue",
               },
             ]
@@ -75,7 +71,7 @@ export default async function publishDocs(
         ...(hasDocSmithBaseUrl
           ? [
               {
-                name: `${chalk.blue("Publish to a new website")} - we'll help you set up a new website`,
+                name: `${chalk.blue("New website")} - ${chalk.yellow("Paid service.")} We'll help you set up a brand-new website with custom domain and hosting. Great if you want a professional presence.`,
                 value: "new-instance",
               },
             ]
@@ -113,7 +109,7 @@ export default async function publishDocs(
           paymentUrl = config?.paymentUrl;
           console.log(`\nResuming your previous website setup...`);
         } else {
-          console.log(`\nCreating a new doc website for your documentation...`);
+          console.log(`\nCreating new website for your documentation...`);
         }
         const { appUrl: homeUrl, token: ltToken } = (await deploy(id, paymentUrl)) || {};
 
@@ -127,6 +123,8 @@ export default async function publishDocs(
     }
   }
 
+  console.log(`\nPublishing docs to ${chalk.cyan(appUrl)}\n`);
+
   const accessToken = await getAccessToken(appUrl, token);
 
   process.env.DOC_ROOT_DIR = docsDir;
@@ -185,7 +183,7 @@ export default async function publishDocs(
   } catch (error) {
     message = `❌ Failed to publish docs: ${error.message}`;
   }
-  saveValueToConfig("checkoutId", "", "Checkout ID for document deployment service");
+  await saveValueToConfig("checkoutId", "", "Checkout ID for document deployment service");
 
   // clean up tmp work dir
   await fs.rm(docsDir, { recursive: true, force: true });
@@ -211,4 +209,4 @@ publishDocs.input_schema = {
   },
 };
 
-publishDocs.description = "Publish the documentation to Discuss Kit";
+publishDocs.description = "Publish the documentation to website";

package/agents/retranslate.yaml

@@ -1,6 +1,6 @@
 type: team
 name: translate
-description: Translate document content to selected languages
+description: Translate documents into other languages
 skills:
   - url: ./input-generator.mjs
     default_input:
@@ -42,24 +42,24 @@ skills:
       stage: translation_refine
   - url: ./action-success.mjs
     default_input:
-      action: "Document translated"
+      action: "✅ Translation completed"
 input_schema:
   type: object
   properties:
     glossary:
       type: string
-      description: Glossary of terms for consistent terminology, use @<file> to read from a file
+      description: Glossary file for consistent terminology (use @filename.md)
     docs:
       type: array
       items:
         type: string
-      description: Document paths to translate
+      description: Documents to translate
     langs:
       type: array
       items:
         type: string
-      description: "Languages to translate to, available languages are: en, zh, zh-TW, ja, fr, de, es, it, ru, ko, pt, ar"
+      description: "Target languages (available: en, zh, zh-TW, ja, fr, de, es, it, ru, ko, pt, ar)"
     feedback:
       type: string
-      description: Feedback for translation improvement
+      description: Tell us how to improve the translation style
 mode: sequential

package/agents/structure-planning.yaml

@@ -1,5 +1,5 @@
 name: structurePlanGenerator
-description: 通用结构规划生成器，支持网站、文档、书籍、演示文稿等多种场景
+description: Plan the structure and organization of your documentation
 instructions:
   url: ../prompts/structure-planning.md
 input_schema:
@@ -7,31 +7,31 @@ input_schema:
   properties:
     rules:
       type: string
-      description: 用户的结构规划的要求
+      description: Your specific requirements for documentation structure
     locale:
       type: string
-      description: 用户语言，如 zh、en
+      description: Primary language for documentation (e.g., zh, en, ja)
     datasources:
       type: string
-      description: 结构规划的上下文，用于辅助结构规划
+      description: Project content and context to help plan structure
     targetAudience:
       type: string
-      description: 结构规划的目标受众
+      description: Target audience for the documentation
     nodeName:
       type: string
-      description: 结构规划的节点名称
+      description: Specific section or page name to focus on
     glossary:
       type: string
-      description: 术语表
+      description: Glossary for consistent terminology
     feedback:
       type: string
-      description: 结构规划的反馈
+      description: Tell us how to improve the documentation structure
     userPreferences:
       type: string
-      description: 用户偏好规则，YAML格式的结构规划和全局范围偏好
+      description: Your saved preferences for structure and documentation style
     docsType:
       type: string
-      description: 文档类型，支持：general、getting-started、reference、faq
+      description: "Documentation type (options: general, getting-started, reference, faq)"
       default: general
   required:
     - rules
@@ -41,18 +41,18 @@ output_schema:
   properties:
     projectName:
       type: string
-      description: 根据 DataSources 分析项目名称，注意是原始项目名称
+      description: Project name identified from your content sources
     projectDesc:
       type: string
-      description: 根据 DataSources 分析生成当前项目描述，为原始项目生成描述，描述简洁，不超过 50 个单词
+      description: Brief project description generated from content analysis (under 50 words)
     structurePlan: ./schema/structure-plan.yaml
     structurePlanTree:
       type: string
       description: |
-        结构规划的树形结构，用于展示结构规划的层级关系，每一级有不同的缩进，方便用户直观查看结构规划的层级关系,参考格式：
+        Visual tree structure showing documentation hierarchy with indented levels for easy review:
         ```
-        - 首页
-          - 产品
-            - 产品详情
-              - 产品介绍
+        - Home
+          - Getting Started
+            - Installation
+              - Requirements
         ```

package/agents/team-publish-docs.yaml

@@ -3,7 +3,7 @@ name: publish
 alias:
   - pub
   - p
-description: Publish the documentation to Discuss Kit
+description: Publish your documentation online
 skills:
   - url: ./input-generator.mjs
     default_input:
@@ -15,4 +15,4 @@ input_schema:
   properties:
     appUrl:
       type: string
-      description: target website URL where the documentation will be published (optional - if not provided, will prompt for interactive input)
+      description: Website URL where docs will be published (optional - leave empty for interactive setup)

package/agents/translate.yaml

@@ -1,5 +1,5 @@
 name: translateDoc
-description: Translate the wiki article to another language
+description: Translate content to another language
 instructions:
   url: ../prompts/translator.md
 input_schema:
@@ -7,16 +7,16 @@ input_schema:
   properties:
     language:
       type: string
-      description: Language to translate the article into (e.g., 'zh_CN' for Chinese)
+      description: Target language (e.g., 'zh' for Chinese, 'ja' for Japanese)
     content:
       type: string
-      description: Content to translate
+      description: Text content to translate
     glossary:
       type: string
-      description: 术语表
+      description: Glossary for consistent terminology
     feedback:
       type: string
-      description: Feedback for translation improvement
+      description: Tell us how to improve the translation style
   required:
     - language
     - content
@@ -25,7 +25,7 @@ output_schema:
   properties:
     translation:
       type: string
-      description: Translation of the content
+      description: Translated text
     language:
       type: string
-      description: Language of the translation
+      description: Language code of the translation

package/docs/cli-reference.md

@@ -89,7 +89,7 @@ Analyzes your source code and generates a complete set of documentation based on
 
 | Option | Type | Description |
 |---|---|---|
-| `--feedback` | string | Provides feedback to adjust and refine the overall document structure plan. |
+| `--feedback` | string | Provides feedback to adjust and refine the overall documentation structure. |
 | `--forceRegenerate` | boolean | Discards existing content and regenerates all documentation from scratch. |
 | `--model` | string | Specifies a particular LLM to use for generation (e.g., `openai:gpt-4o`). Overrides the default model. |
 | `--glossary` | string | Path to a glossary file for consistent terminology. Use the format `@path/to/glossary.md`. |

package/docs/features-generate-documentation.md

@@ -90,7 +90,7 @@ While the default `generate` command is sufficient for most use cases, you can u
 | Option              | Description                                                                                                                              | Example                                                              |
 |---------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------|
 | `--forceRegenerate` | Deletes all existing documents and regenerates them from scratch. Use this after making significant changes to your source code or configuration. | `aigne doc generate --forceRegenerate`                                 |
-| `--feedback`        | Provides high-level feedback to refine the overall document structure plan, such as adding, removing, or reorganizing sections.           | `aigne doc generate --feedback "Add an API Reference section"`         |
+| `--feedback`        | Provides high-level feedback to refine the overall documentation structure, such as adding, removing, or reorganizing sections.           | `aigne doc generate --feedback "Add an API Reference section"`         |
 | `--model`           | Specifies a particular Large Language Model from AIGNE Hub to use for content generation, allowing you to switch between models.       | `aigne doc generate --model claude:claude-3-5-sonnet`                |
 
 ## What's Next?

package/docs/features-update-and-refine.md

@@ -123,12 +123,12 @@ Key parameters for the `update` command:
 
 ## Optimizing the Overall Structure
 
-Beyond refining the content of individual documents, you can also adjust the overall documentation structure. If a section is missing or the existing organization could be improved, you can provide feedback to the structure planning agent using the `generate` command with the `--feedback` flag.
+Beyond refining the content of individual documents, you can also adjust the overall documentation structure. If a section is missing or the existing organization could be improved, you can provide feedback to improve the documentation structure using the `generate` command with the `--feedback` flag.
 
 This command instructs DocSmith to reconsider the entire document plan based on your new input.
 
 ```bash
-# Regenerate the structure plan with specific feedback
+# Regenerate the documentation structure with specific feedback
 aigne doc generate --feedback "Remove the 'About' section and add a more detailed 'API Reference'."
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.8.5",
+  "version": "0.8.6",
   "description": "",
   "publishConfig": {
     "access": "public"

package/tests/deploy.test.mjs

@@ -0,0 +1,376 @@
+import { afterEach, beforeEach, describe, expect, mock, spyOn, test } from "bun:test";
+
+// Create mock functions for blocklet module only
+const mockGetComponentInfoWithMountPoint = mock();
+const mockGetComponentInfo = mock();
+
+// Mock only the blocklet module globally (it's safe as it's specific to this functionality)
+mock.module("../utils/blocklet.mjs", () => ({
+  getComponentInfoWithMountPoint: mockGetComponentInfoWithMountPoint,
+  getComponentInfo: mockGetComponentInfo,
+}));
+
+// Mock the open module to prevent opening browser during tests
+const mockOpenDefault = mock(() => Promise.resolve());
+mock.module("open", () => ({
+  default: mockOpenDefault,
+}));
+
+// Import the real utils module and deploy function
+import { deploy } from "../utils/deploy.mjs";
+import * as utils from "../utils/utils.mjs";
+
+describe("deploy function", () => {
+  let originalFetch;
+  let originalConsole;
+  let consoleOutput;
+  let saveValueToConfigSpy;
+  let originalSetTimeout;
+
+  beforeEach(async () => {
+    // Reset environment
+    process.env.DOC_SMITH_BASE_URL = "https://test.example.com";
+    process.env.NODE_ENV = "test";
+
+    // Mock console to capture output
+    consoleOutput = [];
+    originalConsole = {
+      log: console.log,
+      error: console.error,
+    };
+    console.log = (...args) => consoleOutput.push({ type: "log", args });
+    console.error = (...args) => consoleOutput.push({ type: "error", args });
+
+    // Mock setTimeout to make tests run instantly
+    originalSetTimeout = global.setTimeout;
+    global.setTimeout = (callback, _delay) => {
+      // Call immediately in tests
+      return originalSetTimeout(callback, 0);
+    };
+
+    // Mock fetch
+    originalFetch = global.fetch;
+
+    // Use spyOn to mock saveValueToConfig without affecting other tests
+    saveValueToConfigSpy = spyOn(utils, "saveValueToConfig").mockResolvedValue();
+
+    // Reset blocklet mocks
+    mockGetComponentInfoWithMountPoint.mockReset();
+    mockGetComponentInfo.mockReset();
+
+    // Set default mock implementations
+    mockGetComponentInfoWithMountPoint.mockResolvedValue({
+      mountPoint: "/payment",
+      PAYMENT_LINK_ID: "test-payment-id",
+    });
+
+    mockGetComponentInfo.mockResolvedValue({
+      status: "running",
+    });
+  });
+
+  afterEach(() => {
+    // Restore originals
+    global.fetch = originalFetch;
+    global.setTimeout = originalSetTimeout;
+    console.log = originalConsole.log;
+    console.error = originalConsole.error;
+
+    // Restore spies
+    if (saveValueToConfigSpy) {
+      saveValueToConfigSpy.mockRestore();
+    }
+
+    // Reset open mock
+    mockOpenDefault.mockReset();
+
+    // Reset environment
+    delete process.env.NODE_ENV;
+  });
+
+  test("successful deployment flow", async () => {
+    // Mock API responses for the complete flow
+    let callCount = 0;
+    global.fetch = mock(async (url) => {
+      callCount++;
+
+      // Step 1: Create payment session
+      if (url.includes("/api/checkout-sessions/start")) {
+        return {
+          ok: true,
+          status: 200,
+          json: async () => ({
+            checkoutSession: { id: "checkout-123" },
+            paymentUrl: "https://payment.test/checkout-123",
+          }),
+        };
+      }
+
+      // Step 2-4: Poll payment/installation/service status
+      if (url.includes("/api/vendors/order/checkout-123/status")) {
+        if (callCount <= 2) {
+          // First call: payment completed, installation in progress
+          return {
+            ok: true,
+            status: 200,
+            json: async () => ({
+              payment_status: "paid",
+              vendors: [{ id: "vendor-1", progress: 50, appUrl: null }],
+            }),
+          };
+        } else {
+          // Subsequent calls: installation complete
+          return {
+            ok: true,
+            status: 200,
+            json: async () => ({
+              payment_status: "paid",
+              vendors: [{ id: "vendor-1", progress: 100, appUrl: "https://app.test" }],
+            }),
+          };
+        }
+      }
+
+      // Step 5: Get order details
+      if (url.includes("/api/vendors/order/checkout-123/detail")) {
+        return {
+          ok: true,
+          status: 200,
+          json: async () => ({
+            vendors: [
+              {
+                appUrl: "https://app.test",
+                dashboardUrl: "https://dashboard.test",
+                homeUrl: "https://home.test",
+                token: "auth-token-123",
+              },
+            ],
+          }),
+        };
+      }
+
+      throw new Error(`Unexpected URL: ${url}`);
+    });
+
+    const result = await deploy();
+
+    // Verify result
+    expect(result).toEqual({
+      appUrl: "https://app.test",
+      homeUrl: "https://home.test",
+      token: "auth-token-123",
+    });
+
+    // Verify saveValueToConfig was called
+    expect(saveValueToConfigSpy).toHaveBeenCalledWith(
+      "checkoutId",
+      "checkout-123",
+      "Checkout ID for document deployment service",
+    );
+    expect(saveValueToConfigSpy).toHaveBeenCalledWith(
+      "paymentUrl",
+      expect.stringContaining("payment"),
+      "Payment URL for document deployment service",
+    );
+
+    // Verify console output shows progress
+    const logs = consoleOutput.filter((o) => o.type === "log").map((o) => o.args.join(" "));
+    expect(logs.some((log) => log.includes("Step 1/4: Waiting for payment"))).toBe(true);
+    expect(logs.some((log) => log.includes("Step 2/4: Installing service"))).toBe(true);
+    expect(logs.some((log) => log.includes("Step 3/4: Starting service"))).toBe(true);
+    expect(logs.some((log) => log.includes("Step 4/4: Getting service URL"))).toBe(true);
+    expect(logs.some((log) => log.includes("Your website is available at"))).toBe(true);
+  });
+
+  test("handles missing payment link ID", async () => {
+    mockGetComponentInfoWithMountPoint.mockResolvedValue({
+      mountPoint: "/payment",
+      PAYMENT_LINK_ID: null,
+    });
+
+    await expect(deploy()).rejects.toThrow("Payment link ID not found");
+  });
+
+  test("handles payment session creation failure", async () => {
+    global.fetch = mock(async (url) => {
+      if (url.includes("/api/checkout-sessions/start")) {
+        return {
+          ok: false,
+          status: 400,
+          json: async () => ({ error: "Payment creation failed" }),
+        };
+      }
+    });
+
+    await expect(deploy()).rejects.toThrow("Failed to create payment session");
+
+    const errors = consoleOutput.filter((o) => o.type === "error");
+    expect(errors.length).toBeGreaterThan(0);
+  });
+
+  test("handles network errors gracefully", async () => {
+    global.fetch = mock(async () => {
+      throw new Error("Network connection failed");
+    });
+
+    await expect(deploy()).rejects.toThrow("Failed to create payment session");
+  });
+
+  test("handles browser opening failure gracefully", async () => {
+    // Mock successful API flow
+    global.fetch = mock(async (url) => {
+      if (url.includes("/api/checkout-sessions/start")) {
+        return {
+          ok: true,
+          status: 200,
+          json: async () => ({
+            checkoutSession: { id: "checkout-123" },
+            paymentUrl: "https://payment.test/checkout-123",
+          }),
+        };
+      }
+
+      if (url.includes("/status")) {
+        return {
+          ok: true,
+          status: 200,
+          json: async () => ({
+            payment_status: "paid",
+            vendors: [{ id: "vendor-1", progress: 100, appUrl: "https://app.test" }],
+          }),
+        };
+      }
+
+      if (url.includes("/detail")) {
+        return {
+          ok: true,
+          status: 200,
+          json: async () => ({
+            vendors: [
+              {
+                appUrl: "https://app.test",
+                homeUrl: "https://home.test",
+                token: "auth-token-123",
+              },
+            ],
+          }),
+        };
+      }
+    });
+
+    // Mock open to fail
+    mockOpenDefault.mockRejectedValue(new Error("Cannot open browser"));
+
+    // Call deploy without cached parameters - should still succeed
+    const result = await deploy();
+
+    // Should still complete successfully despite browser opening failure
+    expect(result.appUrl).toBe("https://app.test");
+    expect(result.homeUrl).toBe("https://home.test");
+    expect(result.token).toBe("auth-token-123");
+  });
+
+  test("handles cached checkout ID", async () => {
+    // Mock successful status check for cached ID
+    global.fetch = mock(async (url) => {
+      if (url.includes("/status")) {
+        return {
+          ok: true,
+          status: 200,
+          json: async () => ({
+            payment_status: "paid",
+            vendors: [{ id: "vendor-1", progress: 100, appUrl: "https://app.test" }],
+          }),
+        };
+      }
+
+      if (url.includes("/detail")) {
+        return {
+          ok: true,
+          status: 200,
+          json: async () => ({
+            vendors: [
+              {
+                appUrl: "https://app.test",
+                homeUrl: "https://home.test",
+                token: "auth-token-123",
+              },
+            ],
+          }),
+        };
+      }
+    });
+
+    const result = await deploy("existing-checkout-id", "https://cached-payment.url");
+
+    expect(result.appUrl).toBe("https://app.test");
+
+    // Should not call open since using cached checkout
+    expect(mockOpenDefault).not.toHaveBeenCalled();
+  });
+
+  test("clears checkout ID when cache check fails", async () => {
+    // Mock successful responses for the complete flow after cache check fails
+    let callCount = 0;
+    global.fetch = mock(async (url) => {
+      callCount++;
+
+      // First call: cache check fails
+      if (callCount === 1 && url.includes("/status")) {
+        throw new Error("Network error during cache check");
+      }
+
+      // Create payment session
+      if (url.includes("/api/checkout-sessions/start")) {
+        return {
+          ok: true,
+          status: 200,
+          json: async () => ({
+            checkoutSession: { id: "new-checkout-123" },
+            paymentUrl: "https://payment.test/new-checkout-123",
+          }),
+        };
+      }
+
+      // Subsequent status checks and detail calls
+      if (url.includes("/status")) {
+        return {
+          ok: true,
+          status: 200,
+          json: async () => ({
+            payment_status: "paid",
+            vendors: [{ id: "vendor-1", progress: 100, appUrl: "https://app.test" }],
+          }),
+        };
+      }
+
+      if (url.includes("/detail")) {
+        return {
+          ok: true,
+          status: 200,
+          json: async () => ({
+            vendors: [
+              {
+                appUrl: "https://app.test",
+                homeUrl: "https://home.test",
+                token: "auth-token-123",
+              },
+            ],
+          }),
+        };
+      }
+    });
+
+    // Call deploy with invalid cached checkout ID - should clear it and create new one
+    const result = await deploy("invalid-checkout-id");
+
+    expect(result.appUrl).toBe("https://app.test");
+
+    // Verify that checkoutId was cleared due to cache check failure
+    expect(saveValueToConfigSpy).toHaveBeenCalledWith(
+      "checkoutId",
+      "",
+      "Checkout ID for document deployment service",
+    );
+  });
+});

package/tests/input-generator.test.mjs

@@ -1307,7 +1307,9 @@ describe("init", () => {
             if (options.message.includes("[1/8]") && options.validate) {
               // Test the validation function directly
               const validationResult = options.validate([]);
-              expect(validationResult).toBe("Please select at least one purpose.");
+              expect(validationResult).toBe(
+                "Please choose at least one goal for your documentation.",
+              );
               validateCalled = true;
               // Return valid result after testing validation
               return Promise.resolve(["getStarted"]);
@@ -1346,7 +1348,7 @@ describe("init", () => {
             if (options.message.includes("[2/8]") && options.validate) {
               // Test the validation function for target audience
               const validationResult = options.validate([]);
-              expect(validationResult).toBe("Please select at least one audience.");
+              expect(validationResult).toBe("Please choose at least one audience.");
               audienceValidateCalled = true;
               return Promise.resolve(["developers"]); // Valid result after testing
             }
@@ -1385,11 +1387,11 @@ describe("init", () => {
             if (options.message.includes("Which is most important?") && options.validate) {
               // Test validation for empty selection
               let validationResult = options.validate([]);
-              expect(validationResult).toBe("Please select at least one priority.");
+              expect(validationResult).toBe("Please choose at least one priority.");
 
               // Test validation for too many selections
               validationResult = options.validate(["getStarted", "completeTasks", "findAnswers"]);
-              expect(validationResult).toBe("Please select maximum 2 priorities.");
+              expect(validationResult).toBe("Please choose maximum 2 priorities.");
 
               // Test validation for valid selection
               validationResult = options.validate(["getStarted", "completeTasks"]);

package/utils/auth-utils.mjs

@@ -88,7 +88,7 @@ export async function getAccessToken(appUrl, ltToken = "") {
     const result = await createConnect({
       connectUrl: connectUrl,
       connectAction: "gen-simple-access-key",
-      source: `AIGNE DocSmith connect to Discuss Kit`,
+      source: `AIGNE DocSmith connect to website`,
       closeOnSuccess: true,
       appName: "AIGNE DocSmith",
       appLogo: "https://docsmith.aigne.io/image-bin/uploads/a7910a71364ee15a27e86f869ad59009.svg",

package/utils/deploy.mjs

@@ -116,8 +116,8 @@ export async function deploy(id, cachedUrl) {
   console.log(`${chalk.blue("⏳")} Step 1/4: Waiting for payment...`);
   console.log(`${chalk.blue("🔗")} Payment link: ${chalk.cyan(paymentUrl)}\n`);
   await pollPaymentStatus(checkoutId);
-  saveValueToConfig("checkoutId", checkoutId, "Checkout ID for document deployment service");
-  saveValueToConfig("paymentUrl", paymentUrl, "Payment URL for document deployment service");
+  await saveValueToConfig("checkoutId", checkoutId, "Checkout ID for document deployment service");
+  await saveValueToConfig("paymentUrl", paymentUrl, "Payment URL for document deployment service");
 
   // Step 3: Wait for service installation
   console.log(`${chalk.blue("📦")} Step 2/4: Installing service...`);
@@ -174,7 +174,7 @@ async function checkCacheCheckoutId(checkoutId) {
 
     return isPaid ? checkoutId : "";
   } catch (_error) {
-    saveValueToConfig("checkoutId", "", "Checkout ID for document deployment service");
+    await saveValueToConfig("checkoutId", "", "Checkout ID for document deployment service");
     return "";
   }
 }