Update UserGuide

docs/AboutUs.md

@@ -43,7 +43,7 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 <img src="images/seahogs.png" width="200px">
 
-[[github](http://github.com/johndoe)]
+[[github](https://github.com/SeaHogs)]
 [[portfolio](team/seahogs.md)]
 
 * Role: Developer

docs/UserGuide.md

@@ -2,11 +2,47 @@
 layout: page
 title: User Guide
 ---
+## Introduction
 
-VitalConnect is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps.
+Welcome to **vitalConnect**, your all-in-one desktop application for efficient clinic management, optimized for both Command Line Interface (CLI) and Graphical User Interface (GUI). Designed to streamline your clinic management tasks, VitalConnect offers the speed of a CLI with the convenience of a GUI, allowing you to effortlessly organize your patient and appointments with just a few keystrokes.
+
+If you are relatively good at typing, having the benefit of CLI of reducing time of dragging your mouse around, vitalConnect empowers you to manage your appointments swiftly and effectively. With its intuitive interface and robust features, you can add, delete, and search for appointments, track medical information, as well as check patient contact for communication with ease.
+
+This user guide serves as your comprehensive manual for navigating vitalConnect's features and functionalities. From quick-start instructions to detailed command summaries, you'll find everything you need to maximize your productivity and streamline your management workflow.
+
+So, whether you're a busy professional juggling multiple appointments, vitalConnect is here to simplify your life. Let's dive in and explore how vitalConnect can revolutionize the way you manage your appointment and patient.
+
+--------------------------------------------------------------------------------------------------------------------
+
+## Table of Contents
+
+<a id="top"></a>
+
+- [Quick start](#quick-start)
+- [Features](#features)
+    - [Viewing help](#viewing-help--help)
+    - [Adding a patient](#adding-a-patient--add)
+    - [Listing all patients](#listing-all-patients--list)
+    - [Locating patients by name](#locating-patients-by-name--find)
+    - [Deleting a patient](#deleting-a-patient--delete)
+    - [Adding contact information](#adding-contact-information--addc)
+    - [Listing contact information](#listing-contact-information--listc)
+    - [Deleting contact information](#deleting-contact-information--deletec)
+    - [Adding medical information](#adding-medical-information--addm)
+    - [Listing medical information](#listing-medical-information--listm)
+    - [Deleting medical information](#deleting-medical-information--deletem)
+    - [Adding an appointment](#adding-an-appointment--adda)
+    - [Deleting an appointment](#deleting-an-appointment--deletea)
+    - [Listing appointments](#list-out-appointment--lista)
+    - [Clearing all entries](#clearing-all-entries--clear)
+    - [Exiting the program](#exiting-the-program--exit)
+    - [Saving the data](#saving-the-data)
+    - [Editing the data file](#editing-the-data-file)
+    - [Archiving data files](#archiving-data-files-coming-in-v20)
+- [FAQ](#faq)
+- [Known issues](#known-issues)
+- [Command summary](#command-summary)
 
-* Table of Contents
-{:toc}
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -18,7 +54,7 @@ VitalConnect is a **desktop app for managing contacts, optimized for use via a C
 
 1. Copy the file to the folder you want to use as the _home folder_ for your vitalConnect.
 
-1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar vitalconnect.jar` command to run the application.<br>
+1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar vitalConnect.jar` command to run the application.<br>
    A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
    ![Ui](images/Ui.png)
 
@@ -37,6 +73,8 @@ VitalConnect is a **desktop app for managing contacts, optimized for use via a C
 
 1. Refer to the [Features](#features) below for details of each command.
 
+[<span style="font-size: small;">Back to Top</span>](#top)
+
 --------------------------------------------------------------------------------------------------------------------
 
 ## Features
@@ -71,7 +109,9 @@ Shows a message explaning how to access the help page.
 
 Format: `help`
 
-### Adding a patient: `add`
+[<span style="font-size: small;">Back to Top</span>](#top)
+
+### Adding a patient : `add`
 
 Adds a patient to the clinic.
 
@@ -80,13 +120,17 @@ Format: `add n/NAME ic/NRIC`
 Examples:
 * `add n/John Doe ic/S1234567D`
 
+[<span style="font-size: small;">Back to Top</span>](#top)
+
 ### Listing all patients : `list`
 
 Shows a list of all patients in the clinic.
 
 Format: `list`
 
-### Locating patients by name: `find`
+[<span style="font-size: small;">Back to Top</span>](#top)
+
+### Locating patients by name : `find`
 
 Finds patients whose names contain any of the given keywords.
 
@@ -103,6 +147,8 @@ Examples:
 * `find John` returns `John Doe` and `John Bard`</br>
   ![result for 'find John'](images/findJohnResult.png)
 
+[<span style="font-size: small;">Back to Top</span>](#top)
+
 ### Deleting a patient : `delete`
 
 Deletes the specified patient from the clinic.
@@ -117,6 +163,8 @@ Examples:
 * `list` followed by `delete 2` deletes the 2nd patient in the clinic.
 * `find Betsy` followed by `delete 1` deletes the 1st patient in the results of the `find` command.
 
+[<span style="font-size: small;">Back to Top</span>](#top)
+
 ### Adding contact information : `addc`
 
 Adds contact information to a patient in the clinic.
@@ -138,10 +186,14 @@ Examples:
 * `addc ic/S1234567D e/[email protected] p/91234567`
 * `addc ic/S1234567D a/123, Clementi Rd, 1234665 e/[email protected] p/91234567`
 
+[<span style="font-size: small;">Back to Top</span>](#top)
+
 ### Listing contact information : `listc`
 
 Lists all patients with contact information.
 
+[<span style="font-size: small;">Back to Top</span>](#top)
+
 ### Deleting contact information : `deletec`
 
 Deletes contact information from a patient in the clinic.
@@ -151,6 +203,8 @@ Format: `deletec ic/NRIC`
 Examples:
 * `deletec ic/S1234567D` will result in the contact information of the patient with NRIC `S1234567D` being deleted.
 
+[<span style="font-size: small;">Back to Top</span>](#top)
+
 ### Adding medical information : `addm`
 
 Adds medical information to a patient in the clinic.
@@ -161,10 +215,14 @@ Examples:
 * `addm ic/S1234567D h/163 w/50`
 * `addm ic/S1234567D h/163 w/50 t/insulin t/iodine`
 
+[<span style="font-size: small;">Back to Top</span>](#top)
+
 ### Listing medical information : `listm`
 
 Lists all patients with medical information.
 
+[<span style="font-size: small;">Back to Top</span>](#top)
+
 ### Deleting medical information : `deletem`
 
 Deletes medical information from a patient in the clinic.
@@ -174,7 +232,9 @@ Format: `deletem ic/NRIC`
 Examples:
 * `deletem ic/S1234567D` will result in the medical information of the patient with NRIC `S1234567D` being deleted.
 
-### Adding an appointment: `adda`
+[<span style="font-size: small;">Back to Top</span>](#top)
+
+### Adding an appointment : `adda`
 
 Adds an appointment for a patient to the appointment list.
 
@@ -183,7 +243,9 @@ Format: `adda NRIC /time DD/MM/YYYY HHMM`
 Examples:
 * `adda S1234567D /time 02/02/2024 1300` will add an appointment for the patient with NRIC `S1234567D` on 2nd February 2024 at 1:00 PM.
 
-### Adding an appointment: `deletea`
+[<span style="font-size: small;">Back to Top</span>](#top)
+
+### Deleting an appointment : `deletea`
 
 Delete an exist appointment from the appointment list by providing the index of the appointment
 in the list and the name of the patient.
@@ -193,12 +255,16 @@ Format: `deletea INDEX /name NAME`
 Examples:
 * `deletea 1 /name Amy`
 
-### List out appointments: `lista`
+[<span style="font-size: small;">Back to Top</span>](#top)
+
+### List out appointments : `lista`
 
 List out all the appointments in the appointment list.
 
 Format: `lista`
 
+[<span style="font-size: small;">Back to Top</span>](#top)
+
 ### Clearing all entries : `clear`
 
 Clears all entries from the clinic.
@@ -208,16 +274,22 @@ Format: `clear`
 > [!CAUTION]
 > This command will delete all the patients from the clinic. Please use with cautious.
 
+[<span style="font-size: small;">Back to Top</span>](#top)
+
 ### Exiting the program : `exit`
 
 Exits the program.
 
 Format: `exit`
 
+[<span style="font-size: small;">Back to Top</span>](#top)
+
 ### Saving the data
 
 Clinic data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
 
+[<span style="font-size: small;">Back to Top</span>](#top)
+
 ### Editing the data file
 
 Clinic data are saved automatically as a JSON file `[JAR file location]/data/clinic.json`. Advanced users are welcome to update data directly by editing that data file.
@@ -267,3 +339,5 @@ _Details coming soon ..._
 | **Lista**   | `lista`                                                                                                                                 |
 | **Deletea** | `deletea INDEX /name NAME` e.g., `deletea 1 /name Amy`                                                                                  |
 | **Help**    | `help`                                                                                                                                  |
+
+[<span style="font-size: small;">Back to Top</span>](#top)