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.
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.
sourcePaths:
- https://api.example.com/openapi.jsonThis 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).
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.
diagramming:
effort: 5 # 0-10 scale, 0 = no diagrams, 10 = maximumClean 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.
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:
aigne doc publish --with-brandingGetting Started#
New Users#
npm install -g @aigne/cli@latest
aigne doc init
aigne doc createExisting Users#
Update to the latest version:
npm install -g @aigne/cli@latest
aigne doc upgradeAdd optional new config fields in your aigne.yml:
thinking:
effort: low
diagramming:
effort: 5No 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#
- Documentation: https://docsmith.aigne.io/docs/
- GitHub: https://github.com/AIGNE-io/aigne-doc-smith
- Issues: https://github.com/AIGNE-io/aigne-doc-smith/issues
- Community: https://community.arcblock.io/discussions/boards/aigne
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:
npm install -g @aigne/cli@latest