Fail docfx on invalid internal link, fix build warning based on dotnet/docfx#9804 (#1681)

Author: bkoelman

.github/workflows/build.yml

@@ -133,7 +133,7 @@ jobs:
       run: |
         cd docs
         & ./generate-examples.ps1
-        dotnet docfx docfx.json
+        dotnet docfx docfx.json --warningsAsErrors true
         if ($LastExitCode -ne 0) {
             Write-Error "docfx failed with exit code $LastExitCode."
         }

docs/build-dev.ps1

@@ -40,7 +40,7 @@ if (-Not $NoBuild -Or -Not (Test-Path -Path _site)) {
 dotnet tool restore
 VerifySuccessExitCode
 
-dotnet docfx ./docfx.json
+dotnet docfx ./docfx.json --warningsAsErrors true
 VerifySuccessExitCode
 
 Copy-Item -Force home/*.html _site/

docs/docfx.json

@@ -1,53 +1,67 @@
 {
-    "metadata": [
+  "metadata": [
+    {
+      "properties": {
+        "ProduceReferenceAssembly": "true"
+      },
+      "src": [
         {
-            "src": [
-                {
-                    "files": [ "**/JsonApiDotNetCore.csproj","**/JsonApiDotNetCore.Annotations.csproj" ],
-                    "src": "../"
-                }
-            ],
-            "dest": "api",
-            "disableGitFeatures": false
+          "files": [
+            "**/JsonApiDotNetCore.csproj",
+            "**/JsonApiDotNetCore.Annotations.csproj"
+          ],
+          "src": "../"
         }
-    ],
-    "build": {
-        "content": [
-            {
-                "files": [
-                    "api/**.yml",
-                    "api/index.md",
-                    "getting-started/**.md",
-                    "getting-started/**/toc.yml",
-                    "usage/**.md",
-                    "request-examples/**.md",
-                    "internals/**.md",
-                    "toc.yml",
-                    "*.md"
-                ],
-                "exclude": [
-                    "**/README.md"
-                ]
-            }
-        ],
-        "resource": [
-            {
-                "files": [ "diagrams/*.svg" ]
-            }
-        ],
-        "overwrite": [
-            {
-                "exclude": [ "obj/**", "_site/**" ]
-            }
-        ],
-        "dest": "_site",
-        "globalMetadataFiles": [],
-        "fileMetadataFiles": [],
-        "template": [ "default", "modern" ],
-        "postProcessors": [],
-        "noLangKeyword": false,
-        "keepFileLink": false,
-        "cleanupCacheHistory": false,
-        "disableGitFeatures": false
+      ],
+      "dest": "api",
+      "disableGitFeatures": false
     }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "api/**.yml",
+          "api/index.md",
+          "getting-started/**.md",
+          "getting-started/**/toc.yml",
+          "usage/**.md",
+          "request-examples/**.md",
+          "internals/**.md",
+          "toc.yml",
+          "*.md"
+        ],
+        "exclude": [
+          "**/README.md"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "diagrams/*.svg"
+        ]
+      }
+    ],
+    "overwrite": [
+      {
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "dest": "_site",
+    "globalMetadataFiles": [],
+    "fileMetadataFiles": [],
+    "template": [
+      "default",
+      "modern"
+    ],
+    "postProcessors": [],
+    "noLangKeyword": false,
+    "keepFileLink": false,
+    "cleanupCacheHistory": false,
+    "disableGitFeatures": false
+  }
 }