dotnet-api-docs

Generate .NET API documentation with DocFX and OpenAPI specifications.

71|10|Updated Feb 11, 2026
One-click install
npx skills add https://github.com/wshaddix/dotnet-skills --skill dotnet-api-docs-wshaddix
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: dotnet-api-docs
Source: https://github.com/wshaddix/dotnet-skills/tree/main/skills/dotnet-api-docs
Command: npx skills add https://github.com/wshaddix/dotnet-skills --skill dotnet-api-docs-wshaddix

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

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.

Frequently Asked Questions about dotnet-api-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate API documentation for a .NET project using DocFX?

To generate API documentation for a .NET project using DocFX, use this Skill to process .NET assemblies and automatically create comprehensive, up-to-date API references. It streamlines extraction and presentation to keep documentation synchronized with your codebase.

Can I integrate OpenAPI specifications for interactive .NET API documentation?

Yes, you can integrate OpenAPI specifications for interactive .NET API documentation. This Skill leverages OpenAPI specs to enable interactive documentation interfaces like Scalar and Swagger UI for accessible API references.

How do I validate API documentation completeness in a CI/CD pipeline?

You can validate API documentation completeness in a CI/CD pipeline by implementing CI checks provided by this Skill. It detects broken links, enforces documentation completeness, and ensures references stay synchronized with code changes.

What is the best way to manage versioned documentation for multiple .NET API versions?

The best way to manage versioned documentation for multiple .NET API versions is using this Skill's built-in versioning strategies. It supports managing and presenting distinct documentation sets across different API releases.

Does DocFX automatically update API references on every commit?

Yes, DocFX can automatically update API references on every commit. By integrating this Skill into your workflow, it generates and updates documentation continuously, ensuring developers always access accurate, current information.