Skip to content
Back to search

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.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/aigne-io--aigne-doc-smith/badge.svg)](/listings/aigne-io--aigne-doc-smith)

HTML

<a href="/listings/aigne-io--aigne-doc-smith"><img src="/api/listings/aigne-io--aigne-doc-smith/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

1. Install Aigne CLI

npm install -g @aigne/cli

2. Start DocSmith

Run directly in your project root:

cd my-project
aigne doc

On first execution, Aigne CLI will automatically install DocSmith and start the interactive documentation generation process.

**Automatic Initialization:**

DocSmith will automatically: - Detect the current project - Create workspace in `.aigne/doc-smith/` directory - Generate config.yaml configuration file

**Completed During Conversation:**

DocSmith will guide you through: 1. Ask for output language (if not specified) 2. Analyze project content 3. Infer user intent 4. Plan documentation structure 5. Generate structured Markdown documentation

3. Generated Directory Structure

my-project/
├── .aigne/
│   └── doc-smith/              # DocSmith workspace
│       ├── config.yaml         # Configuration file
│       ├── intent/             # User intent
│       ├── planning/           # Documentation structure planning
│       ├── docs/               # Generated documentation
│       │   ├── overview.md
│       │   ├── getting-started.md
│       │   └── api/
│       │       └── authentication.md
│       └── cache/              # Temporary data
└── (other project files...)

4. Independent Workspace Mode (Optional)

To separate documentation project from source code, use independent workspace:

# Create independent workspace
mkdir my-docs
cd my-docs
aigne doc

Independent mode supports multiple data source configuration:

