start docs for testing lib

dymmond · Jan 17, 2025 · 1655899 · 1655899
1 parent 810134c
commit 1655899
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 1 deletion.
diff --git a/docs/testing/index.md b/docs/testing/index.md
@@ -0,0 +1,6 @@
+# Testing
+
+Edgy provides two testing facilities:
+
+- A [Testclient](test-client.md), which has some testing-only methods and parameters.
+- A faker based ModelFactory [ModelFactory](./model-factory.md)
diff --git a/docs/testing/model-factory.md b/docs/testing/model-factory.md
@@ -0,0 +1 @@
+# ModelFactory
diff --git a/docs/test-client.md → docs/testing/test-client.md b/docs/test-client.md → docs/testing/test-client.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -115,7 +115,10 @@ nav:
       - Exceptions: "exceptions.md"
       - Tips and Tricks: "tips-and-tricks.md"
       - Extensions: "extensions.md"
-      - Test Client: "test-client.md"
+    Testing:
+      - "testing/index.md"
+      - Test Client: "testing/test-client.md"
+      - Model Factory: "testing/model-factory.md"
   - API Reference:
       - "references/index.md"
       - Model: "references/models.md"