docs,ci: updated references to docs output

Author: DennisDyallo

.github/workflows/build.yml

@@ -90,14 +90,22 @@ jobs:
       - name: Build docs
         run: |
           dotnet tool install --global docfx --version "2.*"
-          docfx Yubico.YubiKey/src/docfx.json --logLevel warning
+          docfx docfx.json --logLevel warning --log docfx.log --warningsAsErrors
+
+      # Upload documentation log
+      - name: "Save build artifacts: Docs log"
+        uses: actions/upload-artifact@v4
+        with:
+          name: Documentation log
+          path: docfx.log
+          if-no-files-found: error
 
       # Upload documentation
       - name: "Save build artifacts: Docs"
         uses: actions/upload-artifact@v4
         with:
           name: Documentation
-          path: Yubico.YubiKey/docs/_site/
+          path: docs/_site/
           if-no-files-found: error
 
       # Upload NuGet packages

.github/workflows/upload-docs.yml

@@ -38,7 +38,7 @@ jobs:
       - uses: actions/download-artifact@v4
         with:
           name: Documentation
-          path: Yubico.YubiKey/docs/_site/
+          path: docs/_site/
 
       # Construct the docker image
       - name: Docker build

.vscode/tasks.json

@@ -160,11 +160,11 @@
     {
       "label": "Build DocFX Documentation",
       "type": "shell",
-      "command": "dotnet",
+      "command": "docfx",
       "args": [
-        "msbuild",
-        "${workspaceFolder}/Yubico.YubiKey/src/Yubico.YubiKey.csproj",
-        "/t:DocFXBuild",
+        "docfx.json",
+        "--log",
+        "docfx.log"
       ],
       "group": {
         "kind": "build",

contributordocs/README.md

@@ -21,7 +21,7 @@ source: https://github.com/dotnet/runtime/blob/71f9191846292b61a93de54a18bdcac38
 This repo includes several documents relevant to contributors, including coding guidelines, workflow, design docs,
 and helpful resources.
 
-For information about using the SDK, please refer to the [User's Manual](../Yubico.YubiKey/docs/users-manual/intro.md).
+For information about using the SDK, please refer to the [User's Manual](../docs/users-manual/intro.md).
 
 - [Getting started](./getting-started.md)
 - [Useful links](./useful-links.md)

contributordocs/documentation-system/building-docs-and-running.md

@@ -19,7 +19,7 @@ generates documentation from comments in the source code. The comments are writt
 format.
 
 In order to build the documentation, use either of the following methods: 
-1. Command Line: `docfx build Yubico.YubiKey/src/docfx.json`
+1. Command Line: `docfx build jdocfx.json`
 2. VS Code: Run the build task `DocFXBuild` using [VS Code Tasks](https://code.visualstudio.com/docs/editor/tasks) 
 
 > Note: In order to run `docfx` commands, you need to have docfx installed. Install `docfx` using the following command: `dotnet tool install -g docfx`

docfx.json

@@ -0,0 +1,81 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": ["Yubico.Core.csproj"],
+          "src": "./Yubico.Core/src/",
+          "exclude": ["**/bin/**", "**/obj/**"]
+        }
+      ],
+      "disableGitFeatures": true,
+      "disableDefaultFilter": false,
+      "memberLayout": "separatePages",
+      "filter": "./docs/filterConfig.yml",
+      "dest": "./docs/core-api",
+      "properties": {
+        "TargetFramework": "netstandard2.0"
+      }
+    },
+    {
+      "src": [
+        {
+          "files": ["Yubico.YubiKey.csproj"],
+          "src": "./Yubico.YubiKey/src/",
+          "exclude": ["**/bin/**", "**/obj/**"]
+        }
+      ],
+      "disableGitFeatures": true,
+      "disableDefaultFilter": false,
+      "memberLayout": "separatePages",
+      "filter": "./docs/filterConfig.yml",
+      "dest": "./docs/yubikey-api",
+      "properties": {
+        "TargetFramework": "netstandard2.0"
+      }
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "yubikey-api/**.yml",
+          "yubikey-api/index.md",
+          "core-api/**.yml",
+          "core-api/index.md",
+          "users-manual/**.md",
+          "users-manual/**/toc.yml",
+          "toc.yml",
+          "*.md"
+        ],
+        "src": "./docs/"
+      }
+    ],
+    "resource": [
+      {
+        "files": ["images/**"],
+        "src": "./docs/"
+      }
+    ],
+    "overwrite": [
+      {
+        "files": ["namespaces/**.md"],
+        "exclude": ["obj/**", "_site/**"],
+        "src": "./docs/"
+      }
+    ],
+    "dest": "./docs/_site/",
+    "globalMetadataFiles": [],
+    "globalMetadata": {
+      "_appFaviconPath": "images/favicon.ico"
+    },
+    "fileMetadataFiles": [],
+    "template": ["default", "./docs/memberpage", "./docs/yubikeysdk-template"],
+    "postProcessors": [],
+    "markdownEngineName": "markdig",
+    "noLangKeyword": false,
+    "keepFileLink": false,
+    "cleanupCacheHistory": false,
+    "disableGitFeatures": false
+  }
+}