[#1] base docs/index.md file

shizzard · Dec 19, 2018 · f4ce3b3 · f4ce3b3
1 parent f1387cb
commit f4ce3b3
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,9 @@
+# `cloak` documentation
+
+* [Compile-time options](compile-time-options.md): a set of options that may be used to change `cloak` behavior at compile-time
+* [Field types](field-types.md): description of different field types `cloak` supports
+* [Validators](validators.md): different ways to validate data with user-defined callbacks
+* [Exporters](exporters.md): different ways to export data with user-defined callbacks
+* [Substructures](substructures.md): explanation of nested data structures `cloak` supports
+* [Known issues](known-issues.md)
+* [Contributing](contributing.md)