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

package/README.md

@@ -30,21 +30,25 @@ As shown in the diagram, DocSmith integrates seamlessly with other [AIGNE](https
 ## ✨ Features
 
 ### 🤖 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.)
 
 ### 🌍 Multi-Language Excellence
+
 - **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
 
 ### 🔗 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
-- **Discuss Kit Publishing**: Deploy to [docsmith.aigne.io](https://docsmith.aigne.io/app/) or your own [Discuss Kit](https://www.arcblock.io/docs/web3-kit/en/discuss-kit) instance
+- **Discuss Kit Publishing**: Deploy 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
@@ -53,80 +57,9 @@ As shown in the diagram, DocSmith integrates seamlessly with other [AIGNE](https
 
 ### Prerequisites
 
-- Node.js 18+ and npm/pnpm
+- Node.js 20+ and npm/pnpm
 - No API keys required (uses AIGNE Hub by default)
 
-### Node.js Installation
-
-#### Windows
-1. Download Node.js installer from [nodejs.org](https://nodejs.org/)
-2. Run the installer (.msi file)
-3. Follow installation wizard steps
-4. Verify installation: `node --version`
-
-#### macOS
-**Option 1: Using Homebrew (Recommended)**
-```bash
-# Install Homebrew if not already installed
-/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
-
-# Install Node.js
-brew install node
-```
-
-**Option 2: Using the Official Installer**
-1. Download the macOS installer from [nodejs.org](https://nodejs.org/)
-2. Double-click the .pkg file to run the installer
-3. Follow the installation wizard
-4. Verify installation: `node --version`
-
-#### Linux
-
-**Ubuntu/Debian:**
-```bash
-# Update package index
-sudo apt update
-
-# Install Node.js
-sudo apt install nodejs npm
-
-# Or install latest LTS version using NodeSource repository
-curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
-sudo apt-get install -y nodejs
-```
-
-**CentOS/RHEL/Fedora:**
-```bash
-# For CentOS/RHEL
-sudo yum install nodejs npm
-
-# For Fedora
-sudo dnf install nodejs npm
-
-# Or using NodeSource repository
-curl -fsSL https://rpm.nodesource.com/setup_lts.x | sudo bash -
-sudo yum install nodejs
-```
-
-**Using Node Version Manager (nvm) - All Linux Distributions:**
-```bash
-# Install nvm
-curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
-
-# Restart terminal or run:
-source ~/.bashrc
-
-# Install latest LTS Node.js
-nvm install --lts
-nvm use --lts
-```
-
-#### Verification
-After installation on any platform, verify Node.js and npm are installed correctly:
-```bash
-node --version
-npm --version
-```
 
 ### 📦 Installation
 
@@ -152,6 +85,7 @@ 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
@@ -165,6 +99,7 @@ DocSmith will:
 DocSmith supports multiple AI providers:
 
 **🎯 AIGNE Hub (Recommended)**
+
 - ✅ No API keys required
 - ✅ Easy model switching
 - ✅ Built-in rate limiting and optimization
@@ -178,6 +113,7 @@ aigne doc generate --model openai:gpt-4o
 
 **🔑 Custom API Keys**
 Configure your own API keys for direct provider access:
+
 - OpenAI GPT models
 - Anthropic Claude models
 - Google Gemini models
@@ -188,6 +124,7 @@ Configure your own API keys for direct provider access:
 ### Core Commands
 
 #### 📝 Generate Documentation
+
 ```bash
 # Smart generation with auto-configuration
 aigne doc generate
@@ -200,6 +137,7 @@ aigne doc generate --feedback "Add more API examples and troubleshooting section
 ```
 
 #### 🔄 Update Existing Documents
+
 ```bash
 # Interactive document selection and update
 aigne doc update
@@ -209,6 +147,7 @@ aigne doc update --docs overview.md --feedback "Add comprehensive FAQ section"
 ```
 
 #### 🌍 Multi-Language Translation
+
 ```bash
 # Interactive translation with smart language selection
 aigne doc translate
@@ -221,6 +160,7 @@ aigne doc translate --glossary @path/to/glossary.md --feedback "Use technical te
 ```
 
 #### 🚀 Publishing & Deployment
+
 ```bash
 # Interactive publishing with platform selection
 aigne doc publish
@@ -230,6 +170,7 @@ aigne doc publish --appUrl https://your-discuss-kit-instance.com
 ```
 
 #### ⚙️ Configuration Management
+
 ```bash
 # Interactive configuration setup
 aigne doc init
@@ -248,43 +189,43 @@ DocSmith automatically detects your project structure, but you can customize:
 - **📁 Source Paths**: Customize which files and directories to analyze
 - **📤 Output Settings**: Configure documentation structure and formatting
 
-
-
 ## 🌐 Supported Languages
 
 DocSmith provides professional translation for 12 languages:
 
-| Language | Code | Support Level |
-|----------|------|---------------|
-| English | `en` | ✅ Native |
-| 简体中文 | `zh-CN` | ✅ Full |
-| 繁體中文 | `zh-TW` | ✅ Full |
-| 日本語 | `ja` | ✅ Full |
-| 한국어 | `ko` | ✅ Full |
-| Español | `es` | ✅ Full |
-| Français | `fr` | ✅ Full |
-| Deutsch | `de` | ✅ Full |
-| Português | `pt-BR` | ✅ Full |
-| Русский | `ru` | ✅ Full |
-| Italiano | `it` | ✅ Full |
-| العربية | `ar` | ✅ Full |
-
+| Language  | Code    | Support Level |
+| --------- | ------- | ------------- |
+| English   | `en`    | ✅ Native     |
+| 简体中文  | `zh-CN` | ✅ Full       |
+| 繁體中文  | `zh-TW` | ✅ Full       |
+| 日本語    | `ja`    | ✅ Full       |
+| 한국어    | `ko`    | ✅ Full       |
+| Español   | `es`    | ✅ Full       |
+| Français  | `fr`    | ✅ Full       |
+| Deutsch   | `de`    | ✅ Full       |
+| Português | `pt-BR` | ✅ Full       |
+| Русский   | `ru`    | ✅ Full       |
+| Italiano  | `it`    | ✅ Full       |
+| العربية   | `ar`    | ✅ Full       |
 
 ## 🤝 Contributing
 
 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
 
 ### 💡 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
+
 ```bash
 # Clone the repository
 git clone https://github.com/AIGNE-io/aigne-doc-smith.git
@@ -298,26 +239,33 @@ pnpm test
 
 # Run linting
 pnpm run lint
+
+# Auto fix lint error
+pnpm run lint:fix
 ```
 
 ### 📜 Code of Conduct
-Please read our [Code of Conduct](https://github.com/AIGNE-io/aigne-doc-smith/blob/main/CODE_OF_CONDUCT.md) before contributing.
+
+Please follow our community guidelines and maintain respectful, constructive communication when contributing.
 
 ## 💼 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
 
 ### 🔒 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
 
 ### 📞 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
@@ -327,27 +275,26 @@ Please read our [Code of Conduct](https://github.com/AIGNE-io/aigne-doc-smith/bl
 ## 📊 Community & Resources
 
 ### 📚 Documentation & Tutorials
-- 📖 [Official Documentation](https://docsmith.aigne.io/docs/)
-- 🎥 [Video Tutorials](https://www.youtube.com/@aigne-io)
-- 📝 [Best Practices Guide](https://docsmith.aigne.io/guides/best-practices)
-- 🔧 [API Reference](https://docsmith.aigne.io/api/)
+
+- 📖 [Documentation](https://docsmith.aigne.io/docs/)
 
 ### 💬 Community Support
-- 💭 [GitHub Discussions](https://github.com/AIGNE-io/aigne-doc-smith/discussions) - Q&A and feature discussions
-- 🐦 [Twitter](https://twitter.com/aigne_io) - Updates and announcements
-- 🎮 [Discord Server](https://discord.gg/aigne) - Real-time community chat
-- 📧 [Newsletter](https://www.aigne.io/newsletter) - Monthly updates and tips
+
+- 🐦 [Twitter](https://twitter.com/arcblock_io) - Updates and announcements
+- 🎮 [Community](https://community.arcblock.io/discussions/boards/aigne) - Real-time community chat
 
 ### 🏆 Showcase
+
 See DocSmith in action with real-world examples:
-- [AIGNE Framework Docs](https://docs.aigne.io) - Generated with DocSmith
-- [Community Projects](https://github.com/topics/aigne-docsmith) - Browse repositories using 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.
 
 ### 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
@@ -355,17 +302,3 @@ This project is licensed under the **Elastic License 2.0** - see the [LICENSE](L
 
 [Learn more about Elastic License 2.0](https://www.elastic.co/licensing/elastic-license)
 
----
-
-<div align="center">
-
-**🚀 Start generating amazing documentation today!**
-
-[![Get Started](https://img.shields.io/badge/Get_Started-brightgreen?style=for-the-badge&logo=rocket)](https://docsmith.aigne.io/get-started)
-[![Join Community](https://img.shields.io/badge/Join_Community-blue?style=for-the-badge&logo=discord)](https://discord.gg/aigne)
-[![Star on GitHub](https://img.shields.io/badge/Star_on_GitHub-yellow?style=for-the-badge&logo=github)](https://github.com/AIGNE-io/aigne-doc-smith)
-
-Made with ❤️ by the [AIGNE Team](https://www.aigne.io/team)
-
-</div>
-

package/RELEASE.md

@@ -5,6 +5,5 @@ Merge that PR when appropriate.
 
 ### Release a prod version
 
-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).  
+When you want publish a prod version, manually execute the GitHub Action 'Create Release PR' to create a release PR for the prod version.
 Merge that PR when appropriate.

package/agents/clear/choose-contents.mjs

@@ -0,0 +1,170 @@
+const TARGET_METADATA = {
+  generatedDocs: {
+    label: "generated documents",
+    description: "Delete all generated documents.",
+    agent: "clearGeneratedDocs",
+  },
+  documentStructure: {
+    label: "document structure",
+    description: "Delete the document structure and all generated documents.",
+    agent: "clearDocumentStructure",
+  },
+  documentConfig: {
+    label: "document configuration",
+    description: "Delete the document configuration.",
+    agent: "clearDocumentConfig",
+  },
+  authTokens: {
+    label: "authorizations",
+    description: "Clear published site authorizations.",
+    agent: "clearAuthTokens",
+  },
+};
+
+const TARGET_KEYS = Object.keys(TARGET_METADATA);
+
+function normalizeTarget(value) {
+  if (!value) return null;
+  const trimmed = value.trim();
+  if (TARGET_METADATA[trimmed]) return trimmed;
+
+  const lowerMatched = TARGET_KEYS.find((key) => key.toLowerCase() === trimmed.toLowerCase());
+  return lowerMatched || null;
+}
+
+export default async function chooseContents(input = {}, options = {}) {
+  const { targets: rawTargets, ...rest } = input;
+
+  const normalizedTargets = Array.isArray(rawTargets)
+    ? rawTargets.map(normalizeTarget).filter(Boolean)
+    : [];
+
+  let selectedTargets = [...new Set(normalizedTargets)];
+
+  if (selectedTargets.length === 0) {
+    if (options?.prompts?.checkbox) {
+      const choices = Object.entries(TARGET_METADATA).map(([value, def]) => ({
+        name: def.label,
+        value,
+        description: def.description,
+      }));
+
+      selectedTargets = await options.prompts.checkbox({
+        message: "Select items to clear:",
+        choices,
+        validate: (answer) => (answer.length > 0 ? true : "Please 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,
+      };
+    }
+  }
+
+  if (selectedTargets.length === 0) {
+    return {
+      message: "No items selected to clear.",
+    };
+  }
+
+  const results = [];
+  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) {
+      results.push({
+        status: "error",
+        message: `Unknown target: ${target}`,
+      });
+      hasError = true;
+      continue;
+    }
+
+    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`);
+      }
+
+      const result = await options.context.invoke(clearAgent, rest);
+
+      if (result.error) {
+        hasError = true;
+        results.push({
+          status: "error",
+          message: result.message,
+        });
+      } else {
+        const status = result.cleared ? "removed" : "noop";
+        results.push({
+          status,
+          message: result.message,
+          path: result.path,
+          suggestions: result.suggestions,
+        });
+
+        // Track if document config was cleared
+        if (target === "documentConfig" && result.cleared) {
+          configCleared = true;
+        }
+      }
+    } catch (error) {
+      hasError = true;
+      results.push({
+        status: "error",
+        message: `Failed to clear ${metadata.label}: ${error.message}`,
+      });
+    }
+  }
+
+  // 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) {
+      suggestions.push(...result.suggestions);
+    }
+  });
+
+  // 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.");
+  }
+
+  const message = [header, "", detailLines, suggestions.length ? "" : null, suggestions.join("\n")]
+    .filter(Boolean)
+    .join("\n");
+
+  return {
+    message,
+  };
+}
+
+chooseContents.input_schema = {
+  type: "object",
+  properties: {
+    targets: {
+      type: "array",
+      description: "Items to clear without confirmation",
+      items: {
+        type: "string",
+        enum: TARGET_KEYS,
+      },
+    },
+  },
+};
+
+chooseContents.taskTitle = "Choose contents to clear";
+chooseContents.description =
+  "Choose contents to clear and execute the appropriate clearing operations";

