Feat: docs: ideas

3 files changed, 17 insertions, 15 deletions

diff --git a/IDEAS.md b/IDEAS.md
deleted file mode 100644
index 7b93d01..0000000
--- a/IDEAS.md
+++ /dev/null
@@ -1,15 +0,0 @@
-Ideas
-=====
-
-* hydractl:
-  * mount-kvmx-supervised: open encrypted volumes from supervised guests.
-* hydra:
-  * newkeys:
-    * generate `luks/root` keys if guest VM.
-  * deploy:
-    * script deployment support:
-      * any language is supported.
-      * folder structure like `$HYDRA_FOLDER/tasks/{conf/$task/hosts,stages/{pre,post,main}/$task}`.
-      * disable a task script by removing it's file exec flag.
-    * run mount-kvmx-supervised on remote, ensuring all supervised VMs have their images available
-      before applying the puppet catalog.
diff --git a/docs/ideas.md b/docs/ideas.md
new file mode 100644
index 0000000..7c96301
--- /dev/null
+++ b/docs/ideas.md
@@ -0,0 +1,16 @@
+# Ideas
+
+* `hydractl`:
+  * `mount-kvmx-supervised`: open encrypted volumes from supervised [kvmx][] guests.
+* `hydra`:
+  * `newkeys`:
+    * generate `luks/root` keys if guest VM.
+  * `deploy`:
+    * for for tasks / scripted deployment:
+      * any language is supported.
+      * folder structure like `$HYDRA_FOLDER/tasks/{conf/$task/hosts,stages/{pre,post,main}/$task}`.
+      * disable a task script by removing it's file exec flag.
+    * run `mount-kvmx-supervised` on remote, ensuring all supervised VMs have their images available
+      before applying the puppet catalog.
+
+[kvmx]: https://git.fluxo.info/kvmx/about/
diff --git a/mkdocs.yml b/mkdocs.yml
index 007171c..9929a04 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -11,3 +11,4 @@ nav:
   - management.md
   - tpc.md
   - backups.md
+  - ideas.md