dotnet-api-docs

What problem does it solve?

This Skill automates the generation of comprehensive API documentation for .NET projects, ensuring that your API reference stays accurate and up-to-date with your codebase.

Core Features & Use Cases

• DocFX Setup: Configure DocFX for API reference generation from .NET assemblies and XML comments.
• OpenAPI as Docs: Utilize OpenAPI specifications for interactive API documentation with Scalar or Swagger UI.
• Sync & Validation: Implement CI checks to ensure documentation stays synchronized with code changes.
• Versioned Docs: Manage and present documentation for multiple API versions.
• Use Case: Automatically generate and maintain the API reference documentation for a .NET library, ensuring developers can easily understand and use its public API.

Quick Start

Set up DocFX to generate API documentation for your .NET project by running 'docfx metadata docfx.json'.