package/agents/clear/clear-auth-tokens.mjs

@@ -0,0 +1,111 @@
+import { existsSync } from "node:fs";
+import { readFile, writeFile } from "node:fs/promises";
+import { homedir } from "node:os";
+import { join } from "node:path";
+import chalk from "chalk";
+import { parse, stringify } from "yaml";
+
+export default async function clearAuthTokens(_input = {}, options = {}) {
+  const DOC_SMITH_ENV_FILE = join(homedir(), ".aigne", "doc-smith-connected.yaml");
+
+  // Check if the file exists
+  if (!existsSync(DOC_SMITH_ENV_FILE)) {
+    return {
+      message: "No site authorizations found to clear",
+    };
+  }
+
+  try {
+    // Read existing configuration
+    const data = await readFile(DOC_SMITH_ENV_FILE, "utf8");
+    const envs = parse(data) || {};
+
+    // Get all available sites
+    const siteHostnames = Object.keys(envs);
+
+    if (siteHostnames.length === 0) {
+      return {
+        message: "No site authorizations found to clear",
+      };
+    }
+
+    // Display all sites with their URLs for user selection
+    const choices = siteHostnames.map((hostname) => {
+      return {
+        name: `${chalk.cyan(hostname)}`,
+        value: hostname,
+        checked: false, // Allow multiple selection
+      };
+    });
+
+    // Add an option to clear all site authorizations
+    choices.push({
+      name: chalk.red("🗑️  Clear ALL site authorizations"),
+      value: "__ALL__",
+      checked: false,
+    });
+
+    let selectedSites = [];
+
+    if (options?.prompts?.checkbox) {
+      selectedSites = await options.prompts.checkbox({
+        message: "Select sites to clear authorization from:",
+        choices,
+        validate: (answer) => (answer.length > 0 ? true : "Please select at least one site."),
+      });
+    } else {
+      // If no prompts available, clear all site authorizations
+      selectedSites = ["__ALL__"];
+    }
+
+    if (selectedSites.length === 0) {
+      return {
+        message: "No sites selected for clearing authorization",
+      };
+    }
+
+    const results = [];
+    let clearedCount = 0;
+
+    if (selectedSites.includes("__ALL__")) {
+      // Clear all site authorizations
+      await writeFile(DOC_SMITH_ENV_FILE, stringify({}));
+      results.push(`Cleared site authorization for all sites (${siteHostnames.length} sites)`);
+      clearedCount = siteHostnames.length;
+    } else {
+      // Clear site authorizations for selected sites
+      const updatedEnvs = { ...envs };
+
+      for (const hostname of selectedSites) {
+        if (updatedEnvs[hostname]) {
+          // Remove the entire site object
+          delete updatedEnvs[hostname];
+
+          results.push(`Cleared site authorization for ${chalk.cyan(hostname)}`);
+          clearedCount++;
+        }
+      }
+
+      await writeFile(DOC_SMITH_ENV_FILE, stringify(updatedEnvs));
+    }
+
+    const header = `Successfully cleared site authorizations!`;
+    const detailLines = results.join("\n");
+
+    const message = [header, "", detailLines, ""].filter(Boolean).join("\n");
+
+    return {
+      message,
+      clearedCount,
+      clearedSites: selectedSites.includes("__ALL__") ? siteHostnames : selectedSites,
+    };
+  } catch (error) {
+    return {
+      message: `Failed to clear site authorizations: ${error.message}`,
+      error: true,
+    };
+  }
+}
+
+clearAuthTokens.taskTitle = "Clear site authorizations";
+clearAuthTokens.description = "Clear site authorizations for document publishing sites";

