From 88e62440758c6a5d498be0a55180a77d9cd01bdd Mon Sep 17 00:00:00 2001
From: Chris Johnston <chris@thejohnstons.net>
Date: Sat, 24 Mar 2018 09:28:50 -0700
Subject: [PATCH] Add release version to docs footer, Add doc build
 instructions (#963)

* Add guide for building the docs

* Add version to the footer of the docs

* fix links for readme

* change formatting of doc build readme

* proper capitalization of DocFX in readme

* Remove code tags around version
---
 docs/README.md  | 16 ++++++++++++++++
 docs/docfx.json |  4 ++--
 2 files changed, 18 insertions(+), 2 deletions(-)
 create mode 100644 docs/README.md

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000000..a672330d46
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,16 @@
+# Instructions for Building Documentation
+
+The documentation for the Discord.NET library uses [DocFX][docfx-main]. [Instructions for installing this tool can be found here.][docfx-installing]
+
+1. Navigate to the root of the repository.
+2. (Optional) If you intend to target a specific version, ensure that you
+have the correct version checked out.
+3. Build the library. Run `dotnet build` in the root of this repository.
+ Ensure that the build passes without errors.
+4. Build the docs using `docfx .\docs\docfx.json`. Add the `--serve` parameter
+to preview the site locally. Some elements of the page may appear incorrect
+when not hosted by a server.
+      - Remarks: According to the docfx website, this tool does work on Linux under mono.
+
+[docfx-main]: https://dotnet.github.io/docfx/
+[docfx-installing]: https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
diff --git a/docs/docfx.json b/docs/docfx.json
index 3c0b0611e8..50ae390926 100644
--- a/docs/docfx.json
+++ b/docs/docfx.json
@@ -67,8 +67,8 @@
       "default"
     ],
     "globalMetadata": {
-      "_appFooter": "Discord.Net (c) 2015-2017"
+      "_appFooter": "Discord.Net (c) 2015-2018 2.0.0-beta"
     },
     "noLangKeyword": false
   }
-}
\ No newline at end of file
+}