aigne-doc-smith

aigne-doc-smith

AIGNE DocSmith is a powerful, AI-driven documentation generation tool built on the AIGNE Framework. It automates the creation of detailed, structured, and multi-language documentation directly from your source code.

Stars: 307

Visit
 screenshot

AIGNE DocSmith is a powerful AI-driven documentation generation tool that automates the creation of detailed, structured, and multi-language documentation directly from source code. It intelligently analyzes codebase to generate a comprehensive document structure, populates content with high-quality AI-powered generation, supports seamless translation into 12+ languages, integrates with AIGNE Hub for large language models, offers Discuss Kit publishing, automatically updates documentation with source code changes, and allows for individual document optimization.

README:

GitHub stars NPM Version NPM Downloads Open Issues License codecov

AIGNE DocSmith

๐Ÿš€ AI-powered documentation generation that understands your code

AIGNE DocSmith is a powerful, AI-driven documentation generation tool built on the AIGNE Framework. It automatically analyzes your codebase and generates 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

AIGNE Ecosystem

DocSmith is part of the AIGNE ecosystem, a comprehensive AI application development platform. Here's the architecture overview:

AIGNE Ecosystem Architecture

As shown in the diagram, DocSmith integrates seamlessly with other AIGNE components, leveraging the platform's AI capabilities and infrastructure.

โœจ 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 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 or your own 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

๐Ÿš€ Quick Start

Prerequisites

  • Node.js 20+ and npm/pnpm
  • No API keys required (uses AIGNE Hub by default)

๐Ÿ“ฆ Installation

Install the AIGNE CLI globally:

npm install -g @aigne/cli

Verify the installation:

aigne doc --help

๐ŸŽ‰ Generate Your First Documentation

Navigate to your project directory and run:

# One command to rule them all
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

๐Ÿ”ง Advanced Configuration

LLM Providers

DocSmith supports multiple AI providers:

๐ŸŽฏ AIGNE Hub (Recommended)

  • โœ… No API keys required
  • โœ… Easy model switching
  • โœ… Built-in rate limiting and optimization
# Switch models effortlessly
aigne doc generate --model google:gemini-2.5-pro
aigne doc generate --model claude:claude-3-5-sonnet
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
  • And more...

๐Ÿ“– Usage Guide

Core Commands

๐Ÿ“ Generate Documentation

# Smart generation with auto-configuration
aigne doc generate

# Force complete regeneration
aigne doc generate --forceRegenerate

# Generate with custom feedback
aigne doc generate --feedback "Add more API examples and troubleshooting sections"

๐Ÿ”„ Update Existing Documents

# Interactive document selection and update
aigne doc update

# Update specific document with feedback
aigne doc update --docs overview.md --feedback "Add comprehensive FAQ section"

๐ŸŒ Multi-Language Translation

# Interactive translation with smart language selection
aigne doc translate

# Translate specific documents to multiple languages
aigne doc translate --langs zh --langs ja --docs examples.md --docs overview.md

# Translation with custom glossary for consistent terminology
aigne doc translate --glossary @path/to/glossary.md --feedback "Use technical terminology consistently"

๐Ÿš€ Publishing & Deployment

# Interactive publishing with platform selection
aigne doc publish

# Publish to custom Discuss Kit instance
aigne doc publish --appUrl https://your-discuss-kit-instance.com

โš™๏ธ Configuration Management

# Interactive configuration setup
aigne doc init

# View current configuration
aigne doc prefs

Configuration Options

DocSmith automatically detects your project structure, but you can customize:

  • ๐Ÿ“ 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

๐ŸŒ 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

๐Ÿค Contributing

We welcome contributions from the community! Here's how you can help:

๐Ÿ› Reporting Issues

  • ๐Ÿ” Search existing 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
  • ๐Ÿ“‹ Check our roadmap for planned features
  • ๐Ÿ—ณ๏ธ Vote on existing feature requests

๐Ÿ”ง Development Setup

# Clone the repository
git clone https://github.com/AIGNE-io/aigne-doc-smith.git
cd aigne-doc-smith

# Install dependencies
pnpm install

# Run tests
pnpm test

# Run linting
pnpm run lint

# Auto fix lint error
pnpm run lint:fix

๐Ÿ“œ Code of Conduct

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

Contact us for enterprise licensing and deployment options.

๐Ÿ“Š Community & Resources

๐Ÿ“š Documentation & Tutorials

๐Ÿ’ฌ Community Support

  • ๐Ÿฆ Twitter - Updates and announcements
  • ๐ŸŽฎ Community - Real-time community chat

๐Ÿ† Showcase

See DocSmith in action with real-world examples:

๐Ÿ“„ License

This project is licensed under the Elastic License 2.0 - see the 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

Learn more about Elastic License 2.0

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for aigne-doc-smith

Similar Open Source Tools

For similar tasks

For similar jobs