build(docs): proper docs building

.github/workflows/docs.yml

@@ -24,7 +24,9 @@ jobs:
         run: dotnet tool install -g docfx
 
       - name: Generate Documentation
-        run: docfx build
+        run: |
+          docfx metadata
+          docfx build
 
       - name: Clean up _site folder
         run: |
@@ -45,7 +47,7 @@ jobs:
           git config --global user.email "github-actions[bot]@users.noreply.github.com"
           git checkout --orphan docs
           git --work-tree _site add --all
-          git --work-tree _site commit -m "Update documentation"
+          git --work-tree _site commit -m "docs: automatic update"
           git push https://github-actions:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }} HEAD:docs --force
 
       - name: Upload artifact

docfx.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
+  "metadata": [
+    {
+      "src": [
+        {
+          "src": "../Heir",
+          "files": [
+            "**/*.csproj"
+          ]
+        }
+      ],
+      "dest": "api"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "**/*.{md,yml}"
+        ],
+        "exclude": [
+          "_site/**"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "output": "_site",
+    "template": [
+      "default",
+      "modern"
+    ],
+    "globalMetadata": {
+      "_appName": "heir-docs",
+      "_appTitle": "heir-docs",
+      "_enableSearch": true,
+      "pdf": false
+    }
+  }
+}

docs/getting-started.md

@@ -0,0 +1,3 @@
+# Getting started
+
+TODO

docs/toc.yml

@@ -0,0 +1,2 @@
+- name: Getting Started
+  href: getting-started/

index.md

@@ -0,0 +1,6 @@
+---
+_layout: landing
+---
+
+# Heir Docs
+Welcome to the Heir docs!

toc.yml

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