v6.2.0 Release: Documentation Made Simple
2025-06-05SuCoS v6.2.0 is here with an exciting new feature that transforms how you generate API documentation! This release introduces a powerful new command that makes creating comprehensive API docs as simple as running a single command.
Introducing API Documentation Generation
We're thrilled to introduce the brand new sucos api command - a game-changing feature that scans your C# projects and generates beautiful, comprehensive API documentation automatically. Say goodbye to complex DocFx configurations and hello to documentation that just works!
With a simple command:
sucos api --project <PATH>
SuCoS will analyze your C# project and create ready-to-publish documentation for all your public classes, records, enums, interfaces, and more. Every public member gets properly documented with clear, navigable output that integrates seamlessly with SuCoS's proven template system.
The sucos api command leverages the power of Roslyn analyzers to deeply understand your C# code structure. It automatically extracts:
- Classes and Records: Complete documentation including constructors, properties, and methods
- Interfaces: All method signatures and their purposes
- Enums: Every value with descriptions when available
- Namespaces: Organized hierarchically for easy navigation
- XML Documentation: Integrates seamlessly with your existing XML doc comments
The generated documentation follows SuCoS's familiar, easy-to-understand concepts. No need to learn complex new markup or configuration files - if you know SuCoS, you already know how to customize your API documentation.
Why Choose SuCoS API Over DocFx
While DocFx is powerful, it can be overwhelming with its complex configuration requirements and steep learning curve. SuCoS API takes a different approach:
- Zero Configuration: Point it at your project and go
- Familiar Templates: Use the same templating system you already know
- Consistent Styling: Matches your existing SuCoS site perfectly
- Simple Customization: Modify output using standard SuCoS concepts
- Fast Generation: Optimized for speed and efficiency
Want to see it in action? Check out our own API documentation at sucos.brunomassa.com/api - generated entirely with this new feature!
Dependency Updates
As part of our commitment to staying current with the .NET ecosystem, we've updated all dependencies to their latest versions as of June 5, 2025. These updates ensure optimal performance, security, and compatibility with the latest development tools and frameworks.
This comprehensive update includes improvements to our Liquid templating engine, YAML processing capabilities, and core .NET runtime optimizations that benefit every aspect of SuCoS operation.
The new API documentation feature represents a significant step forward in making developer documentation accessible and beautiful. Whether you're documenting a small library or a complex enterprise application, SuCoS v6.2.0 gives you the tools to create professional, navigable API documentation without the hassle.