Skip to main content

AIGNE DocSmith Update: Smarter Documentation, Less Effort

wangshijun
AIGNEDocSmithProduct Release

We're excited to announce AIGNE DocSmith 0.9.0, our biggest beta release to date. This release focused on adding several new features and improvements that make creating and maintaining documentation easier, faster, and more cost-effective. Share your feedback to help share the future of DocSmith.

AIGNE DocSmith project dashboard showing documentation projects and their status

What's New?

API Documentation Made Simple

You can now generate complete API documentation directly from OpenAPI specifications. Just add your OpenAPI spec URL to the config, run aigne doc generate, and get comprehensive API docs with endpoints, parameters, examples, and more.

yaml
sourcePaths:
  - https://api.example.com/openapi.json

This saves hours of manual API documentation work.

Control Costs with Reasoning Effort

New reasoning effort controls let you balance quality with cost and speed. Set it low for quick drafts (faster, cheaper), high for production docs (higher quality, more tokens used).

yaml
thinking:
  effort: low  # minimal, low, medium, high

Use low for rapid iterations and high when you publishing documentation your team will rely on.

Diagram Control

Too many diagrams can clutter docs. Now you can set exactly how many you want on a scale of 0-10, where zero means no diagrams and 10 means maximum visual documentation.

yaml
diagramming:
  effort: 5  # 0-10 scale, 0 = no diagrams, 10 = maximum

Clean Up Your Docs

New aigne doc clear command lets you selectively remove documents you no longer need. Keep your documentation set tidy.

Evaluation Reports That Open Automatically

After running aigne doc evaluate, the quality report now opens in your browser automatically giving you faster feedback, quicker improvements.

Better AI Understanding

AI File System Integration

AI agents now understand your codebase better through the new AI File System. This means:

  • More accurate code examples in your documentation
  • Better context awareness across large projects
  • Improved documentation quality for large projects/complex codebases

Smarter Media Handling

AI can now analyze and describe images in your documentation. Include your images in source paths and the AI will generate meaningful descriptions.

yaml
sourcePaths:
  - ./assets/images/**/*.{png,jpg}

Performance Improvements

Real-world metrics from this release show significant improvements:

  • 70% token savings on targeted updates through intent analysis
  • 30% faster structure planning with shared context
  • 85% fewer unnecessary diagrams with smart generation
  • 40% better translation accuracy
  • 60% fewer publishing failures

What We Fixed

This release includes over 40 fixes across documentation generation, translation, publishing, and file operations. Key updates include:

  • Translation now works correctly for all update operations
  • Code blocks stay intact during translation
  • Published docs display images properly
  • Better path handling for nested git repositories
  • Improved authentication flow for publishing

Enhanced Publishing Experience

Publishing is now smoother with:

  • Shorter, shareable authentication URLs
  • Better error messages when things go wrong
  • Automatic session validation
  • Improved token refresh handling

You can optionally update branding during publish:

bash
aigne doc publish --with-branding

Getting Started

New Users

bash
npm install -g @aigne/cli@latest
aigne doc init
aigne doc create

Existing Users

Update to the latest version:

bash
npm install -g @aigne/cli@latest
aigne doc upgrade

Add optional new config fields in your aigne.yml:

yaml
thinking:
  effort: low

diagramming:
  effort: 5

No breaking changes—all existing configs work as before.

Under the Hood

Better Prompts

Enhanced prompts produce more expressive documentation with better structure. We've standardized XML tag usage and improved formatting guidelines.

Token Optimization

Multiple improvements have reduced token usage:

  • Intent analysis for targeted updates
  • Chunked processing for large codebases
  • Smart context sharing
  • Selective regeneration of only changed content

What's Next

We're working on:

  • Advanced search within generated docs
  • Custom component templates
  • Integration with more documentation platforms
  • Enhanced multilingual support

Resources

Help Shape v1.0

We're in beta and actively refining DocSmith based on feedback. Found a bug? Have a feature idea? Know a community who could use some new docs? Share your feedback in the community and help us build the documentation tool you want.

Try It Today

AIGNE DocSmith 0.9.0 makes documentation generation smarter and more cost-effective. Whether you're documenting APIs, codebases, or entire projects, this release has tools to help you work faster and better.

Update now and see the difference:

bash
npm install -g @aigne/cli@latest

Referenced here

Products

  • AIGNE active

    A framework for developers building agents. Start from the command line to create and run a project; use the framework documentation for the parts that need detail.

  • DocSmith superseded

    Generates and maintains documentation alongside the code it describes, including multilingual versions. Its work has been taken into ARC; the standalone tool is no longer maintained.