@aigne/doc-smith 0.8.12 → 0.8.13

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [0.8.13](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.13-beta...v0.8.13) (2025-10-16)
+
+
+### Miscellaneous Chores
+
+* release 0.8.13 ([496e30f](https://github.com/AIGNE-io/aigne-doc-smith/commit/496e30f60d7e78602ffdc0fc070bf09ce4415fde))
+
+## [0.8.13-beta](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.12...v0.8.13-beta) (2025-10-16)
+
+
+### Bug Fixes
+
+* add check before evaluate/publish/translate/update ([#196](https://github.com/AIGNE-io/aigne-doc-smith/issues/196)) ([3d6f40b](https://github.com/AIGNE-io/aigne-doc-smith/commit/3d6f40b77f1a50b95625db3fb561c44b940d04bd))
+* **assets:** reslove missing upload of local assets causing broken images in production ([#197](https://github.com/AIGNE-io/aigne-doc-smith/issues/197)) ([423cdc1](https://github.com/AIGNE-io/aigne-doc-smith/commit/423cdc1d7b2179f80e03c520a51ecfa65aff79de))
+* **ux:** optimize visible copy for improved user interaction ([#192](https://github.com/AIGNE-io/aigne-doc-smith/issues/192)) ([603e5d8](https://github.com/AIGNE-io/aigne-doc-smith/commit/603e5d8a5f94134452973972b32d48d0c09c5c5f))
+
 ## [0.8.12](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.12-beta.9...v0.8.12) (2025-10-16)
 
 ## [0.8.12-beta.9](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.8.12-beta.8...v0.8.12-beta.9) (2025-10-15)

package/README.md

@@ -7,21 +7,21 @@
 
 # AIGNE DocSmith
 
-> 🚀 **AI-powered documentation generation that understands your code**
+> 🚀 **AI-powered documentation that understands your code**
 
-AIGNE DocSmith is a powerful, AI-driven documentation generation tool built on the [AIGNE Framework](https://www.aigne.io/en/framework). It automatically analyzes your codebase and generates comprehensive, structured, and multi-language documentation that stays in sync with your code.
+AIGNE DocSmith is a powerful, AI-driven documentation tool built on the [AIGNE Framework](https://www.aigne.io/en/framework). It automatically analyzes your codebase to generate comprehensive, structured, and multi-language documentation that stays in sync with your code.
 
 ## 🎯 Why DocSmith?
 
-- **🧠 Intelligent Analysis**: Understands your code structure, patterns, and intent
-- **📚 Comprehensive Coverage**: Generates complete documentation from API references to user guides
-- **🌍 Global Ready**: Supports 12 languages with professional translation
-- **🔄 Always Current**: Automatically detects changes and updates documentation
-- **⚡ Zero Config**: Works out of the box with smart defaults and auto-detection
+- **🧠 Intelligent Analysis**: Understands your code's structure, patterns, and intent.
+- **📚 Comprehensive Coverage**: Generates everything from API references to user guides.
+- **🌍 Global Ready**: Supports 12 languages with professional-grade translation.
+- **🔄 Always Current**: Automatically detects changes and updates documentation accordingly.
+- **⚡ Zero Config**: Works out of the box with smart defaults and auto-detection.
 
 ## AIGNE Ecosystem
 
-DocSmith is part of the [AIGNE](https://www.aigne.io) ecosystem, a comprehensive AI application development platform. Here's the architecture overview:
+DocSmith is part of the [AIGNE](https://www.aigne.io) ecosystem, a comprehensive AI application development platform.
 
 ![AIGNE Ecosystem Architecture](https://docsmith.aigne.io/image-bin/uploads/def424c20bbdb3c77483894fe0e22819.png)
 
@@ -31,35 +31,34 @@ As shown in the diagram, DocSmith integrates seamlessly with other [AIGNE](https
 
 ### 🤖 AI-Powered Generation
 
-- **Smart Structure Planning**: Automatically analyzes your codebase to create logical, comprehensive documentation structure
-- **Intelligent Content Creation**: Generates detailed, contextual content that explains both "what" and "why"
-- **Adaptive Writing Styles**: Supports multiple documentation styles (Technical, User-Friendly, Developer-Focused, etc.)
+- **Smart Structure Planning**: Analyzes your codebase to create a logical and comprehensive documentation structure.
+- **Intelligent Content Creation**: Generates detailed, contextual content that explains both the "what" and the "why."
+- **Adaptive Writing Styles**: Supports multiple documentation styles, including Technical, User-Friendly, and Developer-Focused.
 
-### 🌍 Multi-Language Excellence
+### 🌍 Multi-Language Support
 
-- **12 Language Support**: English, Chinese (Simplified & Traditional), Japanese, Korean, Spanish, French, German, Portuguese, Russian, Italian, and Arabic
-- **Professional Translation**: Context-aware translation that maintains technical accuracy
-- **Glossary Integration**: Consistent terminology across all languages
+- **12 Language Support**: English, Chinese (Simplified & Traditional), Japanese, Korean, Spanish, French, German, Portuguese, Russian, Italian, and Arabic.
+- **Professional Translation**: Provides context-aware translations that maintain technical accuracy.
+- **Glossary Integration**: Ensures consistent terminology across all languages.
 
 ### 🔗 Seamless Integration
 
-- **AIGNE Hub Integration**: Use [AIGNE Hub](https://www.aigne.io/en/hub) without API keys, switch between Google Gemini, OpenAI GPT, Claude, and more
-- **Multiple LLM Support**: Bring your own API keys for OpenAI, Anthropic, Google, and other providers
-- **One-Click Publishing**: Make your docs live and generate shareable links for your team - publish to [docsmith.aigne.io](https://docsmith.aigne.io/app/) or your own [Discuss Kit](https://www.web3kit.rocks/discuss-kit) instance
+- **AIGNE Hub Integration**: Use the [AIGNE Hub](https://www.aigne.io/en/hub) without API keys and switch between Google Gemini, OpenAI GPT, Claude, and more.
+- **Multiple LLM Support**: Bring your own API keys for OpenAI, Anthropic, Google, and other providers.
+- **One-Click Publishing**: Publish your docs and generate shareable links for your team. Publish to [docsmith.aigne.io](https://docsmith.aigne.io/app/) or your own [Discuss Kit](https://www.web3kit.rocks/discuss-kit) instance.
 
 ### 🔄 Smart Updates
 
-- **Change Detection**: Automatically identifies code changes and updates relevant documentation
-- **Targeted Regeneration**: Update specific sections with custom feedback and requirements
-- **Version Awareness**: Maintains documentation history and tracks changes over time
+- **Change Detection**: Automatically identifies code changes and updates the relevant documentation.
+- **Targeted Regeneration**: Updates specific sections with custom feedback and requirements.
+- **Version Awareness**: Maintains a history of your documentation and tracks changes over time.
 
 ## 🚀 Quick Start
 
 ### Prerequisites
 
 - Node.js 20+ and npm/pnpm
-- No API keys required (uses AIGNE Hub by default)
-
+- No API keys required (uses the AIGNE Hub by default).
 
 ### 📦 Installation
 
@@ -80,17 +79,17 @@ aigne doc --help
 Navigate to your project directory and run:
 
 ```bash
-# One command to rule them all
+# One command to generate your documentation
 aigne doc generate
 ```
 
 DocSmith will:
 
-1. 🔍 Auto-detect your project structure and tech stack
-2. 🎯 Guide you through an interactive setup (first time only)
-3. 📝 Generate comprehensive documentation
-4. 🌍 Optionally translate to multiple languages
-5. 🚀 Publish to your preferred platform
+1. 🔍 Auto-detect your project's structure and tech stack.
+2. 🎯 Guide you through an interactive setup (first time only).
+3. 📝 Generate comprehensive documentation.
+4. 🌍 Optionally translate it into multiple languages.
+5. 🚀 Publish it to your preferred platform.
 
 ## 🔧 Advanced Configuration
 
@@ -100,9 +99,9 @@ DocSmith supports multiple AI providers:
 
 **🎯 AIGNE Hub (Recommended)**
 
-- ✅ No API keys required
-- ✅ Easy model switching
-- ✅ Built-in rate limiting and optimization
+- ✅ No API keys required.
+- ✅ Easy model switching.
+- ✅ Built-in rate limiting and optimization.
 
 ```bash
 # Switch models effortlessly
@@ -117,7 +116,7 @@ Configure your own API keys for direct provider access:
 - OpenAI GPT models
 - Anthropic Claude models
 - Google Gemini models
-- And more...
+- and more...
 
 ## 📖 Usage Guide
 
@@ -129,7 +128,7 @@ Configure your own API keys for direct provider access:
 # Smart generation with auto-configuration
 aigne doc generate
 
-# Force complete regeneration
+# Force a complete regeneration of the documentation
 aigne doc generate --forceRegenerate
 
 # Generate with custom feedback
@@ -139,7 +138,7 @@ aigne doc generate --feedback "Add more API examples and troubleshooting section
 #### 🔄 Update Existing Documents
 
 ```bash
-# Interactive document selection and update
+# Interactively select and update a document
 aigne doc update
 
 # Update specific document with feedback
@@ -152,10 +151,10 @@ aigne doc update --docs overview.md --feedback "Add comprehensive FAQ section"
 # Interactive translation with smart language selection
 aigne doc translate
 
-# Translate specific documents to multiple languages
+# Translate specific documents into multiple languages
 aigne doc translate --langs zh --langs ja --docs examples.md --docs overview.md
 
-# Translation with custom glossary for consistent terminology
+# Translate with a custom glossary for consistent terminology
 aigne doc translate --glossary @path/to/glossary.md --feedback "Use technical terminology consistently"
 ```
 
@@ -165,7 +164,7 @@ aigne doc translate --glossary @path/to/glossary.md --feedback "Use technical te
 # Interactive publishing with platform selection
 aigne doc publish
 
-# Publish to custom Discuss Kit instance
+# Publish to a custom Discuss Kit instance
 aigne doc publish --appUrl https://your-discuss-kit-instance.com
 ```
 
@@ -175,23 +174,23 @@ aigne doc publish --appUrl https://your-discuss-kit-instance.com
 # Interactive configuration setup
 aigne doc init
 
-# View current configuration
+# View the current configuration
 aigne doc prefs
 ```
 
 ### Configuration Options
 
-DocSmith automatically detects your project structure, but you can customize:
+DocSmith automatically detects your project's structure, but you can customize it to your needs:
 
 - **📝 Documentation Styles**: Technical, User-Friendly, Developer-Focused, Academic
 - **🎯 Target Audiences**: Developers, End Users, System Administrators, Business Users
-- **🌍 Languages**: Choose from 12 supported languages
-- **📁 Source Paths**: Customize which files and directories to analyze
-- **📤 Output Settings**: Configure documentation structure and formatting
+- **🌍 Languages**: Choose from 12 supported languages.
+- **📁 Source Paths**: Customize which files and directories to analyze.
+- **📤 Output Settings**: Configure the documentation structure and formatting.
 
 ## 🌐 Supported Languages
 
-DocSmith provides professional translation for 12 languages:
+DocSmith provides professional-grade translations for 12 languages:
 
 | Language  | Code    | Support Level |
 | --------- | ------- | ------------- |
@@ -214,15 +213,15 @@ We welcome contributions from the community! Here's how you can help:
 
 ### 🐛 Reporting Issues
 
-- 🔍 [Search existing issues](https://github.com/AIGNE-io/aigne-doc-smith/issues) first
-- 📝 Use our issue templates for bug reports and feature requests
-- 🚨 Include clear reproduction steps and environment details
+- 🔍 [Search existing issues](https://github.com/AIGNE-io/aigne-doc-smith/issues) first.
+- 📝 Use our issue templates for bug reports and feature requests.
+- 🚨 Include clear reproduction steps and details about your environment.
 
 ### 💡 Feature Requests
 
-- 🌟 Share your ideas in [GitHub Discussions](https://github.com/AIGNE-io/aigne-doc-smith/discussions)
-- 📋 Check our [roadmap](https://github.com/AIGNE-io/aigne-doc-smith/projects) for planned features
-- 🗳️ Vote on existing feature requests
+- 🌟 Share your ideas in [GitHub Discussions](https://github.com/AIGNE-io/aigne-doc-smith/discussions).
+- 📋 Check our [roadmap](https://github.com/AIGNE-io/aigne-doc-smith/projects) for planned features.
+- 🗳️ Vote on existing feature requests.
 
 ### 🔧 Development Setup
 
@@ -237,38 +236,38 @@ pnpm install
 # Run tests
 pnpm test
 
-# Run linting
+# Run the linter
 pnpm run lint
 
-# Auto fix lint error
+# Automatically fix lint errors
 pnpm run lint:fix
 ```
 
 ### 📜 Code of Conduct
 
-Please follow our community guidelines and maintain respectful, constructive communication when contributing.
+Please follow our community guidelines and maintain respectful, constructive communication.
 
 ## 💼 Enterprise & Production Use
 
 ### 🏢 Enterprise Features
 
-- **Team Collaboration**: Multi-user workflows with role-based access
-- **Custom Branding**: White-label documentation with your brand identity
-- **API Integration**: REST APIs for automated documentation pipelines
-- **Analytics**: Track documentation usage and effectiveness
+- **Team Collaboration**: Multi-user workflows with role-based access.
+- **Custom Branding**: White-label your documentation with your brand's identity.
+- **API Integration**: Use REST APIs for automated documentation pipelines.
+- **Analytics**: Track documentation usage and effectiveness.
 
 ### 🔒 Security & Compliance
 
-- **Private Cloud**: Deploy on your own infrastructure
-- **SSO Integration**: Connect with your identity providers
-- **Audit Logs**: Complete activity tracking and compliance reporting
-- **Data Privacy**: Your code never leaves your environment in private deployments
+- **Private Cloud**: Deploy on your own infrastructure.
+- **SSO Integration**: Connect with your existing identity providers.
+- **Audit Logs**: Complete activity tracking and compliance reporting.
+- **Data Privacy**: Your code never leaves your environment in private deployments.
 
 ### 📞 Support & Services
 
-- **Priority Support**: Direct access to our engineering team
-- **Custom Training**: Team onboarding and best practices workshops
-- **Professional Services**: Custom integrations and deployment assistance
+- **Priority Support**: Get direct access to our engineering team.
+- **Custom Training**: We offer team onboarding and best practices workshops.
+- **Professional Services**: We provide custom integrations and deployment assistance.
 
 [Contact us](https://www.aigne.io/contact) for enterprise licensing and deployment options.
 
@@ -280,25 +279,25 @@ Please follow our community guidelines and maintain respectful, constructive com
 
 ### 💬 Community Support
 
-- 🐦 [Twitter](https://twitter.com/arcblock_io) - Updates and announcements
-- 🎮 [Community](https://community.arcblock.io/discussions/boards/aigne) - Real-time community chat
+- 🐦 [Twitter](https://twitter.com/arcblock_io) - For updates and announcements.
+- 🎮 [Community](https://community.arcblock.io/discussions/boards/aigne) - For real-time community chat.
 
 ### 🏆 Showcase
 
-See DocSmith in action with real-world examples:
+See DocSmith in action with these real-world examples:
 
-- [Docs Repository](https://docsmith.aigne.io/app) - Generated with DocSmith
+- [Docs Repository](https://docsmith.aigne.io/app) - Generated with DocSmith.
 
 ## 📄 License
 
-This project is licensed under the **Elastic License 2.0** - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the **Elastic License 2.0**. See the [LICENSE](LICENSE) file for details.
 
 ### What does this mean?
 
-- ✅ **Free for most use cases**: Personal projects, internal use, and most commercial applications
-- ✅ **Open source**: Full source code available for review and contributions
-- ✅ **Commercial friendly**: Use in your business applications and services
-- ❌ **Restrictions**: Cannot offer DocSmith as a competing hosted service
+- ✅ **Free for most use cases**: Including personal projects, internal use, and most commercial applications.
+- ✅ **Open source**: The full source code is available for review and contributions.
+- ✅ **Commercial friendly**: Use it in your business applications and services.
+- ❌ **Restrictions**: You cannot offer DocSmith as a competing hosted service.
 
-[Learn more about Elastic License 2.0](https://www.elastic.co/licensing/elastic-license)
+[Learn more about the Elastic License 2.0](https://www.elastic.co/licensing/elastic-license)
 

package/agents/clear/choose-contents.mjs

@@ -8,45 +8,45 @@ import {
 
 const TARGET_METADATA = {
   generatedDocs: {
-    label: "generated documents",
+    label: "Generated Documents",
     description: ({ docsDir }) =>
-      `Delete all generated documents in './${toDisplayPath(docsDir)}' (documentation structure stays).`,
+      `Delete all generated documents in './${toDisplayPath(docsDir)}'. The documentation structure will be preserved.`,
     agent: "clearGeneratedDocs",
   },
   documentStructure: {
-    label: "documentation structure",
+    label: "Documentation Structure",
     description: ({ docsDir, workDir }) =>
-      `Delete all generated documents in './${toDisplayPath(docsDir)}' and the documentation structure './${toDisplayPath(
+      `Delete all generated documents in './${toDisplayPath(docsDir)}' and the documentation structure in './${toDisplayPath(
         getStructurePlanPath(workDir),
-      )}' .`,
+      )}'.`,
     agent: "clearDocumentStructure",
   },
   documentConfig: {
-    label: "document configuration",
+    label: "Document Configuration",
     description: ({ workDir }) =>
-      `Delete the configuration file './${toDisplayPath(
+      `Delete the configuration file in './${toDisplayPath(
         getConfigFilePath(workDir),
-      )}' (requires 'aigne doc init' to regenerate).`,
+      )}'. You will need to run \`aigne doc init\` to regenerate it.`,
     agent: "clearDocumentConfig",
   },
   authTokens: {
-    label: "authorizations",
+    label: "Authorizations",
     description: () =>
-      `Delete authorization information in '${getDocSmithEnvFilePath()}' (requires re-authorization after clearing).`,
+      `Delete authorization information in '${getDocSmithEnvFilePath()}'. You will need to re-authorize after clearing.`,
     agent: "clearAuthTokens",
   },
   deploymentConfig: {
-    label: "deployment config",
+    label: "Deployment Config",
     description: ({ workDir }) =>
-      `Delete appUrl from './${toDisplayPath(getConfigFilePath(workDir))}'.`,
+      `Delete the appUrl from './${toDisplayPath(getConfigFilePath(workDir))}'.`,
     agent: "clearDeploymentConfig",
   },
   mediaDescription: {
-    label: "media file descriptions",
+    label: "Media File Descriptions",
     description: () =>
       `Delete AI-generated descriptions in './${toDisplayPath(
         getMediaDescriptionCachePath(),
-      )}' (will regenerate on next generation).`,
+      )}'. They will be regenerated on the next run.`,
     agent: "clearMediaDescription",
   },
 };
@@ -80,12 +80,11 @@ export default async function chooseContents(input = {}, options = {}) {
       }));
 
       selectedTargets = await options.prompts.checkbox({
-        message: "Select items to clear:",
+        message: "Please select the items you'd like to clear:",
         choices,
-        validate: (answer) => (answer.length > 0 ? true : "Please select at least one item."),
+        validate: (answer) => (answer.length > 0 ? true : "You must select at least one item."),
       });
     } else {
-      // If no prompts available, show available options
       return {
         message: `Available options to clear: ${TARGET_KEYS.join(", ")}`,
         availableTargets: TARGET_KEYS,
@@ -95,7 +94,7 @@ export default async function chooseContents(input = {}, options = {}) {
 
   if (selectedTargets.length === 0) {
     return {
-      message: "No items selected to clear.",
+      message: "You haven't selected any items to clear.",
     };
   }
 
@@ -103,7 +102,6 @@ export default async function chooseContents(input = {}, options = {}) {
   let hasError = false;
   let configCleared = false;
 
-  // Process each target using its dedicated agent
   for (const target of selectedTargets) {
     const metadata = TARGET_METADATA[target];
     if (!metadata) {
@@ -116,10 +114,9 @@ export default async function chooseContents(input = {}, options = {}) {
     }
 
     try {
-      // Get and invoke the specific agent using context
       const clearAgent = options.context?.agents?.[metadata.agent];
       if (!clearAgent) {
-        throw new Error(`Clear agent '${metadata.agent}' not found in context`);
+        throw new Error(`The clear agent '${metadata.agent}' was not found.`);
       }
 
       const result = await options.context.invoke(clearAgent, rest);
@@ -139,7 +136,6 @@ export default async function chooseContents(input = {}, options = {}) {
           suggestions: result.suggestions,
         });
 
-        // Track if document config was cleared
         if (target === "documentConfig" && result.cleared) {
           configCleared = true;
         }
@@ -153,13 +149,11 @@ export default async function chooseContents(input = {}, options = {}) {
     }
   }
 
-  // Prepare response message
   const header = hasError
     ? "Cleanup finished with some issues."
     : "Cleanup completed successfully!";
   const detailLines = results.map((item) => `- ${item.message}`).join("\n");
 
-  // Collect suggestions
   const suggestions = [];
   results.forEach((result) => {
     if (result.suggestions) {
@@ -167,7 +161,6 @@ export default async function chooseContents(input = {}, options = {}) {
     }
   });
 
-  // Add default suggestion if config was cleared
   if (configCleared && !suggestions.some((s) => s.includes("aigne doc init"))) {
     suggestions.push("Run `aigne doc init` to generate a fresh configuration file.");
   }
@@ -186,7 +179,7 @@ chooseContents.input_schema = {
   properties: {
     targets: {
       type: "array",
-      description: "Items to clear without confirmation",
+      description: "A list of items to clear without confirmation.",
       items: {
         type: "string",
         enum: TARGET_KEYS,
@@ -195,6 +188,6 @@ chooseContents.input_schema = {
   },
 };
 
-chooseContents.taskTitle = "Choose contents to clear";
+chooseContents.taskTitle = "Select and clear project contents";
 chooseContents.description =
-  "Choose contents to clear and execute the appropriate clearing operations";
+  "Select and clear project contents, such as generated documents, configuration, and authorization tokens.";

package/agents/evaluate/index.yaml

@@ -6,6 +6,7 @@ skills:
     default_input:
       skipIfExists: true
       checkOnly: true
+  - url: ../init/check.mjs
   - ../utils/load-sources.mjs
   - ../utils/format-document-structure.mjs
   - type: transform

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

@@ -9,7 +9,7 @@ export default async function checkNeedGenerateStructure(
   // Check if originalDocumentStructure is empty and prompt user
   if (!originalDocumentStructure) {
     const choice = await options.prompts.select({
-      message: "Project configured successfully. Generate the documentation structure now?",
+      message: "Project configured. Generate documentation structure now?",
       choices: [
         {
           name: "Yes, generate now",
@@ -24,9 +24,7 @@ export default async function checkNeedGenerateStructure(
 
     if (choice === "later") {
       console.log(`\nConfiguration file: ${chalk.cyan("./.aigne/doc-smith/config.yaml")}`);
-      console.log(
-        "Review and edit your configuration as needed, then run 'aigne doc generate' to continue.",
-      );
+      console.log("Review and edit your configuration, then run `aigne doc generate` to continue.");
 
       // In test environment, return a special result instead of exiting
       if (process.env.NODE_ENV === "test") {
@@ -40,39 +38,33 @@ export default async function checkNeedGenerateStructure(
     }
   }
 
-  // Check if we need to regenerate documentation structure
   let finalFeedback = "";
 
-  // user requested regeneration
+  // User requested regeneration
   if (forceRegenerate) {
     finalFeedback = `
     User requested forced regeneration of documentation structure. Please regenerate based on the latest Data Sources and user requirements, **allowing any modifications**.
     `;
   }
 
-  // If no regeneration needed, return original documentation structure
   if (originalDocumentStructure && !forceRegenerate) {
     return {
       documentStructure: originalDocumentStructure,
     };
   }
 
-  // Performance optimization:
-  // Using both structured output and Tool with Gemini model causes redundant calls
-  // Only use Tool when context is very large
+  // Performance optimization: Using both structured output and tools with the Gemini model can cause redundant calls.
+  // Only use tools when the context is very large.
   const generateStructureAgent = isLargeContext
     ? options.context.agents["generateStructure"]
     : options.context.agents["generateStructureWithoutTools"];
 
-  // Get user preferences for documentation structure and global scope
   const structureRules = getActiveRulesForScope("structure", []);
   const globalRules = getActiveRulesForScope("global", []);
 
-  // Combine structure and global rules, extract only rule text
   const allApplicableRules = [...structureRules, ...globalRules];
   const ruleTexts = allApplicableRules.map((rule) => rule.rule);
 
-  // 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(generateStructureAgent, {
@@ -85,22 +77,21 @@ export default async function checkNeedGenerateStructure(
 
   let message = "";
 
-  // Check and save project information if user hasn't modified it
+  // Check and save project information
   if (result.projectName || result.projectDesc) {
     try {
       const currentConfig = await loadConfigFromFile();
       const projectInfo = await getProjectInfo();
 
-      // Check if user has modified project information
       const userModifiedProjectName =
         currentConfig?.projectName && currentConfig.projectName !== projectInfo.name;
       const userModifiedProjectDesc =
         currentConfig?.projectDesc && currentConfig.projectDesc !== projectInfo.description;
 
-      // If user hasn't modified project info and it's not from GitHub, save AI output
+      // Save AI-generated project info if not modified by the user and not from GitHub
       if (!userModifiedProjectName && !userModifiedProjectDesc) {
         let hasUpdated = false;
-        // Don't update if the current info is from GitHub (meaningful repository info)
+        // Don't update if the current info is from GitHub
         if (
           result.projectName &&
           result.projectName !== projectInfo.name &&
@@ -140,4 +131,5 @@ export default async function checkNeedGenerateStructure(
   };
 }
 
-checkNeedGenerateStructure.taskTitle = "Check if documentation structure needs generate or update";
+checkNeedGenerateStructure.taskTitle =
+  "Check if documentation structure needs to be generated or updated";

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

@@ -2,7 +2,7 @@ import { getActiveRulesForScope } from "../../utils/preferences-utils.mjs";
 import { recordUpdate } from "../../utils/history-utils.mjs";
 
 function formatDocumentStructure(structure) {
-  // Build a tree structure for better display
+  // Create a map of nodes for easy lookup
   const nodeMap = new Map();
   const rootNodes = [];
 
@@ -14,7 +14,7 @@ function formatDocumentStructure(structure) {
     });
   });
 
-  // Second pass: build tree structure
+  // Build the tree structure
   structure.forEach((node) => {
     if (node.parentId) {
       const parent = nodeMap.get(node.parentId);
@@ -76,7 +76,7 @@ export default async function userReviewDocumentStructure({ documentStructure, .
 
   // Ask user if they want to review the documentation structure
   const needReview = await options.prompts.select({
-    message: "Would you like to optimize the documentation structure?",
+    message: "Would you like to refine the documentation structure?",
     choices: [
       {
         name: "No, looks good",
@@ -156,7 +156,7 @@ export default async function userReviewDocumentStructure({ documentStructure, .
             stage: "structure",
           });
         } catch (refinerError) {
-          console.warn("Could not save feedback as user preference:", refinerError.message);
+          console.warn("Could not save feedback as a user preference:", refinerError.message);
           console.warn("Your feedback was applied but not saved as a preference.");
         }
       }

package/agents/init/check.mjs

@@ -0,0 +1,14 @@
+import chalk from "chalk";
+import { getMainLanguageFiles } from "../../utils/docs-finder-utils.mjs";
+
+export default async function checkNeedGenerate({ docsDir, locale, documentExecutionStructure }) {
+  const mainLanguageFiles = await getMainLanguageFiles(docsDir, locale, documentExecutionStructure);
+
+  if (mainLanguageFiles.length === 0) {
+    console.log(
+      `No documents found in the docs directory. Please run ${chalk.yellow("`aigne doc generate`")} to generate the documents`,
+    );
+    process.exit(0);
+  }
+  return {};
+}