Skip to content

Commit

Permalink
docs: Fixed Coderabbit AI reviews
Browse files Browse the repository at this point in the history
  • Loading branch information
SaptarshiSarkar12 committed Aug 11, 2024
1 parent 7eef297 commit 0b3dd80
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ ifconfig | grep 192.168
You should see something like this:
> inet 192.168.1.123 netmask 0xffffff00 broadcast 192.168.1.255
The **IP address** that is after the word `inet` will be the address that your router assigned to your Mac. Since that address exists in the router's pool of IP addresses, so we cannot statically assign that address to your Mac. So I recommend assigning an address that is lower in value which has a better chance of being outside the router's address pool. I would use an address like `192.168.1.10`, so we will go with that.
The **IP address** that is after the word `inet` will be the address that your router assigned to your Mac. Since that address exists in the router's pool of IP addresses, so we cannot statically assign that address to your Mac. So I recommend assigning an address that is lower in value, which has a better chance of being outside the router's address pool. I would use an address like `192.168.1.10`, so we will go with that.

If you are not running at **_least macOS version 13 (Ventura)_**, then refer to [**this article**](https://www.macinstruct.com/tutorials/how-to-set-a-static-ip-address-on-a-mac/) to get the instructions for **statically assigning your IP address**. Otherwise, follow these instructions:

Expand Down
2 changes: 1 addition & 1 deletion Website/app/docs/Faq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Frequently Asked Questions

1. **Why does Drifty GUI not open in my Windows machine?**
1. **Why does Drifty GUI not open on my Windows machine?**

➡️ Your Windows machine must have Microsoft Visual C++ Redistributable installed on your machine. You can download and install it from its [official download page](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170)

Expand Down
2 changes: 1 addition & 1 deletion Website/app/docs/Quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

Once the installation is complete, you can start using Drifty GUI by searching for it in the Windows Start menu.
- For Windows exe, you can directly run Drifty GUI by double-clicking on the downloaded file.
- For linux, open the terminal and navigate to the directory where the binary is downloaded and run the following command:
- For Linux, open the terminal and navigate to the directory where the binary is downloaded and run the following command:
```bash
chmod +x Drifty-GUI_linux
./Drifty-GUI_linux
Expand Down
10 changes: 5 additions & 5 deletions Website/app/docs/Usage/drifty-cli/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ directories: ["<Directory1>", "<Directory2>", "<Directory3>", ...]
- **links** (**Required**): List of URLs to download.
- **fileNames** (**Optional**): List of file names to save the downloaded files. The order should match the order of URLs. If not specified, the file name will be automatically detected from the URL.
- **directory** or **directories** (**Optional**): Specify the directory where the files will be saved. If **directory** is used, all files will be saved in the same given directory. If **directories** is used, each file will be saved in the corresponding directories specified according to the order of URLs. If not specified, the files will be saved in the last used directory or the default download directory (`{user_home}/Downloads`).
- **directory** or **directories** (**Optional**): Specify the directory where the files will be saved. Use **directory** to save all files in the same directory. Use **directories** to save each file in the corresponding directory specified in the order of URLs. By default, files are saved in the last used directory or the default download directory (`{user_home}/Downloads`) if not specified.

**Example Configuration**:

Expand Down Expand Up @@ -96,7 +96,7 @@ drifty --list

**Command**: `--remove <index1> <index2> ...` or `--remove all`

**Description**: Remove one or more URLs from the download queue. You can specify the index of the URLs to remove or use `all` to clear the entire queue.
**Description**: Remove one or more URLs from the download queue. You can specify the index of the URLs to remove, or use `all` to clear the entire queue.

**Usage**:

Expand All @@ -119,7 +119,7 @@ drifty --get
### Destination Download Folder

> [!NOTE]
> This command is not a standalone command. It must be used in conjunction with the URL of the file you want to download.
> This command is not a standalone command. It must be used with the URL of the file you want to download.
> You can also use the `--name` command in conjunction with this command.

**Command**: `--location <path>` or `-l <path>`
Expand All @@ -135,12 +135,12 @@ drifty https://download.oracle.com/java/22/latest/jdk-22_linux-x64_bin.tar.gz --
### File Name

> [!NOTE]
> This command is not a standalone command. It must be used in conjunction with the URL of the file you want to download.
> This command is not a standalone command. It must be used with the URL of the file you want to download.
> You can also use the `--location` command in conjunction with this command.

**Command**: `--name <filename>` or `-n <filename>`

**Description**: Specify a custom file name for the file you want to download. The file name should include the extension if applicable. If the file name is not specified, it will be automatically detected from the URL.
**Description**: Specify a custom file name, including the extension if applicable. If not provided, the file name will be automatically detected from the URL.

**Usage**:

Expand Down
10 changes: 5 additions & 5 deletions Website/app/docs/Usage/drifty-cli/downloading-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

Drifty CLI allows you to download files from the internet using a simple command-line interface. There are three ways to download files using Drifty CLI:

1. **Single File download**: You can download files one by one, providing the link to the file each time.
1. **Single File Download**: Download individual files by providing their URLs one at a time.
2. **Batch download**: You can download multiple files by providing a YAML file with the list of URLs.
3. **Using Drifty CLI Queue**: Add multiple links to the download queue, and you can download them anytime you want.
3. **Using Drifty CLI Queue**: Add multiple URLs to a download queue, allowing you to download them at your convenience.

## Single file download

1. Open Drifty CLI in your terminal.
2. You will be prompted to choose the download option. Enter `1` for **Single File download**.
![Download Options Prompt](https://github.com/user-attachments/assets/c1bb0da0-e36c-4229-9e8a-a473a973beaa)
3. Enter the URL of the video you want to download.
4. Once the URL is validated, you will be prompted to choose the download destination folder. Enter
4. After validating the URL, Drifty will prompt you to choose a download destination folder. Enter
- `.` if you want to download the video in the default download directory (which is `{user_home}/Downloads` in most cases).
- `L` if you want to use the last used directory.
- the absolute path of the directory where you want to save the video, e.g., `/home/user/Videos`.
Expand All @@ -30,7 +30,7 @@ Drifty CLI allows you to download files from the internet using a simple command
2. You will be prompted to choose the download option. Enter `2` for **Batch download**.
![Download Options Prompt](https://github.com/user-attachments/assets/c1bb0da0-e36c-4229-9e8a-a473a973beaa)
3. Enter the path to the YAML file containing the list of URLs you want to download.
For this example we are going to use the following data:
For this example, we are going to use the following data:
```yaml
# batch.yml
links: ["https://download.oracle.com/java/22/latest/jdk-22_linux-x64_bin.tar.gz", "https://www.youtube.com/watch?v=pBy1zgt0XPc"]
Expand All @@ -41,7 +41,7 @@ Drifty CLI allows you to download files from the internet using a simple command
- Enter `N` to skip downloading the file.

![File Exists Prompt](https://github.com/user-attachments/assets/6f475d3a-a316-443a-9b17-739a33155a7f)
5. The files will be downloaded sequentially to the default download directory as we have not specified a custom download location in our YAML file.
5. The files will be downloaded sequentially to the default download directory, as we have not specified a custom download location in our YAML file.
![Batch Download Progress](https://github.com/user-attachments/assets/1ba81b88-ddb4-4721-aa5f-9579d4634e99)
6. After the download is complete, you will be prompted to download another file or exit the application. Enter `Q` to exit or any other key to continue downloading files.
![Exit Prompt](https://github.com/user-attachments/assets/3e8d7491-bb27-454a-b633-092bc45e0260)
Expand Down
11 changes: 6 additions & 5 deletions Website/app/docs/Usage/drifty-gui/Overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Drifty GUI Overview

Drifty GUI is a graphical user interface for Drifty that allows you to download files from the internet with just a few clicks. It provides a simple and intuitive interface that makes downloading files easy and convenient. The main interface of Drifty GUI is where you will spend most of your time. So, it is important to understand the different parts of the interface and what they do.
Drifty GUI is a graphical user interface for Drifty that allows you to download files from the internet with just a few clicks. It provides a simple and intuitive interface that makes downloading files easy and convenient.
You will spend most of your time using the main interface of Drifty GUI, so it's important to understand its components and their functions.

![Drifty GUI Main Interface](https://github.com/user-attachments/assets/4b0626cc-84d5-41d0-94b3-f3ceaa4670df)

Expand All @@ -14,17 +15,17 @@ The menu bar is located at the top of the window and contains the following menu
![Edit](https://github.com/user-attachments/assets/1c990f41-7c96-4b0b-bf7b-b577e171b487)
- **Window**: Contains the option to **Toggle Full Screen**.
![Window](https://github.com/user-attachments/assets/cda8166e-31db-4e74-8e18-661d4ae30803)
- **Help**: Contains options to **Contact Support**, **Contribute**, **Report a Bug**, **Report a Security Issue**, **Suggesting features**, and **About Drifty**.
- **Help**: Contains options to **Contact Support**, **Contribute**, **Report a Bug**, **Report a Security Issue**, **Suggest a feature**, and **About Drifty**.
![Help](https://github.com/user-attachments/assets/d0e39364-56b2-441f-a308-e47f3feb6047)

## The Link Input Field

The link input field is located at the top-center portion of the window and is where you can paste the URL of the file you want to download. Once you have pasted the URL, Drifty will try to automatically detect the file name and check if it exists in the download history and download directories to prevent duplicate downloads.
The link input field is located at the top-center portion of the window and is where you can paste the URL of the file you want to download. Once you have pasted the URL, Drifty will automatically detect the file name and check if it already exists in the download history or download directories to prevent duplicate downloads.
![Auto-detecting file name](https://github.com/user-attachments/assets/bff2ddc0-2de9-4631-be21-02aee87da3ee)

## The Directory Input Field

The directory input field is located at the middle-center portion of the window and is where you can specify the directory where you want to save the downloaded file. By default, the directory is set to `{user_home}/Downloads`. You can manage the directory by right-clicking on the directory input field to open the context menu, which shows all the download directories you have used in the past. You can also **Add** a new directory by clicking on **Add Folder**.
The directory input field is located at the middle-center portion of the window and is where you can specify the directory where you want to save the downloaded file. By default, the directory is set to `{user_home}/Downloads`. You can manage directories by right-clicking on the directory input field to open a context menu that lists all previously used download directories. You can also **Add** a new directory by clicking on **Add Folder**.
![Directory Context Menu](https://github.com/user-attachments/assets/303a593b-392f-46ea-891b-fe8e5a02fe49)

## The File Name Input Field
Expand All @@ -33,7 +34,7 @@ The file name input field is located at the bottom-center portion of the window

## The Auto-Paste Checkbox

The auto-paste checkbox is located at the top-right portion of the window and is used to enable or disable the auto-paste feature. When enabled, Drifty will automatically paste the URL from the clipboard into the link input field. When you return to the app after copying a URL, the URL will be automatically pasted into the link input field.
The auto-paste checkbox is located at the top-right portion of the window and is used to enable or disable the auto-paste feature. When enabled, Drifty will automatically paste the URL from the clipboard into the link input field. When you return to the app after copying a URL, it will automatically paste into the link input field.

## The Start Button

Expand Down

0 comments on commit 0b3dd80

Please sign in to comment.