---
name: "docfx-dotnet-api-documentation"
description: "Generate cross-platform technical documentation and .NET API references with DocFX."
metadata:
  author: "Microsoft / .NET Foundation"
  version: "1.0.0"
  runtime_compatibility:
    - "codex"
    - "claude-code"
    - "cursor"
    - "windsurf"
triggers:
  - "generate dotnet api docs docfx"
  - "configure docfx.json"
  - "build static docfx website"
permissions:
  fs_read: true
  fs_write: "workspace"
  shell_exec: false
  net_access: false
---

# DocFX .NET API Documentation Engine

Extracts XML documentation comments from C#, VB.NET, and F# source code, merging conceptual Markdown articles into a unified searchable static documentation portal.

## When to Invoke
Invoke this skill whenever you need to:
- generate dotnet api docs docfx
- configure docfx.json
- build static docfx website

## Execution SOP & Rules
1. Configure build targets, metadata extraction, and templates inside docfx.json.
2. Run docfx metadata to generate YAML files from .NET project assemblies.
3. Run docfx build to compile Markdown articles and YAML metadata into a static website.
4. Validate that all public APIs include meaningful <summary> and <param> XML doc comments.

## Verification Checklist
- Run local linting, syntax validation, and type-checks before reporting completion.
- Ensure all created or modified files adhere to workspace boundaries and avoid uncommitted secrets.
- Verify tests or build commands exit cleanly with return code 0.