# config.yaml
sources:
  - name: "main"
    type: local-path
    path: "../my-project"

  - name: "other-repo"
    type: git-clone
    url: "https://github.com/example/repo.git"
    branch: "main"

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 272 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # DocSmith
  2. AI-powered documentation generation tool built on the Aigne Framework.
  3. [中文文档](./README.zh.md)
  4. ## Features
  5. DocSmith is a complete documentation generation system that provides:
  6. - 📚 Generate comprehensive documentation from code repositories, text files, and media resources
  7. - 🏗️ Build organized documentation structures and documentation sites
  8. - 📝 Intelligently analyze workspace content and generate structured documentation
  9. - 🔄 Convert code/project content into readable documentation
  10. - 🌍 Multi-language support and documentation localization
  11. - 🖼️ Automatic generation and updating of documentation images
  12. - 📤 One-click publishing to multiple platforms
  13. Supports generating:
  14. - Technical documentation
  15. - User guides
  16. - API references
  17. - Tutorials and examples
  18. - Product documentation
  19. ### User Intent Analysis
  20. DocSmith automatically analyzes workspace content to infer:
  21. - **Target audience** - Primary readers of the documentation (developers, operators, end users, etc.)
  22. - **Use cases** - Context in which users consult the documentation (first contact, development integration, troubleshooting, etc.)
  23. - **Documentation focus** - Documentation type (user guide, API reference, quick start, architecture overview, etc.)
  24. Inference results are presented to users for confirmation, with support for multiple rounds of adjustments until satisfied.
  25. ### Structure Confirmation Mechanism
  26. Before generating documentation, DocSmith displays the planned documentation structure:
  27. - Total number of documents and hierarchy
  28. - Title, description, and source files for each document
  29. - Clear emoji indicators for quick browsing
  30. Users can:
  31. - Delete/add documents
  32. - Adjust hierarchy (merge, split, adjust parent-child relationships)
  33. - Modify content scope
  34. Actual content generation begins only after user confirms the structure.
  35. ## Project Structure
  36. ```
  37. aigne-doc-smith/
  38. ├── aigne.yaml # Aigne framework configuration
  39. ├── package.json # Project dependencies and metadata
  40. ├── CLAUDE.md # Claude Code project description
  41. ├── README.md # This file
  42. │
  43. ├── agents/ # Specialized Agents
  44. │ ├── bash-executor/ # Bash command execution agent
  45. │ ├── clear/ # Configuration cleanup agent
  46. │ ├── content-checker/ # Content checking agent
  47. │ ├── generate-images/ # Image generation agent
  48. │ ├── localize/ # Documentation localization agent
  49. │ ├── publish/ # Documentation publishing agent
  50. │ ├── save-document/ # Document saving agent
  51. │ ├── structure-checker/ # Structure checking agent
  52. │ └── update-image/ # Image update agent
  53. │
  54. ├── skills/ # Skill definitions
  55. │ └── doc-smith/ # DocSmith Skill
  56. │ ├── SKILL.md # Skill main document
  57. │ └── references/ # Reference documents
  58. │
  59. ├── skills-entry/ # Aigne framework entry configuration
  60. │ └── doc-smith/
  61. │ ├── index.yaml # Main entry configuration
  62. │ └── prompt.md # Prompt template
  63. │
  64. ├── utils/ # Utility library
  65. │ ├── config.mjs # Configuration management
  66. │ ├── docs.mjs # Document processing
  67. │ ├── git.mjs # Git operations
  68. │ ├── image-utils.mjs # Image utilities
  69. │ ├── workspace.mjs # Workspace management
  70. │ └── ... # More utilities
  71. │
  72. └── scripts/ # Helper scripts
  73. └── ...
  74. ```
  75. ## Quick Start
  76. ### 1. Install Aigne CLI
  77. ```bash
  78. npm install -g @aigne/cli
  79. ```
  80. ### 2. Start DocSmith
  81. Run directly in your project root:
  82. ```bash
  83. cd my-project
  84. aigne doc
  85. ```
  86. On first execution, Aigne CLI will automatically install DocSmith and start the interactive documentation generation process.
  87. **Automatic Initialization:**
  88. DocSmith will automatically:
  89. - Detect the current project
  90. - Create workspace in `.aigne/doc-smith/` directory
  91. - Generate config.yaml configuration file
  92. **Completed During Conversation:**
  93. DocSmith will guide you through:
  94. 1. Ask for output language (if not specified)
  95. 2. Analyze project content
  96. 3. Infer user intent
  97. 4. Plan documentation structure
  98. 5. Generate structured Markdown documentation
  99. ### 3. Generated Directory Structure
  100. ```
  101. my-project/
  102. ├── .aigne/
  103. │ └── doc-smith/ # DocSmith workspace
  104. │ ├── config.yaml # Configuration file
  105. │ ├── intent/ # User intent
  106. │ ├── planning/ # Documentation structure planning
  107. │ ├── docs/ # Generated documentation
  108. │ │ ├── overview.md
  109. │ │ ├── getting-started.md
  110. │ │ └── api/
  111. │ │ └── authentication.md
  112. │ └── cache/ # Temporary data
  113. └── (other project files...)
  114. ```
  115. ### 4. Independent Workspace Mode (Optional)
  116. To separate documentation project from source code, use independent workspace:
  117. ```bash
  118. # Create independent workspace
  119. mkdir my-docs
  120. cd my-docs
  121. aigne doc
  122. ```
  123. Independent mode supports multiple data source configuration:
  124. ```yaml
  125. # config.yaml
  126. sources:
  127. - name: "main"
  128. type: local-path
  129. path: "../my-project"
  130. - name: "other-repo"
  131. type: git-clone
  132. url: "https://github.com/example/repo.git"
  133. branch: "main"
  134. ```
  135. ## Core Features
  136. ### Documentation Generation
  137. - Intelligent analysis of source code and project structure
  138. - Automatic inference of user intent and target audience
  139. - Generation of structured Markdown documentation
  140. - Support for documentation hierarchy planning and confirmation
  141. ### Image Management
  142. - Automatic generation of documentation images
  143. - Image placeholder system support
  144. - Batch update and edit images
  145. - Multiple image generation model support
  146. ### Multi-language Support
  147. - Documentation localization and translation
  148. - Multi-language documentation structure management
  149. - Automatic synchronization of different language versions
  150. ### Publishing and Deployment
  151. - One-click publishing to multiple platforms
  152. - Custom publishing configuration support
  153. - Documentation site building and deployment
  154. ## Development
  155. ### Install Dependencies
  156. ```bash
  157. pnpm install
  158. ```
  159. ### Code Quality
  160. Project uses Biome for code linting and formatting:
  161. ```bash
  162. # Check code
  163. pnpm run lint
  164. # Auto fix
  165. pnpm run lint:fix
  166. ```
  167. ### Modifying Agents
  168. To add or modify agents:
  169. 1. Create or modify agent in `agents/` directory
  170. 2. Register new agent in `aigne.yaml`
  171. 3. Write agent prompts and configuration files
  172. ### Modifying Utility Functions
  173. To extend or optimize utility functions:
  174. 1. Add or modify utility functions in `utils/` directory
  175. 2. Ensure ES module syntax (`.mjs` files)
  176. 3. Import and use where needed
  177. ## Tech Stack
  178. - **Aigne Framework** - AI agent orchestration framework
  179. - **Node.js** - Runtime environment (ES modules)
  180. - **pnpm** - Package manager
  181. - **Biome** - Code linting and formatting
  182. - **YAML** - Configuration and data format
  183. ## Notes
  184. - Ensure Node.js (v18+) and pnpm are installed
  185. - Ensure Git is installed (for submodule and version management)
  186. - Anthropic API key or other LLM provider configuration required
  187. - Image generation features require corresponding API key configuration
  188. ## Migration Guide
  189. If you previously used an older version (`.aigne/doc-smith/` directory structure), we recommend:
  190. 1. Create a new workspace directory
  191. 2. Regenerate documentation
  192. 3. Old version data can be manually migrated to the new workspace directory structure
  193. ## Version
  194. Current version: `0.9.11`
  195. ## Support
  196. For issues or suggestions, please open an issue in the project.
  197. ## Author
  198. **Arcblock** - [blocklet@arcblock.io](mailto:blocklet@arcblock.io)
  199. GitHub: [@blocklet](https://github.com/blocklet)
  200. ## License
  201. Elastic-2.0 License
  202. ## Related Links
  203. - [Aigne Framework](https://www.npmjs.com/package/@aigne/cli)
  204. - [Arcblock](https://www.arcblock.io/)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.