package/agents/clear/clear-document-config.mjs

@@ -0,0 +1,39 @@
+import { rm } from "node:fs/promises";
+import { join } from "node:path";
+import { pathExists, toDisplayPath } from "../../utils/file-utils.mjs";
+
+export default async function clearDocumentConfig({ workDir }) {
+  // Fixed path where config.yaml is saved by init command
+  const cwd = workDir || process.cwd();
+  const documentConfigPath = join(cwd, ".aigne", "doc-smith", "config.yaml");
+  const displayPath = toDisplayPath(documentConfigPath);
+
+  try {
+    const existed = await pathExists(documentConfigPath);
+    await rm(documentConfigPath, { recursive: true, force: true });
+
+    const message = existed
+      ? `Cleared document configuration (${displayPath})`
+      : `Document configuration already empty (${displayPath})`;
+
+    const suggestions = existed
+      ? ["Run `aigne doc init` to generate a fresh configuration file."]
+      : [];
+
+    return {
+      message,
+      cleared: existed,
+      path: displayPath,
+      suggestions,
+    };
+  } catch (error) {
+    return {
+      message: `Failed to clear document configuration: ${error.message}`,
+      error: true,
+      path: displayPath,
+    };
+  }
+}
+
+clearDocumentConfig.taskTitle = "Clear document configuration";
+clearDocumentConfig.description = "Clear the document configuration file";