From 5b9eadc165601eb2f4687d02f8d3552324f39bcb Mon Sep 17 00:00:00 2001
From: doctorpangloss <@hiddenswitch.com>
Date: Tue, 21 May 2024 11:38:20 -0700
Subject: [PATCH] WIP documentation work

---
 CODEOWNERS                                    |   1 +
 README.md                                     |   9 +++--
 .../assets/comfyui_screenshot.png             | Bin
 .../configuration/extra_model_paths.yaml      |  31 +++++++++---------
 .../script_examples}/basic_api_example.py     |   0
 .../script_examples}/remote_api_example.py    |   0
 6 files changed, 23 insertions(+), 18 deletions(-)
 rename comfyui_screenshot.png => docs/assets/comfyui_screenshot.png (100%)
 rename extra_model_paths.yaml.example => docs/examples/configuration/extra_model_paths.yaml (64%)
 rename {script_examples => docs/examples/script_examples}/basic_api_example.py (100%)
 rename {script_examples => docs/examples/script_examples}/remote_api_example.py (100%)

diff --git a/CODEOWNERS b/CODEOWNERS
index 7c7c3e19e..6a2b04eb1 100644
--- a/CODEOWNERS
+++ b/CODEOWNERS
@@ -1 +1,2 @@
 *       @comfyanonymous
+*       @doctorpangloss
\ No newline at end of file
diff --git a/README.md b/README.md
index 45080db41..745567895 100644
--- a/README.md
+++ b/README.md
@@ -477,6 +477,11 @@ The default installation includes a fast latent preview method that's low-resolu
 
 Ctrl can also be replaced with Cmd instead for macOS users
 
+# Configuration
+
+## Extra Model Paths
+
+
 ### Command Line Arguments
 
 ```
@@ -706,7 +711,7 @@ async with EmbeddedComfyClient() as client:
 # At this point, all the models have been unloaded from VRAM, and everything has been cleaned up.
 ```
 
-See [script_examples/basic_api_example.py](script_examples/basic_api_example.py) for a complete example.
+See [script_examples/basic_api_example.py](docs/examples/script_examples/basic_api_example.py) for a complete example.
 
 ### Remote
 
@@ -722,7 +727,7 @@ with open("image.png", "rb") as f:
     f.write(png_image_bytes)
 ```
 
-See [script_examples/remote_api_example.py](script_examples/remote_api_example.py) for a complete example.
+See [script_examples/remote_api_example.py](docs/examples/script_examples/remote_api_example.py) for a complete example.
 
 ### OpenAPI Spec for Vanilla API, Typed Clients
 
diff --git a/comfyui_screenshot.png b/docs/assets/comfyui_screenshot.png
similarity index 100%
rename from comfyui_screenshot.png
rename to docs/assets/comfyui_screenshot.png
diff --git a/extra_model_paths.yaml.example b/docs/examples/configuration/extra_model_paths.yaml
similarity index 64%
rename from extra_model_paths.yaml.example
rename to docs/examples/configuration/extra_model_paths.yaml
index 846d04dbe..5d627df38 100644
--- a/extra_model_paths.yaml.example
+++ b/docs/examples/configuration/extra_model_paths.yaml
@@ -3,22 +3,21 @@
 
 #config for a1111 ui
 #all you have to do is change the base_path to where yours is installed
-a111:
-    base_path: path/to/stable-diffusion-webui/
-
-    checkpoints: models/Stable-diffusion
-    configs: models/Stable-diffusion
-    vae: models/VAE
-    loras: |
-         models/Lora
-         models/LyCORIS
-    upscale_models: |
-                  models/ESRGAN
-                  models/RealESRGAN
-                  models/SwinIR
-    embeddings: embeddings
-    hypernetworks: models/hypernetworks
-    controlnet: models/ControlNet
+a1111:
+  base_path: path/to/stable-diffusion-webui/
+  checkpoints: models/Stable-diffusion
+  configs: models/Stable-diffusion
+  vae: models/VAE
+  loras: |
+    models/Lora
+    models/LyCORIS
+  upscale_models: |
+    models/ESRGAN
+    models/RealESRGAN
+    models/SwinIR
+  embeddings: embeddings
+  hypernetworks: models/hypernetworks
+  controlnet: models/ControlNet
 
 #config for comfyui
 #your base path should be either an existing comfy install or a central folder where you store all of your models, loras, etc.
diff --git a/script_examples/basic_api_example.py b/docs/examples/script_examples/basic_api_example.py
similarity index 100%
rename from script_examples/basic_api_example.py
rename to docs/examples/script_examples/basic_api_example.py
diff --git a/script_examples/remote_api_example.py b/docs/examples/script_examples/remote_api_example.py
similarity index 100%
rename from script_examples/remote_api_example.py
rename to docs/examples/script_examples/remote_api_example.py