What problem does it solve?
This Skill streamlines the process of generating, maintaining, and presenting API documentation for .NET projects, ensuring it stays accurate and accessible.
Core Features & Use Cases
- API Reference Generation: Creates comprehensive API reference documentation from .NET assemblies using DocFX.
- OpenAPI Integration: Leverages OpenAPI specifications for interactive API documentation with tools like Scalar and Swagger UI.
- Documentation Synchronization: Implements CI checks to keep documentation in sync with code, detecting broken links and enforcing documentation completeness.
- Versioned Documentation: Supports strategies for managing and presenting documentation across multiple API versions.
- Use Case: Automatically generate and update the API reference documentation for your .NET library on every commit, ensuring developers always have access to accurate information.
Quick Start
Use the dotnet-api-docs skill to generate API documentation for the current .NET project using DocFX.