slightly refreshed docs

Signed-off-by: Alexander Piskun <bigcat88@icloud.com>
Visionatrix · Aug 9, 2024 · 8fa3853 · 8fa3853
1 parent fed45a6
commit 8fa3853
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,8 @@ For any problems with Visionatrix or suggestions for improvement, go to the [mai
   - [Command Line Options](https://visionatrix.github.io/VixFlowsDocs/CommandLineOptions.html)
   - [Working modes](https://visionatrix.github.io/VixFlowsDocs/WorkingModes.html)
   - [Vix Workflows](https://visionatrix.github.io/VixFlowsDocs/VixWorkflows.html)
+  - [Creating Workflows](https://visionatrix.github.io/VixFlowsDocs/ComfyUI2VixMigration.html)
   - [Technical information](https://visionatrix.github.io/VixFlowsDocs/TechnicalInformation.html)
+  - [FAQ](https://visionatrix.github.io/VixFlowsDocs/FAQ.html)
   - [Hardware FAQ](https://visionatrix.github.io/VixFlowsDocs/HardwareFAQ.html)
   - [OpenAPI](https://visionatrix.github.io/VixFlowsDocs/swagger.html)
diff --git a/docs/ComfyUI2VixMigration.rst b/docs/ComfyUI2VixMigration.rst
@@ -79,7 +79,7 @@ In our workflows, we use some external nodes mapped as input params, that you ca
 3. Map the models for automatic download
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Visionatrix simiplifies and automates the process of downloading the models.
+Visionatrix simplifies and automates the process of downloading the models.
 As the third step of the migration, you need to map the models that are used in your workflow (see :ref:`models-mapping`).
 
 

diff --git a/docs/CommandLineOptions.rst b/docs/CommandLineOptions.rst
@@ -90,9 +90,9 @@ Can be used for Workers that do not have a user interface.
 
 .. code-block:: shell
 
-    python3 -m visionatrix install-flow --directory path_to_folder
+    python3 -m visionatrix install-flow --file path_to_json
 
-Folder should contain ``flow.json`` and ``flow_comfy.json``
+File should contain ComfyUI workflow with the `metadata <https://visionatrix.github.io/VixFlowsDocs/VixWorkflows.html#vix-workflow-overview>`_ needed for Visionatrix.
 
 .. code-block:: shell
 

diff --git a/docs/FAQ.rst b/docs/FAQ.rst
@@ -0,0 +1,4 @@
+FAQ
+===
+
+*Frequently asked question will be here*
diff --git a/docs/TechnicalInformation.rst b/docs/TechnicalInformation.rst
@@ -6,27 +6,28 @@ Bundled ComfyUI nodes
 
 Visionatrix by default install and update these nodes:
 
+ * `comfyui-art-venture <https://github.com/Visionatrix/comfyui-art-venture>`_
+ * `ComfyUI-AutoCropFaces <https://github.com/Visionatrix/ComfyUI-AutoCropFaces>`_
+ * `ComfyUI-BRIA_AI-RMBG <https://github.com/Visionatrix/ComfyUI-BRIA_AI-RMBG>`_
+ * `ComfyUI-Custom-Scripts <https://github.com/Visionatrix/ComfyUI-Custom-Scripts>`_
  * `ComfyUI-Impact-Pack <https://github.com/Visionatrix/ComfyUI-Impact-Pack>`_
+ * `comfyui-ollama <https://github.com/Visionatrix/comfyui-ollama>`_
+ * `ComfyUI-SUPIR <https://github.com/Visionatrix/ComfyUI-SUPIR>`_
+ * `ComfyUI-Visionatrix <https://github.com/Visionatrix/ComfyUI-Visionatrix>`_
+ * `ComfyUI-WD14-Tagger <https://github.com/Visionatrix/ComfyUI-WD14-Tagger>`_
+ * `comfyui_controlnet_aux <https://github.com/Visionatrix/comfyui_controlnet_aux>`_
+ * `ComfyUI_essentials <https://github.com/Visionatrix/ComfyUI_essentials>`_
+ * `ComfyUI_FizzNodes <https://github.com/Visionatrix/ComfyUI_FizzNodes>`_
+ * `ComfyUI_Gemini_Flash <https://github.com/Visionatrix/ComfyUI_Gemini_Flash>`_
  * `ComfyUI_InstantID <https://github.com/Visionatrix/ComfyUI_InstantID>`_
  * `ComfyUI_IPAdapter_plus <https://github.com/Visionatrix/ComfyUI_IPAdapter_plus>`_
- * `efficiency-nodes-comfyui <https://github.com/Visionatrix/efficiency-nodes-comfyui>`_
  * `ComfyUI_UltimateSDUpscale <https://github.com/Visionatrix/ComfyUI_UltimateSDUpscale>`_
- * `ComfyUI-WD14-Tagger <https://github.com/Visionatrix/ComfyUI-WD14-Tagger>`_
- * `ComfyUI-SUPIR <https://github.com/Visionatrix/ComfyUI-SUPIR>`_
- * `ComfyUI_essentials <https://github.com/Visionatrix/ComfyUI_essentials>`_
- * `ComfyUI-Custom-Scripts <https://github.com/Visionatrix/ComfyUI-Custom-Scripts>`_
+ * `efficiency-nodes-comfyui <https://github.com/Visionatrix/efficiency-nodes-comfyui>`_
+ * `PuLID_ComfyUI <https://github.com/Visionatrix/PuLID_ComfyUI>`_
  * `rgthree-comfy <https://github.com/Visionatrix/rgthree-comfy>`_
- * `comfyui_controlnet_aux <https://github.com/Visionatrix/comfyui_controlnet_aux>`_
  * `Skimmed_CFG <https://github.com/Visionatrix/Skimmed_CFG>`_
- * `comfyui-art-venture <https://github.com/Visionatrix/comfyui-art-venture>`_
- * `was-node-suite-comfyui <https://github.com/Visionatrix/was-node-suite-comfyui>`_
- * `ComfyUI-AutoCropFaces <https://github.com/Visionatrix/ComfyUI-AutoCropFaces>`_
- * `comfyui-ollama <https://github.com/Visionatrix/comfyui-ollama>`_
- * `PuLID_ComfyUI <https://github.com/Visionatrix/PuLID_ComfyUI>`_
- * `ComfyUI_FizzNodes <https://github.com/Visionatrix/ComfyUI_FizzNodes>`_
  * `style_aligned_comfy <https://github.com/Visionatrix/style_aligned_comfy>`_
- * `ComfyUI_Gemini_Flash <https://github.com/Visionatrix/ComfyUI_Gemini_Flash>`_
- * `ComfyUI-Visionatrix <https://github.com/Visionatrix/ComfyUI-Visionatrix>`_
+ * `was-node-suite-comfyui <https://github.com/Visionatrix/was-node-suite-comfyui>`_
 
 We are gradually expanding the list.
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -14,6 +14,7 @@ Here will leave all docs that is not suitable for Readme file.
     VixWorkflows.rst
     ComfyUI2VixMigration.rst
     TechnicalInformation.rst
+    FAQ.rst
     HardwareFAQ.rst
 
 

diff --git a/screenshots/logo.png b/screenshots/logo.png