Increase readability.

Nourepide · Nov 25, 2023 · a93c521 · a93c521
1 parent 3857d35
commit a93c521
Show file tree

Hide file tree

Showing 9 changed files with 266 additions and 11 deletions.
diff --git a/Writerside/cfg/buildprofiles.xml b/Writerside/cfg/buildprofiles.xml
@@ -0,0 +1,7 @@
+<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
+               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <variables>
+        <primary-color>iris</primary-color>
+    </variables>
+    <build-profile instance="allor-doc"/>
+</buildprofiles>
diff --git a/Writerside/images/icons/download.svg b/Writerside/images/icons/download.svg
diff --git a/Writerside/images/icons/palette.svg b/Writerside/images/icons/palette.svg
diff --git a/Writerside/images/icons/question.svg b/Writerside/images/icons/question.svg
diff --git a/Writerside/images/icons/tune.svg b/Writerside/images/icons/tune.svg
diff --git a/Writerside/images/icons/update.svg b/Writerside/images/icons/update.svg
diff --git a/Writerside/topics/Allor-Doc.md b/Writerside/topics/Allor-Doc.md
@@ -12,10 +12,40 @@
 
 - **Batch Processing**: Have multiple images to process? No problem. Allor can handle batch image processing with ease.
 
-- **Versatile Modules**: With over 100+ nodes spread across various modules, Allor is equipped to handle a wide range of tasks.
+- **Versatile Modules**: With over 100+ nodes spread across various modules, Allor is equipped to handle a wide range of
+  tasks.
 
-- **Customizable**: Tailor Allor to your needs. From modules to fonts, you have the freedom to configure it as you see fit.
+- **Customizable**: Tailor Allor to your needs. From modules to fonts, you have the freedom to configure it as you see
+  fit.
 
 - **Self-Updating**: To provide you with the latest features and improvements, Allor has the ability to update itself.
 
-Now you are ready for Installing stage.
+<procedure>
+  <img src="download.svg" alt="installation" style="block" width="46"/>
+  <a href="Installation.md"/>
+  <p>Dive into the installation process of Allor on ComfyUI.</p>
+</procedure>
+
+<procedure>
+  <img src="update.svg" alt="installation" style="block" width="46"/>
+  <a href="Updating.md"/>
+  <p>Stay ahead with the latest features and updates.</p>
+</procedure>
+
+<procedure>
+  <img src="tune.svg" alt="installation" style="block" width="46"/>
+  <a href="Configuration.md"/>
+  <p>Tailor Allor to your needs for a truly personalized experience.</p>
+</procedure>
+
+<procedure>
+  <img src="palette.svg" alt="installation" style="block" width="46"/>
+  <a href="Modules.md"/>
+  <p>Harness the full power that Allor has to offer.</p>
+</procedure>
+
+<procedure>
+  <img src="question.svg" alt="installation" style="block" width="46"/>
+  <a href="FAQ.md">Frequently Asked Questions</a>
+  <p>Find answers to your burning questions in our FAQ section.</p>
+</procedure>
diff --git a/Writerside/topics/Installation.md b/Writerside/topics/Installation.md
@@ -5,6 +5,7 @@
 > {style="note"}
 
 ## Requirements
+
 * ComfyUI
 * Python 3.10 or above
 
@@ -18,33 +19,42 @@ manager.
 <tabs group="installing">
 <tab title="Installation for Unix" group-key="unix">
 
