Added readme for docs

atbe · atbe · commit 55c8f14bcc2a · 2021-11-29T13:17:27.000-05:00
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,21 @@
+# Documentation
+
+## Running Locally
+
+To run the documentation site locally, run this command:
+
+```bash
+$ make live-docs
+```
+
+Make sure you have a virutual environment setup, if you don't
+already you can set it up like this:
+
+```bash
+$ make init
+```
+
+## Deploying to production
+
+All documentation changes will automatically be deployed to production.
+So be sure that what you're pushing to `master` is inteded to be deployed.
