From ce33ebdbd8bc4c6ae53166402ac2ddc5314b2a7b Mon Sep 17 00:00:00 2001
From: Melefo <melefo@melefo.xyz>
Date: Fri, 12 Nov 2021 14:06:51 +0100
Subject: [PATCH] Better docs

---
 docs/.gitignore        |   9 ++++
 docs/api/.gitignore    |   5 ++
 docs/api/index.md      |   2 +
 docs/articles/intro.md |   1 +
 docs/articles/toc.yml  |   2 +
 docs/docfx.json        | 104 ++++++++++++++++++++++++-----------------
 docs/filter.yml        |   3 +-
 docs/index.md          |   4 ++
 docs/toc.yml           |   5 ++
 9 files changed, 92 insertions(+), 43 deletions(-)
 create mode 100644 docs/.gitignore
 create mode 100644 docs/api/.gitignore
 create mode 100644 docs/api/index.md
 create mode 100644 docs/articles/intro.md
 create mode 100644 docs/articles/toc.yml
 create mode 100644 docs/index.md
 create mode 100644 docs/toc.yml

diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 0000000..4378419
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,9 @@
+###############
+#    folder   #
+###############
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_site
diff --git a/docs/api/.gitignore b/docs/api/.gitignore
new file mode 100644
index 0000000..e8079a3
--- /dev/null
+++ b/docs/api/.gitignore
@@ -0,0 +1,5 @@
+###############
+#  temp file  #
+###############
+*.yml
+.manifest
diff --git a/docs/api/index.md b/docs/api/index.md
new file mode 100644
index 0000000..78dc9c0
--- /dev/null
+++ b/docs/api/index.md
@@ -0,0 +1,2 @@
+# PLACEHOLDER
+TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!
diff --git a/docs/articles/intro.md b/docs/articles/intro.md
new file mode 100644
index 0000000..c0478ce
--- /dev/null
+++ b/docs/articles/intro.md
@@ -0,0 +1 @@
+# Add your introductions here!
diff --git a/docs/articles/toc.yml b/docs/articles/toc.yml
new file mode 100644
index 0000000..ff89ef1
--- /dev/null
+++ b/docs/articles/toc.yml
@@ -0,0 +1,2 @@
+- name: Introduction
+  href: intro.md
diff --git a/docs/docfx.json b/docs/docfx.json
index 0812ef6..a0aacb5 100644
--- a/docs/docfx.json
+++ b/docs/docfx.json
@@ -1,46 +1,66 @@
 {
-    "metadata": [{
-        "src": [{
-            "files": [
-                "**.csproj"
-            ]
-        }],
-        "dest": "api",
-        "filter": "filter.yml"
-    }],
-    "build": {
-        "content": [{
-            "files": ["api/**.yml", "api/index.md"]
-          },
-          {
-            "files": ["toc.yml", "index.md"]
-          },
-          {
-            "files": ["faq/**.md", "faq/**/toc.yml"]
-          },
-          {
-            "files": ["guides/**.md", "guides/**/toc.yml"]
-          }
-        ],
-        "resource": [],
-        "dest": "_site",
-        "template": [
-            "default",
-            "_template/light-dark-theme",
-            "_template/last-modified",
-            "_template/description-generator"
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "**.csproj"
+          ],
+          "src": ".."
+        }
+      ],
+      "dest": "api",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "filter": "filter.yml"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "api/**.yml",
+          "api/index.md"
+        ]
+      },
+      {
+        "files": [
+          "articles/**.md",
+          "articles/**/toc.yml",
+          "toc.yml",
+          "*.md"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "overwrite": [
+      {
+        "files": [
+          "apidoc/**.md"
         ],
-        "postProcessors": ["ExtractSearchIndex", "LastModifiedPostProcessor", "DescriptionPostProcessor"],
-        "overwrite": "_overwrites/**/**.md",
-        "globalMetadata": {
-        "_appTitle": "Doshboard Documentation",
-        "_appFooter": "Melefo Halfa (c) 2021-2021 1.0.0",
-        "_enableSearch": true,
-        "_appLogoPath": "doshboard.svg",
-        "_appFaviconPath":  "favicon.ico"
-        },
-        "xrefService": [
-        "https://xref.docs.microsoft.com/query?uid={uid}"
+        "exclude": [
+          "obj/**",
+          "_site/**"
         ]
-    }
+      }
+    ],
+    "dest": "_site",
+    "globalMetadataFiles": [],
+    "fileMetadataFiles": [],
+    "template": [
+      "default"
+    ],
+    "postProcessors": [],
+    "markdownEngineName": "markdig",
+    "noLangKeyword": false,
+    "keepFileLink": false,
+    "cleanupCacheHistory": false,
+    "disableGitFeatures": false
+  }
 }
\ No newline at end of file
diff --git a/docs/filter.yml b/docs/filter.yml
index 164bb58..2b51ed4 100644
--- a/docs/filter.yml
+++ b/docs/filter.yml
@@ -1,4 +1,5 @@
+
 apiRules:
-  - exclude:
+- exclude:
     uidRegex: ^Doshboard\.Test$
     type: Namespace
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..3ae2506
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,4 @@
+# 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.
diff --git a/docs/toc.yml b/docs/toc.yml
new file mode 100644
index 0000000..59f8010
--- /dev/null
+++ b/docs/toc.yml
@@ -0,0 +1,5 @@
+- name: Articles
+  href: articles/
+- name: Api Documentation
+  href: api/
+  homepage: api/index.md