-1. **Download Allor**: Download the [Allor ZIP archive](https://github.com/Nourepide/ComfyUI-Allor/archive/refs/heads/main.zip).
+<procedure>
 
+1. **Download Allor**: Download
+   the [Allor ZIP archive](https://github.com/Nourepide/ComfyUI-Allor/archive/refs/heads/main.zip).
 2. **Unzip the Archive**: Unzip the downloaded archive to the `ComfyUI/custom_nodes` directory.
-
-3. **Run the Installation Script**: Execute the `install.sh` file. You can do this from the terminal with the following command:
+3. **Run the Installation Script**: Execute the `install.sh` file. You can do this from the terminal with the following
+   command:
 
     ```bash
     bash install.sh
     ```
-
 4. **Run ComfyUI**: Finally, run ComfyUI.
 
+</procedure>
+
 </tab>
 <tab title="Installation for Windows" group-key="windows">
 
-1. **Download Allor**: Download the [Allor ZIP archive](https://github.com/Nourepide/ComfyUI-Allor/archive/refs/heads/main.zip).
+<procedure>
+
+1. **Download Allor**: Download
+   the [Allor ZIP archive](https://github.com/Nourepide/ComfyUI-Allor/archive/refs/heads/main.zip).
 
 2. **Unzip the Archive**: Unzip the downloaded archive to the `ComfyUI\custom_nodes` directory.
 
-3. **Run the Installation Script**: Execute the `install.bat` file. You can do this from the command prompt with the following command or just click on it:
+3. **Run the Installation Script**: Execute the `install.bat` file. You can do this from the command prompt with the
+   following command or just click on it:
 
     ```bash
     install.bat
     ```
 
 4. **Run ComfyUI**: Finally, run ComfyUI.
 
+</procedure>
+
 </tab>
 </tabs>
 
@@ -53,6 +63,8 @@ manager.
 <tabs group="installing">
 <tab title="Installation for Unix" group-key="unix">
 
+<procedure>
+
 1. **Open Terminal**: Navigate to the `ComfyUI/custom_nodes` directory. You can do this by opening Terminal and using
    the `cd` command.
 
@@ -76,9 +88,13 @@ manager.
 
 5. **Run ComfyUI**: Finally, run ComfyUI.
 
+</procedure>
+
 </tab>
 <tab title="Installation for Windows" group-key="windows">
 
+<procedure>
+
 1. **Open Command Prompt**: Navigate to the `ComfyUI\custom_nodes` folder. You can do this by pressing <shortcut>
    Win+R</shortcut>, typing `cmd`, and pressing <shortcut>Enter</shortcut>.
 
@@ -102,16 +118,20 @@ manager.
 
 5. **Run ComfyUI**: Finally, run ComfyUI.
 
+</procedure>
+
 </tab>
 </tabs>
 
 ## What does the installation script do?
 
 1. **Searches for the virtual environment**: The script checks for a Python virtual environment.
 
-2. **Installs dependencies**: If a `requirements.txt` file exists in the current directory, the script installs the dependencies listed in it.
+2. **Installs dependencies**: If a `requirements.txt` file exists in the current directory, the script installs the
+   dependencies listed in it.
 
-3. **Initializes a Git repository**: If Git is installed and the current directory is not already a Git repository, the script initializes a new Git repository and syncs it with a remote repository.
+3. **Initializes a Git repository**: If Git is installed and the current directory is not already a Git repository, the
+   script initializes a new Git repository and syncs it with a remote repository.
 
 4. **Uses GitPython**: If Git is not installed, the script uses GitPython, a Python library, to perform Git operations.
 

diff --git a/Writerside/topics/Updating.md b/Writerside/topics/Updating.md
@@ -13,6 +13,8 @@ If you wish to **modify this behavior** or **disable auto-update**, please refer
 <tabs group="updating">
 <tab title="Updating for Unix" group-key="unix">
 
+<procedure>
+
 1. **Open Terminal**: Navigate to the `ComfyUI/custom_nodes/ComfyUI-Allor` directory. You can do this by opening Terminal and using
    the `cd` command.
 
@@ -22,9 +24,13 @@ If you wish to **modify this behavior** or **disable auto-update**, please refer
     git pull
     ```
 
+</procedure>
+
 </tab>
 <tab title="Updating for Windows" group-key="windows">
 
+<procedure>
+
 1. **Open Command Prompt**: Navigate to the `ComfyUI\custom_nodes\ComfyUI-Allor` folder. You can do this by pressing <shortcut>
    Win+R</shortcut>, typing `cmd`, and pressing <shortcut>Enter</shortcut>.
 
@@ -34,5 +40,7 @@ If you wish to **modify this behavior** or **disable auto-update**, please refer
     git pull
     ```
 
+</procedure>
+
 </tab>
 </tabs>