From a7bbd57f6b33c0f8b02a7002b28c89b47bd8f9a0 Mon Sep 17 00:00:00 2001
From: Pacman99 <pachum99@gmail.com>
Date: Fri, 26 Mar 2021 22:29:07 -0700
Subject: [PATCH] doc: init mkFlakeOptions.md generated mkFlake options
 documentation

---
 doc/mkFlakeOptions.md | 148 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 148 insertions(+)
 create mode 100644 doc/mkFlakeOptions.md

diff --git a/doc/mkFlakeOptions.md b/doc/mkFlakeOptions.md
new file mode 100644
index 000000000..c9f7088f1
--- /dev/null
+++ b/doc/mkFlakeOptions.md
@@ -0,0 +1,148 @@
+## extern
+Function with argument 'inputs' with all devos and this flake's inputs.
+The function should return an attribute set with modules, overlays, and
+specialArgs to be included across devos
+
+
+*_Type_*:
+function that evaluates to a(n) attrs
+
+*_Default_*
+```
+"${self}/extern"
+```
+
+
+## hosts
+Path to directory containing host configurations
+
+*_Type_*:
+path
+
+*_Default_*
+```
+"${self}/hosts"
+```
+
+
+## modules
+list of modules to include in confgurations
+
+*_Type_*:
+list of anythings
+
+*_Default_*
+```
+"${self}/modules/module-list.nix"
+```
+
+
+## overlays
+path to folder containing overlays which will be applied to pkgs
+
+*_Type_*:
+path
+
+*_Default_*
+```
+"${self}/overlays"
+```
+
+
+## overrides
+attrset of packages and modules that will be pulled from nixpkgs master
+
+*_Type_*:
+attribute set
+
+*_Default_*
+```
+"${self}/overrides"
+```
+
+
+## packages
+Overlay for custom packages that will be included in treewide 'pkgs'.
+This should follow the standard nixpkgs overlay format - two argument function
+that returns an attrset.
+
+
+*_Type_*:
+Nixpkgs overlay
+
+*_Default_*
+```
+"${self}/pkgs"
+```
+
+
+## profiles
+path to profiles folder
+
+*_Type_*:
+path
+
+*_Default_*
+```
+"${self}/profiles"
+```
+
+
+## self
+The flake to create the devos outputs for
+
+*_Type_*:
+attribute set
+
+
+
+## suites
+function with inputs 'users' and 'profiles' that returns attribute 'system'
+which defines suites passed to configurations as the suites specialArg
+
+
+*_Type_*:
+function that evaluates to a(n) attrs
+
+*_Default_*
+```
+"${self}/suites"
+```
+
+
+## userModules
+list of modules to include in home-manager configurations
+
+*_Type_*:
+list of anythings
+
+*_Default_*
+```
+"${self}/users/modules/module-list.nix"
+```
+
+
+## userProfiles
+path to user profiles folder
+
+*_Type_*:
+path
+
+*_Default_*
+```
+"${self}/users/profiles"
+```
+
+
+## users
+path to folder containing user profiles
+
+*_Type_*:
+path
+
+*_Default_*
+```
+"${self}/users"
+```
+
+