docs(configurations): add path and project configurations with init, …

…task, batch, and test files included
entelecheia · Jun 27, 2023 · f0aa8a6 · f0aa8a6
1 parent f0af38a
commit f0aa8a6
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/docs/configs/path.md b/docs/configs/path.md
@@ -0,0 +1,19 @@
+# Path Configurations
+
+## `__init__.yaml`
+
+```yaml
+{% include "../../src/hyfi/conf/path/__init__.yaml" %}
+```
+
+## `__task__.yaml`
+
+```yaml
+{% include "../../src/hyfi/conf/path/__task__.yaml" %}
+```
+
+## `__batch__.yaml`
+
+```yaml
+{% include "../../src/hyfi/conf/path/__batch__.yaml" %}
+```
diff --git a/docs/configs/project.md b/docs/configs/project.md
@@ -0,0 +1,13 @@
+# Project Configurations
+
+## `__init__.yaml`
+
+```yaml
+{% include "../../src/hyfi/conf/project/__init__.yaml" %}
+```
+
+## `__test__.yaml`
+
+```yaml
+{% include "../../src/hyfi/conf/project/__test__.yaml" %}
+```