Migrating documentation from docfx.console to docfx

Author: tpeczek

.github/workflows/ci.yml

@@ -6,6 +6,8 @@ on:
   pull_request:
     branches:
     - main
+permissions:
+  contents: read
 jobs:
   integration:
     runs-on: windows-latest

.github/workflows/codeql.yml

@@ -1,46 +1,39 @@
 name: DocFx
 on: workflow_dispatch
+permissions:
+  contents: read
+  pages: write
+  id-token: write
 jobs:
   build:
     runs-on: windows-latest
+    environment:
+      name: github-pages
     steps:
     - name: Checkout
-      uses: actions/checkout@v4
-    - name: Setup .NET 6.0 SDK
-      uses: actions/setup-dotnet@v4
-      with:
-        dotnet-version: '6.0.x'
-    - name: Setup .NET 7.0 SDK
-      uses: actions/setup-dotnet@v4
-      with:
-        dotnet-version: '7.0.x'
+      uses: actions/checkout@v6
     - name: Setup .NET 8.0 SDK
-      uses: actions/setup-dotnet@v4
+      uses: actions/setup-dotnet@v5
       with:
         dotnet-version: '8.0.x'
-    - name: Restore
-      run: dotnet restore
-    - name: Build
-      run: dotnet build --configuration Release --no-restore
-    - name: Upload Artifacts
-      uses: actions/upload-artifact@v4
+    - name: Setup .NET 9.0 SDK
+      uses: actions/setup-dotnet@v5
       with:
-        name: docfx
-        path: DocFx.AspNetCore.ServerSentEvents/wwwroot
-        retention-days: 1
-  publish:
-    needs: [build]
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout
-      uses: actions/checkout@v4
-    - name: Download Artifacts
-      uses: actions/download-artifact@v4
+        dotnet-version: '9.0.x'
+    - name: Setup .NET 10.0 SDK
+      uses: actions/setup-dotnet@v5
       with:
-        name: docfx
-        path: DocFx.AspNetCore.ServerSentEvents/wwwroot
-    - name: Publish
-      uses: JamesIves/[email protected]
+        dotnet-version: '10.0.x'
+    - name: Setup docfx
+      run: dotnet tool update -g docfx
+    - name: Restore .NET Projects
+      run: dotnet restore
+    - name: Build Documentation Artifact
+      run: docfx docs/docfx.json
+    - name: Upload Documentation Artifact
+      uses: actions/upload-pages-artifact@v4
       with:
-        branch: gh-pages
-        folder: DocFx.AspNetCore.ServerSentEvents/wwwroot
+        path: 'docs/_artifact'
+    - name: Deploy Documentation Artifact to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

.github/workflows/gh-pages.yml

@@ -28,9 +28,8 @@ bld/
 #wwwroot/
 
 # DocFX generated stuff
-DocFx.AspNetCore.ServerSentEvents/log.txt
-DocFx.AspNetCore.ServerSentEvents/api/
-DocFx.AspNetCore.ServerSentEvents/wwwroot/
+/docs/api
+/docs/_artifact
 
 # MSTest test Results
 [Tt]est[Rr]esult*/

.gitignore

@@ -5,8 +5,6 @@ VisualStudioVersion = 17.0.32014.148
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Lib.AspNetCore.ServerSentEvents", "Lib.AspNetCore.ServerSentEvents\Lib.AspNetCore.ServerSentEvents.csproj", "{A0373515-C536-4C8E-B7AD-5878F357556A}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DocFx.AspNetCore.ServerSentEvents", "DocFx.AspNetCore.ServerSentEvents\DocFx.AspNetCore.ServerSentEvents.csproj", "{10C3D8E6-BED2-4FBE-B1FE-1AB050B7AEC3}"
-EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Benchmark.AspNetCore.ServerSentEvents", "Benchmark.AspNetCore.ServerSentEvents\Benchmark.AspNetCore.ServerSentEvents.csproj", "{C502D468-F253-4574-917B-E31C6EFC28F6}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Test.AspNetCore.ServerSentEvents", "Test.AspNetCore.ServerSentEvents\Test.AspNetCore.ServerSentEvents.csproj", "{98E0FAC2-06DD-411B-9707-9EF46E322829}"