Skip to content

Commit

Permalink
Fill Documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Nourepide committed Nov 25, 2023
1 parent 422d7a4 commit 532c859
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 9 deletions.
7 changes: 4 additions & 3 deletions Writerside/topics/Allor-Doc.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# About Allor
# Introducing

![logo](documentation.png){width="706"}

> Welcome to `ComfyUI Allor Documentation`. Now you are ready for a new big step.
> Welcome to `Allor Documentation`. This is your go-to resource for detailed information and guides on how to
> use Allor effectively. Whether you’re just starting out or looking for advanced tips, we’re here to help.
## Introducing Allor
## Featuring Allor

**Allor**, is a plugin for **ComfyUI**, is your go-to solution for image post-processing. Here's why:

Expand Down
5 changes: 4 additions & 1 deletion Writerside/topics/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# FAQ

<deflist type="narrow">
The **FAQ** page provides quick answers to **common queries** about Allor. It's a go-to resource for understanding Allor
better or troubleshooting issues.

<deflist type="medium">
<def title="What is this project about?">
This project is about a plugin for ComfyUI that focuses on image post-processing.
</def>
Expand Down
7 changes: 7 additions & 0 deletions Writerside/topics/Installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Installation

**Allor** can be installed not with such complexity as it seems at first glance. Rest assured that every possible
measure has been taken to streamline this process.

The installation script implemented within Allor ensures a smooth installation experience for all users, regardless of
their technical proficiency.


> Before installing Allor, you need to have ComfyUI installed,
> see [here](https://github.com/comfyanonymous/ComfyUI#installing) how it can be done.
> {style="note"}
Expand Down
16 changes: 11 additions & 5 deletions Writerside/topics/Updating.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# Updating

Maintaining the **latest version** of Allor is crucial for **optimal performance** and access to **new features**.

This section provides comprehensive instructions on how to **update Allor**, whether you prefer the convenience of *
*automatic updates** or the control of **manual updates via Git**.

## Auto-Update

**Allor** has the capability to **self-update**. By default, this happens **once a day**.

If you wish to **modify this behavior** or **disable auto-update**, please refer to the **configuration page**.
If you wish to **modify this behavior** or **disable auto-update**, please refer to the <a href="Configuration.md">
configuration</a> page.

## Manual updating with Git

Expand All @@ -15,8 +21,8 @@ If you wish to **modify this behavior** or **disable auto-update**, please refer

<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.
1. **Open Terminal**: Navigate to the `ComfyUI/custom_nodes/ComfyUI-Allor` directory. You can do this by opening
Terminal and using the `cd` command.

2. **Update the Repository**: Update the repository by entering the following command:

Expand All @@ -31,8 +37,8 @@ If you wish to **modify this behavior** or **disable auto-update**, please refer

<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>.
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>.

2. **Update the Repository**: Update the repository by entering the following command:

Expand Down

0 comments on commit 532c859

Please sign in to comment.