docs: Update DocFX config to use our README.

Signed-off-by: Philip Conrad <philipaconrad@gmail.com>
StyraInc · Apr 18, 2024 · 27a0fbb · 27a0fbb
1 parent 9abf74f
commit 27a0fbb
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/docs/docfx.json b/docs/docfx.json
@@ -8,6 +8,12 @@
         "files": [
           "**/*.{md,yml}"
         ]
+      },
+      {
+        "files": [
+          "README.md"
+        ],
+        "src": "../"
       }
     ],
     "globalMetadata": {
@@ -42,4 +48,4 @@
       ]
     }
   ]
-}
+}
diff --git a/docs/index.md b/docs/index.md
@@ -2,10 +2,4 @@
 _layout: landing
 ---
 
-# This is the **HOMEPAGE**.
-
-Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
-
-## Quick Start Notes:
-
-1. Add images to the *images* folder if the file is referencing an image.
+[!INCLUDE [](../README.md)]
diff --git a/docs/toc.yml b/docs/toc.yml
@@ -1,2 +1,2 @@
-- name: API
+- name: API Reference
   href: api/