aigne-doc-smith

# DocSmith

AI-powered documentation generation tool built on the Aigne Framework.

[中文文档](./README.zh.md)

## Features

DocSmith is a complete documentation generation system that provides:
- 📚 Generate comprehensive documentation from code repositories, text files, and media resources
- 🏗️ Build organized documentation structures and documentation sites
- 📝 Intelligently analyze workspace content and generate structured documentation
- 🔄 Convert code/project content into readable documentation
- 🌍 Multi-language support and documentation localization
- 🖼️ Automatic generation and updating of documentation images
- 📤 One-click publishing to multiple platforms

Supports generating:
- Technical documentation
- User guides
- API references
- Tutorials and examples
- Product documentation

### User Intent Analysis

DocSmith automatically analyzes workspace content to infer:
- **Target audience** - Primary readers of the documentation (developers, operators, end users, etc.)
- **Use cases** - Context in which users consult the documentation (first contact, development integration, troubleshooting, etc.)
- **Documentation focus** - Documentation type (user guide, API reference, quick start, architecture overview, etc.)

Inference results are presented to users for confirmation, with support for multiple rounds of adjustments until satisfied.

### Structure Confirmation Mechanism

Before generating documentation, DocSmith displays the planned documentation structure:
- Total number of documents and hierarchy
- Title, description, and source files for each document
- Clear emoji indicators for quick browsing

Users can:
- Delete/add documents
- Adjust hierarchy (merge, split, adjust parent-child relationships)
- Modify content scope

Actual content generation begins only after user confirms the structure.

## Project Structure

```
aigne-doc-smith/
├── aigne.yaml                # Aigne framework configuration
├── package.json              # Project dependencies and