Add mkdocs-material documentation

1 files changed, 13 insertions, 0 deletions

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..cbef50e
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,13 @@
+# Project Documentation
+
+This directory contains the mkdocs configuration and markdown files for the
+PyDis DevOps documentation.
+
+To work on these files, install the docs dependencies with `poetry install
+--with docs` in the root folder.
+
+You can work locally on the site by navigating to the root directory and running
+`poetry run task serve-docs` which will start a local server with live
+reloading. You can also run `poetry run task build-docs` in the root to build a
+local copy of the documentation, which will be placed in the `docs/site` folder
+(`site` folder of this directory).