Update icons, use Makefile, remove warnings

Author: eiriktsarpalis

.config/dotnet-tools.json

@@ -0,0 +1,13 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "docfx": {
+      "version": "2.78.3",
+      "commands": [
+        "docfx"
+      ],
+      "rollForward": false
+    }
+  }
+}

.github/workflows/docs.yml

@@ -26,22 +26,18 @@ jobs:
       uses: actions/checkout@v3
 
     - name: .NET Setup
-      uses: actions/setup-dotnet@v3
+      uses: actions/setup-dotnet@v4
       with:
         dotnet-version: 9.x
 
-    - name: Restore .NET tools
-      run: dotnet tool restore
-      working-directory: ./docs
-
     - name: Generate documentation
       working-directory: ./docs
-      run: dotnet docfx docfx.json
+      run: make generate-docs
 
     - name: Upload Pages artifact
       uses: actions/upload-pages-artifact@v3
       with:
-        path: 'docs/_site'
+        path: 'artifacts/_site'
 
     - name: Deploy to GitHub Pages
       id: deployment

Makefile

@@ -0,0 +1,38 @@
+SOURCE_DIRECTORY := $(dir $(realpath $(lastword $(MAKEFILE_LIST))))
+ARTIFACT_PATH := $(SOURCE_DIRECTORY)artifacts
+DOCS_PATH := $(SOURCE_DIRECTORY)docs
+CONFIGURATION ?= Release
+
+clean:
+	dotnet clean
+	rm -rf $(ARTIFACT_PATH)/*
+	rm -rf $(DOCS_PATH)/api
+
+restore:
+	dotnet tool restore
+	dotnet restore
+
+build: restore
+	dotnet build --no-restore --configuration $(CONFIGURATION)
+
+test: build
+	dotnet test \
+		--no-build \
+		--configuration $(CONFIGURATION) \
+		--filter '(Execution!=Manual)' \
+		--blame \
+		--diag "$(ARTIFACT_PATH)/diag.txt" \
+		--logger "trx" \
+		--collect "Code Coverage;Format=cobertura" \
+		--results-directory $(ARTIFACT_PATH)/test-results \
+		-- \
+		RunConfiguration.CollectSourceInformation=true
+
+generate-docs: clean restore
+	dotnet build --no-restore --configuration Release
+	dotnet docfx $(DOCS_PATH)/docfx.json
+
+serve-docs: generate-docs
+	dotnet docfx serve $(ARTIFACT_PATH)/_site --port 8080
+
+.DEFAULT_GOAL := build

docs/docfx.json

@@ -10,7 +10,7 @@
           ]
         }
       ],
-      "dest": "api"
+      "output": "api"
     }
   ],
   "build": {
@@ -31,18 +31,18 @@
         ]
       }
     ],
-    "output": "_site",
+    "output": "../artifacts/_site",
     "template": [
       "default",
       "modern"
     ],
     "globalMetadata": {
       "_appName": "MCP C# SDK",
       "_appTitle": "MCP C# SDK",
-      "_enableSearch": true,
-      "pdf": true,
       "_appLogoPath": "images/mcp.svg",
-      "_appFaviconPath": "images/favicon.ico"  
+      "_appFaviconPath": "images/favicon.ico",
+      "_enableSearch": true,
+      "pdf": false
     }
   }
 }

docs/dotnet-tools.json

@@ -2,8 +2,22 @@
 _layout: landing
 ---
 
-# Model Context Protocol (MCP) .NET SDK
+# Overview
 
-Welcome to the API documentation for the MCP C# SDK. [Explore the API](https://aka.ms/mcp/dotnet).
+The official C# SDK for the [Model Context Protocol](https://modelcontextprotocol.io/), enabling .NET applications, services, and libraries to implement and interact with MCP clients and servers. Please visit our [API documentation](api/ModelContextProtocol.yml) for more details on available functionality.
+
+## About MCP
+
+The Model Context Protocol (MCP) is an open protocol that standardizes how applications provide context to Large Language Models (LLMs). It enables secure integration between LLMs and various data sources and tools.
+
+For more information about MCP:
+
+- [Official Documentation](https://modelcontextprotocol.io/)
+- [Protocol Specification](https://spec.modelcontextprotocol.io/)
+- [GitHub Organization](https://github.com/modelcontextprotocol)
 
 For how-to guides, tutorials, and additional guidance, refer to the [official MCP documentation](https://modelcontextprotocol.io/).
+
+## License
+
+This project is licensed under the [MIT License](https://github.com/modelcontextprotocol/csharp-sdk/blob/main/LICENSE).

docs/images/favicon.ico

@@ -1,4 +1,5 @@
-- name: Home
-  href: /index
+items:
 - name: API Docs
-  href: api/
+  href: api/ModelContextProtocol.yml
+- name: Github
+  href: https://github.com/ModelContextProtocol/csharp-sdk