fix: Fixed Coderabbit AI's reviews and updated the information in the…

… FAQ and Overview pages
SaptarshiSarkar12 · Sep 24, 2024 · cb37916 · cb37916
1 parent 5f06c3a
commit cb37916
Show file tree

Hide file tree

Showing 3 changed files with 88 additions and 13 deletions.
diff --git a/Website/pages/docs/faq.mdx b/Website/pages/docs/faq.mdx
@@ -1,4 +1,4 @@
-import {Steps, Tabs} from "nextra/components";
+import {Callout, Steps, Tabs} from "nextra/components";
 
 # Frequently Asked Questions
 
@@ -34,32 +34,78 @@ You can check the [Contribution](contribution.mdx) section of this documentation
 
 ### How can I update Drifty to the latest version?
 
-You can update Drifty to the latest version by following the steps mentioned in the [Updating Drifty](development/Updating-Drifty.mdx) section of the documentation.
+You can update Drifty to the latest version by following the steps mentioned below:
+<Tabs items={["Drifty GUI", "Drifty CLI", "Docker Image"]}>
+    <Tabs.Tab>
+        1. Open Drifty GUI.
+        2. Click on the **Help** menu.
+            ![Help Menu](https://github.com/user-attachments/assets/de66eb43-c517-4f89-88c7-ecdc6231d8e0)
+        3. Click on the **Check for Updates** option.
+        4. If there is an update available, you will be prompted to download and install it.
+            Click on **Yes** to download and install the update.
+            ![Update Available](https://github.com/user-attachments/assets/e262b9cf-bae2-4574-9e2f-ad0c2abb6062)
+    </Tabs.Tab>
+
+    <Tabs.Tab>
+        1. Open the terminal in the directory where Drifty CLI is present.
+        2. Run the following command to check for updates:
+            ```bash
+            drifty --update
+            ```
+            or, you can also use the shorthand version:
+            ```bash
+            drifty -u
+            ```
+        3. If there is an update available, you will be prompted to download and install it.
+    </Tabs.Tab>
+
+    <Tabs.Tab>
+        1. Open the terminal.
+        2. You can pull the latest version of the Drifty Docker image by running the following command:
+            <Callout type={"info"}>
+                Replace `{tag}` with the docker image tag you want to pull.
+                If you don't know the tag, you can use the `latest` tag to pull the latest version of the Drifty Docker image.
+                Alternatively, you can also pull the `beta` tag to get the latest beta version of the Drifty Docker image.
+            </Callout>
+            <Tabs items={["Drifty CLI", "Drifty GUI"]}>
+                <Tabs.Tab>
+                ```bash
+                docker pull ghcr.io/saptarshisarkar12/drifty-cli:{tag}
+                ```
+                </Tabs.Tab>
+                <Tabs.Tab>
+                ```bash
+                docker pull ghcr.io/saptarshisarkar12/drifty-gui:{tag}
+                ```
+                </Tabs.Tab>
+            </Tabs>
+        3. Once you have pulled the latest version of the Drifty Docker image, you can refer to [this documentation](https://github.com/SaptarshiSarkar12/Drifty?tab=readme-ov-file#using-drifty-application-via-docker-) to run those images in a container.
+    </Tabs.Tab>
+</Tabs>
 
 ### How can I access the Beta features in Drifty?
 
 You can access the Beta features in Drifty by following the steps mentioned below:
 <Tabs items={["Drifty GUI", "Drifty CLI", "Docker Image"]}>
     <Tabs.Tab>
-        #### Drifty GUI
         Open Drifty GUI and follow the steps mentioned below:
-
         <Steps>
         ### Enable Early Access Updates
         1. Click on the **Edit** menu.
+            ![Edit Menu](https://github.com/user-attachments/assets/1c990f41-7c96-4b0b-bf7b-b577e171b487)
         2. Click on the **Settings** option.
         3. Check the **Early Access Updates** checkbox in the settings window.
+            ![Early Access Updates checkbox checked](https://github.com/user-attachments/assets/e96966f7-1e9a-4598-86a8-572ef899f8d5)
 
         ### Check for Beta Updates
            Once you enable this option, you will receive updates for the Beta features of Drifty GUI as soon as they are released.
            Alternatively, you can also check for Beta updates already available by clicking on the **Check for Updates** button under the **Help** menu.
+            ![Check for Updates](https://github.com/user-attachments/assets/4e19c874-60eb-49d4-a3f1-0a959b75e885)
         </Steps>
     </Tabs.Tab>
 
     <Tabs.Tab>
-        #### Drifty CLI
         Open the terminal in the directory where Drifty CLI is present and follow the steps mentioned below:
-
         <Steps>
         ### Enable Early Access Updates
         Run the following command to toggle the Early Access Updates:
@@ -85,9 +131,7 @@ You can access the Beta features in Drifty by following the steps mentioned belo
     </Tabs.Tab>
 
     <Tabs.Tab>
-        #### Docker Image
         Drifty Docker image currently have only the **Beta** among other pre-release versions. Follow the steps mentioned below to access the **Beta** version of the Drifty Docker image:
-
         <Steps>
         ### Pull the Beta Version of Drifty Docker Image
         You can pull the **Beta** version of the Drifty Docker image by running the following command:

diff --git a/Website/pages/docs/getting-started.mdx b/Website/pages/docs/getting-started.mdx
@@ -104,7 +104,7 @@ Go to the official website of Drifty and click on the download button. It will r
     <Tabs.Tab>
     ### Drifty CLI
 
-        <Tabs items={['Windows', 'Linux', 'MacOS']}>
+        <Tabs items={['Windows', 'Linux', 'macOS']}>
             <Tabs.Tab>
             ##### Windows
 
@@ -127,7 +127,7 @@ Go to the official website of Drifty and click on the download button. It will r
             </Tabs.Tab>
 
             <Tabs.Tab>
-            ##### MacOS
+            ##### macOS
 
             Open the terminal and navigate to the directory where the binary is downloaded and run the following command to start Drifty CLI:
 

diff --git a/Website/pages/docs/usage/drifty-gui/Overview.md b/Website/pages/docs/usage/drifty-gui/Overview.md
@@ -15,8 +15,8 @@ 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**, **Suggest a feature**, and **About Drifty**.
-  ![Help](https://github.com/user-attachments/assets/d0e39364-56b2-441f-a308-e47f3feb6047)
+- **Help**: Contains options to **Contact Support**, **Contribute**, **Report a Bug**, **Report a Security Issue**, **Suggest a feature**, **Check for Updates**, and **About Drifty**.
+  ![Help](https://github.com/user-attachments/assets/de66eb43-c517-4f89-88c7-ecdc6231d8e0)
 
 ## The Link Input Field
 
@@ -26,7 +26,16 @@ The link input field is located at the top-center portion of the window and is w
 ## The Directory Input Field
 
 The directory input field is located in 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)
+![Directory Context Menu](https://github.com/user-attachments/assets/011f2745-c652-4e56-b26c-af520e625765)
+If you click above the directory input field just beside the **Directory** label, it will open the context menu to manage directories.
+![Directory Context Menu 2](https://github.com/user-attachments/assets/9a6e19ee-3733-4569-9219-898c6dc74625)
+You can select a directory from the directory list by clicking on it and deselect it by clicking on it again with the **Ctrl** key pressed. You can also **Remove** a directory from the list by right-clicking on it and selecting the **Remove** option.
+
+  <video controls width="100%">
+    <source src="https://github.com/user-attachments/assets/11ff7b69-a926-492b-83aa-f032c6cde376" type="video/mp4">
+    Your browser does not support the video tag. Click here to <a href="https://github.com/user-attachments/assets/11ff7b69-a926-492b-83aa-f032c6cde376">view</a>
+  </video>
+
 
 ## The File Name Input Field
 
@@ -49,4 +58,26 @@ The download queue is located on the left side of the window and displays the li
 
 Drifty GUI automatically checks for updates when you start the application.
 If a new version is available, a popup will appear with the option to update to the latest version. By clicking on **Yes** button, Drifty GUI will download the latest version and install it automatically.
+![Update Available](https://github.com/user-attachments/assets/e262b9cf-bae2-4574-9e2f-ad0c2abb6062)
+
 Alternatively, you can manually check for updates by clicking on the **Check for Updates** button under the **Help** menu.
+
+![Check for Updates](https://github.com/user-attachments/assets/4e19c874-60eb-49d4-a3f1-0a959b75e885)
+
+## Settings
+
+The settings window allows you to configure various options related to the application. You can open the settings window by clicking on the **Settings** option under the **Edit** menu.
+![Settings Window](https://github.com/user-attachments/assets/e96966f7-1e9a-4598-86a8-572ef899f8d5)
+
+In the settings window, you can configure the following options:
+
+- **Auto-paste**: Enable or disable the auto-paste feature.
+- **Get Early Access Updates**: Enable or disable early access updates.
+- **Theme**: Choose between **Light** and **Dark** themes.
+- **Default Download Directory**: Set the default download directory.
+
+## About Drifty
+
+The **About Drifty** window provides information about the application, including the version number and links to the project website, the source code repository and discord server.
+You can open the **About Drifty** window by clicking on the **About Drifty** option under the **Help** menu.
+![About Drifty Window](https://github.com/user-attachments/assets/b24171df-3763-4ae0-ba72-a902d4912465)