feat: Docfx implementation added

.github/workflows/bepu-docs-github.yml

@@ -0,0 +1,41 @@
+# More GitHub Actions for Azure: https://github.com/Azure/actions
+
+name: Build Bepu Docs for GitHub Pages
+
+env:
+  COMMON_SETTINGS_PATH: Documentation/docfx.json
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish-docs:
+    runs-on: windows-latest
+
+    steps:
+    - name: .NET SDK Setup
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 9.x
+
+    - name: Checkout Bepu
+      uses: actions/checkout@v4
+
+    - name: Install DocFX
+      # This installs the latest version of DocFX and may introduce breaking changes
+      # run: dotnet tool update -g docfx
+      # This installs a specific, tested version of DocFX.
+      run: dotnet tool update -g docfx --version 2.78.2
+
+    - name: Build Bepu API Docs
+      run: docfx metadata ${{ env.COMMON_SETTINGS_PATH }}
+
+    - name: Build Bepu Docs
+      run: docfx build ${{ env.COMMON_SETTINGS_PATH }}
+
+    - name: Deploy
+      uses: peaceiris/[email protected]
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ${{ env.COMMON_SETTINGS_PATH }}/_site
+        publish_branch: gh-pages

.gitignore

@@ -208,3 +208,7 @@ ModelManifest.xml
 
 # JetBrains Rider
 .idea/
+
+# DocFX API Generated Pages
+Documentation/api/*
+Documentation/_site/*

Documentation/docfx.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
+  "metadata": [
+    {
+      "src": [
+        {
+          "src": "..",
+          "files": [
+            "BepuPhysics/BepuPhysics.csproj",
+            "BepuPhysics/BepuUtilities.csproj"
+          ]
+        }
+      ],
+      "dest": "api"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "**/*.{md,yml}"
+        ],
+        "exclude": [
+          "_site/**"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "favicon.ico",
+          "favicon.png",
+          "images/**"
+        ]
+      }
+    ],
+    "output": "_site",
+    "template": [
+      "default",
+      "modern",
+      "template"
+    ],
+    "fileMetadata": {
+      "_appTitle": {
+        "api/**/*.md": "Bepu API",
+        "api/**/*.yml": "Bepu API"
+      }
+    },
+    "globalMetadata": {
+      "_appName": "",
+      "_appTitle": "Bepu Docs",
+      "_appLogoPath": "images/bepuphysicslogo256.png",
+      "_enableSearch": true,
+      "pdf": false
+    }
+  }
+}

Documentation/docs/toc.yml

@@ -0,0 +1,4 @@
+- name: Getting Started
+  href: ../GettingStarted.md
+- name: Building
+  href: ../Building.md

Documentation/index.md

@@ -0,0 +1,25 @@
+---
+_disableToc: false
+---
+
+# Quick Start
+
+The BepuPhysics and BepuUtilities libraries target .NET 8 and should work on any supported platform.
+
+The physics engine heavily uses `System.Numerics.Vectors` types, so to get good performance, you'll need a compiler which can consume those types (like RyuJIT).
+
+## Features
+
+- Spheres, capsules, boxes, triangles, cylinders, and convex hulls
+- Compounds of the above
+- Meshes
+- A [whole bunch of constraint types](BepuPhysics/Constraints/)
+- [Newts](Demos/Demos/NewtDemo.cs)
+- Linear and angular continuous collision detection
+- Extremely low cost sleep states for resting bodies
+- Efficient scene-wide ray and sweep queries
+- [Character controller example](Demos/Demos/Characters/CharacterDemo.cs)
+- At least somewhat extensible collision pipeline, with [example custom voxel collidable](Demos/Demos/CustomVoxelCollidableDemo.cs)
+- Highly nonidiomatic APIs
+- Super speediness
+- And a bunch of other miscellaneous stuff!

Documentation/template/public/main.css

@@ -0,0 +1,5 @@
+/* Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License.txt in the project root for license information. */
+
+.navbar-brand #logo {
+    height: 56px;
+}

Documentation/template/public/main.js

@@ -0,0 +1,17 @@
+const app = {
+    languageDropdownCreated: false,
+    iconLinks: [
+        {
+            icon: 'github',
+            href: 'https://github.com/bepu/bepuphysics2',
+            title: 'GitHub'
+        },
+        {
+            icon: 'discord',
+            href: 'https://discord.gg/ssa2XpY',
+            title: 'Discord'
+        }
+    ]
+};
+
+export default app;

Documentation/toc.yml

@@ -0,0 +1,4 @@
+- name: Docs
+  href: docs/
+- name: API
+  href: api/