The Complete Production SOP: How to Deploy and Run DocFX .NET API Documentation Engine in Autonomous AI Agents

---
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.

{
  "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
  "metadata": [
    {
      "src": [
        {
          "src": "../src",
          "files": ["**/*.csproj"]
        }
      ],
      "dest": "api",
      "includePrivateMembers": false
    }
  ],
  "build": {
    "content": [
      {
        "files": ["api/**.yml", "api/index.md"]
      },
      {
        "files": ["articles/**.md", "toc.yml", "*.md"]
      }
    ],
    "resource": [
      {
        "files": ["images/**"]
      }
    ],
    "output": "_site",
    "template": ["default", "modern"]
  }
}

#!/usr/bin/env bash
set -euo pipefail
echo "Validating DocFX build output..."
dotnet docfx docs/docfx.json --warningsAsErrors
if [ ! -f "docs/_site/index.html" ] || [ ! -d "docs/_site/api" ]; then
  echo "Error: Expected static documentation files were not generated."
  exit 1
fi
echo "DocFX documentation compiled successfully."