From 13a5cfcaa31b3f6e2deb015ea49ef87d285cef7c Mon Sep 17 00:00:00 2001
From: Chris Wong <lambda.fairy@gmail.com>
Date: Sat, 30 Mar 2019 16:17:49 +1300
Subject: [PATCH] Document the documentation

[skip ci]
---
 docs/README.md | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 docs/README.md

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..ce76938
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,80 @@
+# Documentation
+
+This directory contains the documentation for Maud.
+
+## Build
+
+Build the documentation:
+
+    make
+
+The built files will be placed in `site/`.
+
+You can also delete the build artifacts with:
+
+    make clean
+
+## Watch
+
+To ease editing,
+there is a `./watch.sh` script
+that starts a web server
+and rebuilds the site
+on every change.
+
+The script uses Python 3 and [entr],
+but feel free to adapt it
+to your environment.
+
+[entr]: http://eradman.com/entrproject/
+
+## Add a new page
+
+The list of pages to be built
+is defined by the `slugs` variable
+in the Makefile.
+
+To add a new page,
+create a Markdown file in `content/`
+and add its name
+(excluding the `.md`)
+to `slugs`:
+
+```diff
+-slugs := index getting-started basic-syntax partials ...
++slugs := index getting-started basic-syntax my-awesome-new-page partials ...
+```
+
+The order of the names in `slugs`
+determines the order of entries
+in the table of contents.
+
+Make sure that
+your page starts with a heading
+(e.g. `# My awesome new page`)
+or it won't show up.
+
+## The navigation cache (`nav.json`)
+
+The site generator
+constructs the table of contents dynamically
+by reading each Markdown page
+and extracting its heading.
+This data is cached in `nav.json`.
+
+You don't need to care about this file
+most of the time,
+but it might be useful to know about it
+when hacking on the site generator itself.
+
+## Deployment
+
+The documentation is automatically built
+and uploaded to GitHub pages
+on every commit to `master`.
+
+However,
+if you wish to deploy the docs manually,
+then you can do that by running `./deploy.sh`.
+You will need push access to the Maud repository
+to do this.