skills.rest
dodyg
dodygCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

dotnet-api-docs

Generate DocFX metadata, OpenAPI specs, and versioned HTML documentation for .NET projects.

Updated Aug 16, 2025
Search Tags:#versioning#documentation#openapi#dotnet#generate#api-docs#docfx
One-click install
npx skills add https://github.com/dodyg/blue-nile-pds --skill dotnet-api-docs-dodyg
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: dotnet-api-docs
Source: https://github.com/dodyg/blue-nile-pds/tree/main/.agents/skills/dotnet-api-docs
Command: npx skills add https://github.com/dodyg/blue-nile-pds --skill dotnet-api-docs-dodyg

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers need reliable, up‑to‑date API documentation for .NET libraries, but manually maintaining DocFX or OpenAPI specs is error‑prone and time‑consuming.

Core Features & Use Cases

  • DocFX setup: Generates API reference metadata and customizable HTML sites directly from assemblies.
  • OpenAPI integration: Produces living OpenAPI specs that can be embedded with Scalar or Swagger UI.
  • Versioned documentation: Supports multi‑version sites with selectors and URL patterns.
  • CI validation: Enforces XML doc completeness, broken‑link detection, and automated doc builds on pull requests.

Quick Start

Ask the dotnet-api-docs skill to generate API reference documentation for the .NET project in the current repository.

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 .NET API documentation from an existing project?▼

Generating .NET API documentation requires a buildable .NET project. The skill processes assemblies to produce DocFX metadata, OpenAPI specifications, and a searchable HTML site automatically.

Can I create versioned API docs for a .NET library?▼

Yes, you can create versioned API docs for your .NET library. The skill supports multi-version documentation sites with selectors and URL patterns to organize different releases.

How does DocFX work with OpenAPI specifications in .NET?▼

DocFX integrates with OpenAPI by producing living OpenAPI specifications from .NET assemblies. These specs can be embedded with Scalar or Swagger UI for interactive API exploration.

What's the best way to automate .NET API docs generation in CI?▼

The best way to automate .NET API docs generation in CI is by enforcing XML doc completeness, detecting broken links, and running automated DocFX builds on pull requests to ensure documentation accuracy.

Do I need the DocFX tool installed to use this skill?▼

Yes, you need the DocFX tool installed. A buildable .NET project and the DocFX tool are required prerequisites to output searchable HTML and versioned API documentation successfully.

Related Skills

Explore More Software Engineering Skills→
AGIBuildAGIBuild
10

dotnet-api-docs

Generate .NET API documentation with DocFX and OpenAPI specifications.

Community
Advanced
ResgridResgrid
224

scalar

Generates browsable HTML documentation for .NET 10 APIs and handles customizable routing and theming options.

Official
Intermediate
wshaddixwshaddix
71

dotnet-api-docs

Generate .NET API documentation with DocFX and OpenAPI specifications.

Community
Advanced
rudironsonirudironsoni

dotnet-api-docs

Generate .NET API documentation with DocFX and OpenAPI specifications.

Community
Intermediate