From def0307e760511ff79a0fd1b19c870507e04c3eb Mon Sep 17 00:00:00 2001
From: Loo Mei Lin Zann <>
Date: Mon, 30 Oct 2023 12:30:45 +0800
Subject: [PATCH 01/15] Update introduction

---
 docs/UserGuide.md | 54 +++++++++++++++++++++++------------------------
 1 file changed, 27 insertions(+), 27 deletions(-)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index 5156b4c020e..940d4761d86 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -3,44 +3,44 @@ layout: default.md
 title: "User Guide"
 pageNav: 3
 ---
-
 # ProfBook User Guide
 
-ProfBook is a **student management system** specially made for **CS2103T tutors**, built by CS2103T students. As current
-students of CS2103T, we understand that CS2103T tutors have a high administrative workload on top of their existing
-tutor duties. On top of that, any administrative mistakes or oversights can increase that workload exponentially and may
-adversely impact student's learning. To address the aforementioned issues, Profbook was designed as a student management
-system which can **dramatically decrease administrative mistakes and workload**.
-
-It is optimized for tutors use via a **familiar Command Line Interface (CLI) that uses linux-styled commands** while
-still having the benefits of a Graphical User Interface (GUI). If you can type fast, ProfBook can track and manage your
-student's progress and tasks much faster than traditional GUI apps with a gentle learning curve.
-
----
+Welcome to ProfBook, a specialised **student management system** exclusively tailored for **CS2103T tutors** by CS2103T 
+students.  This guide is your gateway to unlocking the potential of ProfBook, where you will discover how ProfBook can 
+help streamline your administrative tasks, alleviate workload and most importantly reduce any administrative errors.
+
+## What can ProfBook do
+As current students of CS2103T, we understand that CS2103T tutors have a high administrative workload on top of their 
+existing tutor duties. On top of that, any administrative mistakes or oversights can increase that workload 
+exponentially and may adversely impact student's learning. We deeply appreciate your role, and it is precisely to 
+address these aforementioned issues that we designed Profbook as a student management system which can 
+**dramatically decrease administrative mistakes and workload**.
+
+ProfBook is optimized for tutors' use via a **familiar Command Line Interface (CLI) that uses linux-styled commands** 
+while retaining the benefits of a Graphical User Interface (GUI). If you are a fast typer, ProfBook will empower you 
+to efficiently track and manage students' progress and tasks, surpassing the capabilities of traditional GUI apps 
+with a gentle learning curve.
+  
+---  
 
 ## Features overview
 
 ### Consolidated Information
 
-As a project based module, CS2103T tutors have to juggle multiple groups **within** multiple tutorial slots. ProfBook
-aims to expedite this process by allowing tutors to keep track of all their tutorial groups and all the project groups
-within that in a centralised location. Tutors are able to traverse between tutorial slots and groups quickly through
-familiar linux commands.
+As a project-based module, CS2103T tutors have to juggle multiple groups **within** multiple tutorial slots. ProfBook  
+aims to expedite this process by allowing you keep track of all your groups and their progress within a centralised 
+location. You would be able to traverse between the different groups quickly through familiar linux commands.
 
-### Student Information Management
+### Student and Group Management
 
-ProfBook aids with the **management of student information**. Student's information can be **readily** added, edited,
-deleted quickly. In addition, ProfBook supports the managment of additional information vital for a tutor. Tutors can
-track their student progress through creating various tasks such as Todo and Deadline. Furthermore, Tutors can store
-short description of a student or links to their GitHub Repository if desired.
+ProfBook aids with the **management of student and group information**.Profbook efficiently encapsulates information of 
+every project group so that you can easily monitor their progress and relevant information **seamlessly**.  You can 
+effortlessly **add, delete and edit students or group** and even **move students from one group to another**.
 
-### Tutorial and Groups Information Management
+### Task Management
 
-ProfBook aids with the **management of Tutorial and Groups information**. Profbook efficiently encapsulates information
-of every tutorial group and every project group so that tutors can management their progress and relevant information *
-*seamlessly**. Tutors can easily add, move, delete students from groups. Similiar to students, tutors are able to track
-each group progress through tasks. In addition, Tutors can store short description of the groups or links to their
-GitHub Repository if desired.
+ProfBook aids with the **management of task information**.  You can easily **allocate tasks to specific student 
+or group** and track their progress. 
 
 <div class="page-break-before">
     <!-- Content that will start on a new printed page -->

From 736d7a2ab8cd2a4362b3031e8c0437fbd305590e Mon Sep 17 00:00:00 2001
From: Loo Mei Lin Zann <>
Date: Mon, 30 Oct 2023 14:52:58 +0800
Subject: [PATCH 02/15] Update outline of UG

---
 docs/UserGuide.md | 327 +++++++++++++++++++++++++++-------------------
 1 file changed, 193 insertions(+), 134 deletions(-)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index 940d4761d86..b1fc6570990 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -68,6 +68,8 @@ or group** and track their progress.
 
 1. Ensure you have Java `11` or above installed in your Computer.
 
+1. ProfBook supports all operating systems.
+
 1. Download the latest `ProfBook.jar` from [here](https://github.com/AY2324S1-CS2103T-W15-2/tp/releases).
 
 1. Copy the file to the folder you want to use as the _home folder_ for your ProfBook.
@@ -87,7 +89,7 @@ or group** and track their progress.
 
     - `cat grp-001` : Lists all tasks belonging to grp-001.
 
-    - `touch grp-001/stu-200 --name Bob --email bobby@example.com --phone 92929292 --address blk 258 Toa Payoh`
+    - `touch grp-001/stu-200 --name Bob`
       : Adds a student named `Bob` to the grp-001.
 
     - `rm grp-001` : Deletes grp-001.
@@ -143,19 +145,22 @@ or group** and track their progress.
 **Notes about the command format:**<br>
 
 - Words in `UPPER_CASE` are the parameters to be supplied by the user.
-    - e.g. in `touch SPECIFIED_PATH -n NAME -e EMAIL - p PHONE_NUMBER -a ADDRESS`, `SPECIFIED_PATH` and the other words
-      in `UPPER_CASE` can be substituted to form `touch stu-200 --name Bob --email bobby@example.com --phone 92929292
-      --address blk 258 Toa Payoh`.
+    - e.g. In `touch SPECIFIED_PATH -n NAME`, `SPECIFIED_PATH` and the other fields in `UPPER_CASE` can be substituted 
+  with the desired details to form `touch stu-200 --name Bob`.
+
+- Words in `UPPER_CASE` and surrounded by `[square brackets]` are optional parameters to be supplied by the user.
+  - e.g. In `cat [SPECIFIED_PATH]`, `[SPECIFIED_PATH]` can be substituted with details or left empty, 
+  `cat stu-200` and `cat` are acceptable commands. 
 
 - Parameters can be in any order.
-    - e.g. if the command specifies `-n NAME -e EMAIL`, `-e EMAIL -n NAME` is also acceptable.
+    - e.g. If the command specifies `-n NAME -e EMAIL`, `-e EMAIL -n NAME` is also acceptable.
 
-- Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be
-  ignored.<br>
-  e.g. if the command specifies `help 123`, it will be interpreted as `help`.
+- Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be  
+  ignored.<br>  
+  e.g. If the command specifies `help 123`, it will be interpreted as `help`.
 
-- If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines
-  as space characters surrounding line-breaks may be omitted when copied over to the application.
+- If you are using a PDF version of this document, please be careful when copying and pasting commands that span 
+multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
 
 </box>
 
@@ -165,28 +170,46 @@ or group** and track their progress.
 
 `SPECIFIED_PATH`:
 
-- must be valid path
+- Must be valid path
 
 `NAME`:
 
-- must be a non-empty string
+- Must be a non-empty string
 
 `EMAIL`:
 
-- must be a non-empty string
+- Must be a non-empty string
 
 `PHONE_NUMBER`:
 
-- must be a non-empty string
+- Must be a non-empty string
 
 `ADDRESS`:
 
-- must be a non-empty string
+- Must be a non-empty string
 
 `TASK_INDEX`:
-- must be a valid index starts from 1
+- Must be a valid index starts from 1
 </box>
 
+<box type="info" theme="warning">
+
+**Acceptable values for each parameter:**
+
+`GroupId`:
+- Must be in the format `grp-XXX` where `XXX` is replaceable with any 3 digit number
+  - eg. `grp-001`
+
+`StudentId`:
+- Must be in the format `XXXX_` where `XXX` is replaceable with any 4 digit number and `_` is replaceable with any 
+capitalised alphabet.
+- This format accurately reflects the last 5 place of an NUS student's matriculation number while maintaining privacy and 
+security.
+  - eg. `8467U`
+
+
+  </box>
+
 ---
 
 <div class="page-break-before">
@@ -195,12 +218,6 @@ or group** and track their progress.
 
 ## General Commands
 
-### View help : `help`
-
-Shows a message explaning how to access the help page.
-
-**Format:** `help`
-
 ### Change Directory: `cd`
 
 Changes the current directory in the ProfBook.
@@ -211,7 +228,7 @@ Changes the current directory in the ProfBook.
 
 `SPECIFIED_PATH`:
 
-- must be a valid path to a group or root
+- must be a valid path to a group, student or root. 
 
 <box type="success" seamless>
 
@@ -225,31 +242,32 @@ Changes the current directory in the ProfBook.
 
 #### Output if command fails:
 
-- displays message indicating either:
+- Displays message indicating either:
   - Invalid command format
   - Invalid path
 
 </box>
 
 #### Examples:
-- When user is at the directory `~/grp-001`
-  - User can change directory from `grp-001` to `grp-002` using `cd ../grp-002`
+- When you are at the directory `~/grp-001` and would like to change directory from `grp-001` to `grp-002` you could
+use the command:
+  -  `cd ../grp-002`
 
 ### Display Directories : `ls`
 
 Shows the list of children in the current directory
 
-**Format:** `ls SPECIFIED_PATH`
+**Format:** `ls [SPECIFIED_PATH]`
 
 #### Acceptable values for each parameter:
 
-`SPECIFIED_PATH`:
+`[SPECIFIED_PATH]`:
 
-- must be a valid path to a group or root
+- Must be a valid path to a group or root
 
 <box type="info">
   
-  If no `SPECIFIED_PATH` is given, the `ls` command will default to the current directory.
+  If no `[SPECIFIED_PATH]` is given, the `ls` command will default to the current directory.
 
 </box>
 
@@ -257,8 +275,8 @@ Shows the list of children in the current directory
 
 #### Output if command succeeds:
 
-- displays message indicating successful display of children list.
-- displays directories under target path on display panel.
+- Displays message indicating successful display of children list.
+- Displays directories under target path on display panel.
 
 </box>
 
@@ -274,49 +292,47 @@ Displays message indicating either:
 
 #### Examples:
 
-- When user is at the directory `~/grp-001`:
+- When you are at the directory `~/grp-001` and would like to see the students under `grp-001`,
     - `ls` will return all the students in grp-001
-- When user is at the root directory `~/`:
+- When you are at the root directory `~/` and would like to see all groups you have,
     - `ls` will return all the current groups
 
-### Display all tasks: `cat`
+### Displays all tasks: `cat`
 
-Searches for tasks depending on the environment.
+Displays all tasks depending on the directory you are at.
 
-**Format:** `cat SPECIFIED_PATH`
+**Format:** `cat [SPECIFIED_PATH]`
 
 #### Acceptable values for parameter:
 
 `SPECIFIED_PATH`:
-- must be a valid path
+- Must be a valid path to group or student
+- Cannot be a path to root
 
 <box type="success" seamless>
 
 #### Output if command succeeds:
 
-- display updates with tasks assigned under input Path
+- Displays list of tasks assigned under input Path
 
 </box>
 
 <box type="wrong" seamless>
 
 #### Output if command fails:
-
 If `cat` in root directory
-
-- display updates indicating that tasks cannot be shown within root directory.
+- Displays message indicating that tasks cannot be shown within root directory.
 
 If `cat` with invalid parameter
-
-- display updates showing invalid path with user entered Path
+- Displays message showing invalid path with user entered Path.
 
 </box>
 
 #### Examples:
-`cat grp-001`, `cat 1234A`
-
-- The first command will display all tasks assigned to group 001
-- The second command will display all tasks that are assigned to student with Id 1234A
+- When you are at the directory `~/grp-001` and would like to see all tasks allocated to `grp-001`,
+  - `cat` will return all the tasks allocated to grp-001.
+- If you are at the directory `~/grp-001` and would like take a quick look of the tasks allocated to student `0010Y`,
+  - `cat 0010Y` will return all the tasks allocated to student of studentId, `0010Y`.
 
 ---
 
@@ -330,7 +346,7 @@ If `cat` with invalid parameter
 
 Adds a student into the specified directory.
 
-**Format:** `touch SPECIFIED_PATH -n NAME -e EMAIL - p PHONE_NUMBER -a ADDRESS`
+**Format:** `touch SPECIFIED_PATH -n NAME [-e EMAIL] [-p PHONE_NUMBER] [-a ADDRESS]`
 
 - `--name` / `-n` : Name of Student
 - `--email` / `-e` : Email of Student
@@ -347,7 +363,7 @@ Adds a student into the specified directory.
 
 #### Output if command succeeds:
 
-- Displays message indicating successful creation together with information of created student
+- Displays message indicating successful creation together with information of the new student.
 
 </box>
 
@@ -363,19 +379,24 @@ Adds a student into the specified directory.
 
 #### Examples:
 
-- The following commands when executed at the different current path directory will create the same student at the same
-  path directory`~/grp-001/stu-200`
-    - When user is at the directory `~/grp-001` and keys in command:
-        - `touch stu-200 --name Bob --email bobby@example.com --phone 92929292 --address blk 258 Toa Payoh `
-    - When user is at the root directory `~/` and keys in command:
-        - `touch ~/grp-001/stu-200 --name Bob --email bobby@example.com --phone 92929292 --address blk 258 Toa Payoh `
+- When you are at the directory `~/grp-001`, you could add a new student to this group through this command,
+  - `touch stu-200 --name Bob`
 
+<box type="tip">
+
+- When you are at the directory `~/grp-001` and would like to add a new student, Bob, to another directory 
+`~/grp-001`,
+  - You could use the command `touch ~/grp-002/0200Y --name Bob` to save yourself the hassle for having to change 
+  directory!
+
+</box>
 
 #### To note:
 
-- Command creates a student within the group if command is used from within the group or specified path has indicated
-  the group path.
-- If a command is executed outside a specific group, specified path must be to the group and to the student.
+- When the command is executed from within the group or if the specified path indicates the group, it creates a student 
+within that group.
+- However, if the command is executed outside a specific group, the specified path should extend to encompass both the 
+group and the student to ensure accurate execution.
 
 ### Delete a Student or Group: `rm`
 
@@ -387,7 +408,7 @@ Deletes a student/group from the specified directory.
 
 `SPECIFIED_PATH`:
 
-- must be a valid path to a student/group that user wants to delete
+- must be a valid path to a student or group that user wants to delete
 
 <box type="success" seamless>
 
@@ -409,29 +430,33 @@ Deletes a student/group from the specified directory.
 
 #### Examples:
 
-- When user is at the directory `~/grp-001` and keys in the following command, student with specified
-  path `~/grp-001/0123Y` will be deleted:
-    - `rm 0123Y`
-- When user is at the root directory `~/` and keys in the following command, will delete group with specified
-  path `~/grp-001` will be deleted:
-    - `rm grp-001`
+- When you are at the root directory `~/` and would like to remove the group, `grp-001`,
+    - `rm grp-001` will remove grp-001
+
+<box type="tip">
+
+- When you are at the directory `~/` and would like to remove the student with the StudentId, `0123Y`, in `grp-001`
+  `~/grp-001`,
+  - You could use the command `rm ~/grp-001/0123Y` to save yourself the hassle for having to change directory!
+
+</box>
 
 
 ### Move Student or Group: `mv`
 
-Moves student from one group to another group
+Moves student from one group to another group.
 
-**Format:** `mv SPECIFIED_PATH SPECIFIED_PATH`
+**Format:** `mv SPECIFIED_PATH_TO_STUDENT SPECIFIED_PATH_TO_GROUP`
 
 #### Acceptable values for each parameter:
 
-`SPECIFIED_PATH`:
+`SPECIFIED_PATH_TO_STUDENT`:
 
-- must be a valid path to a student
+- Must be a valid path to a student.
 
-`SPECIFIED_PATH`:
+`SPECIFIED_PATH_TO_GROUP`:
 
-- must be a valid path to a group
+- Must be a valid path to a group.
 
 <box type="success" seamless>
 
@@ -446,37 +471,43 @@ Moves student from one group to another group
 #### Output if command fails
 
 - Displays message indicating either:
-  - Invalid command format
-  - No such student to move
-  - Invalid destination path
+  - Invalid command format.
+  - No such student to move.
+  - Invalid destination path.
 
 </box>
 
 #### Examples:
-- When user is at the root directory `~` and keys in the following command, student with specified path `~/grp-001/0123Y` will be moved from grp-001 to grp-002:
+- In the beginning of the semester, student transfer from groups are common. When you are at the root directory `~` and 
+would like to move a student from `grp-001` to `grp-002`,
   - `mv grp-001/0123Y grp-002`
 
+<box type="tip">
+
 - When user is at the group directory `~/grp-001` and keys in the following command, student with specified path `~/grp-001/0123Y` will be moved from grp-001 to grp-002:
   - `mv 0123Y ../grp-002`
+- When you are at the directory `~/grp-001` and would like to move a student to `grp-002` without changing to the root directory,
+  - You could use the command `mv 0123Y ../grp-002`!
 
+</box>
 
 ### Create Group : `mkdir`
 
-Creates a group consists of students
+Creates a group consisting of students.
 
-**Format:** `mkdir PATH_TO_THE_GROUP`
+**Format:** `mkdir SPECIFIED_PATH_TO_GROUP`
 
 #### Acceptable values for each parameter:
 
-`PATH_TO_THE_GROUP`:
+`SPECIFIED_PATH_TO_GROUP`:
 
-- must be a valid path to a group
+- Must be a valid path to a group
 
 <box type="success" seamless>
 
 #### Output if command succeeds
 
-- pop up message indicates group with specific groupId was created successfully.
+- Displays message indicating group with specific GroupId is created successfully.
 
 </box>
 
@@ -485,17 +516,41 @@ Creates a group consists of students
 #### Output if command fails
 
 - Displays message indicating either:
-    - Invalid command format
-    - Invalid path to a group
+    - Invalid command format.
+    - Invalid path to a group.
 
 </box>
 
 #### Examples:
 
-- When user is at the root directory `~` and keys in the following command, a group with groupId called grp-001 will be created
+- When you are at the root directory `~/` and would like to add a new group with GroupId `grp-001`, 
   - `mkdir grp-001`
 
+### View help : `help`
+
+Shows a message explaining how to access the help page.
+**Format:** `help`
+
+### Clearing all entries : `clear`
+
+Clears all entries from the address book.
+**Format:** `clear`
+
+<box type="tip">
+This command is particularly valuable at the beginning of a new semester when you wish to clear all your previous 
+students and groups, making way for the addition of new students. 
+</box>
+
+### Exiting the program : `exit`
+
+Exits the program.
+**Format:** `exit`
 
+<box type="tip">
+
+This command is beneficial if you prefer not to switch to mouse usage in order to click on the cross button located in 
+the top left corner of the window.
+</box>
 ---
 
 <div class="page-break-before">
@@ -508,17 +563,17 @@ Creates a group consists of students
 
 Creates todo tasks for specific student(s) or group(s).
 
-**Format:** `todo SPECIFIED_PATH --desc DESCRIPTION --all CATERGORY`
+**Format:** `todo SPECIFIED_PATH --desc DESCRIPTION [--all CATERGORY]`
 
 - `--desc` / `-d` : Description of the todo task
-- `--all` / `-al` : (Optional) Either `allStu` or `allGrp` to add a deadline task to all students/groups in the
+- `--all` / `-al` : (Optional) Either `allStu` or `allGrp` to add a deadline task to all students or groups in the
   specified path
 
 <box type="success" seamless>
 
 #### Output if command succeeds
 
-- Displays message indicating todo task created successfully.
+- Displays message indicating the successful creation of the todo task.
 
 </box>
 
@@ -527,34 +582,38 @@ Creates todo tasks for specific student(s) or group(s).
 #### Output if command fails:
 
 - Displays message indicating either:
-  - Invalid command format
-  - Invalid path
+  - Invalid command format.
+  - Invalid path.
 
 </box>
 
 #### Examples:
 
-- When user is at the directory `~/grp-001` and keys in the following command, a todo task with
-  description `Assignment 1`, will be allocated to student from path `grp-001/stu-001`.
-    - `todo stu-001 --desc Assignment 1 `
-- When user is at the root directory `~/` and keys in the following command, a todo task with
-  description `Assignment 1`, will be allocated to student from path `grp-001/stu-001`.
-    - `todo ~/grp-001/stu-001 --desc Assignment 1 `
-- When user is at the root directory `~` and keys in the following command, a todo task with description `Assignment 1`, will
-  be allocated to all students in path `~/grp-001`.
-    - `todo ~/grp-001 --desc Assignment 1 --all allStu`
+- When a specific student has to redo his tutorial, you could use the following command when you are in the directory 
+`~/grp-001` to allocate the task to this student,
+    - `todo 0001Y --desc Redo tutorial `
+
+<box type="tip">
+
+- When you have an assignment, `Assignment 1` to be allocated to all your students in `grp-001`, you could use the 
+following command, 
+  - `todo ~/grp-001 --desc Assignment 1 --all allStu`
+
+</box>
 
 
 ### Create Deadline task : `deadline`
 
 Creates task with a deadline for specific student(s) or group(s).
 
-**Format:** `deadline SPECIFIED_PATH --desc DESCRIPTION --datetime DATE_AND_TIME --all CATERGORY`
+**Format:** `deadline SPECIFIED_PATH --desc DESCRIPTION --datetime DATE_AND_TIME [--all CATERGORY]`
 
 - `--desc` / `-d` : Description of the deadline task
 - `--datetime` / `-dt` : The duedate of the task. In the following format: `yyyy-MM-dd HH:mm`
 - `--all` / `-al` : (Optional) Either `allStu` or `allGrp` to add a deadline task to all students/groups in the
   specified path
+  - `allStu` can only be used at a group directory.
+  - `allGrp` can only be used at root directory.
 
 <box type="success" seamless>
 
@@ -569,41 +628,37 @@ Creates task with a deadline for specific student(s) or group(s).
 #### Output if command fails:
 
 - Displays message indicating either:
-  - Invalid command format
-  - Invalid path
+  - Invalid command format.
+  - Invalid path.
 
 </box>
 
 #### Examples:
 
-- When user is at the directory `~/grp-001` and keys in the following command, a task with a deadline `2023-10-11 23:59`
-  for the task with description `Assignment 1`, will be allocated to student from path `grp-001/stu-001`.
-    - `deadline stu-001 --desc Assignment 1 --datetime 2023-10-11 23:59`
-- When user is at the root directory `~/` and keys in the following command, a task with a deadline `2023-10-11 23:59`
-  for the task with description `Assignment 1`, will be allocated to student from path `grp-001/stu-001`.
-    - `deadline ~/grp-001/stu-001 --desc Assignment 1 --datetime 2023-10-11 23:59 `
-- When user is at the root directory `~/` and keys in the following command, a task with a deadline `2023-10-11 23:59`
-  for the task with description `Assignment 1`, will be allocated to all students in path `~/grp-001`.
-    - `deadline ~/grp-001 --desc Assignment 1 --datetime 2023-10-11 23:59 --all allStu`
+- When a specific student has to hand in his assignment again by a certain date, 
+you could use the following command when you are in the directory `~/grp-001`,
+  - `deadline 0001Y- --desc resubmit Assignment 1 --datetime 2023-10-11 23:59`
 
+<box type="tip">
 
-### Mark tasks as completed: `mark`
+- When you have a task, `Project 1 submission` with deadline to be allocated to all your groups, 
+you could use the following command at the root directory, `~/`,
+  - `deadline ~/ --desc Project 1 submission --datetime 2023-10-11 23:59 --all allGrp`
 
-Marks the specified task as done for the student
+</box>
 
-**Format:** `mark TASK_INDEX`
+### Mark tasks as completed: `mark`
 
-#### Acceptable parameter should be:
+Marks the specified task as done for the student or group. 
 
-`TASK_INDEX`:
+**Format:** `mark TASK_INDEX`
 
-- must be a valid index starts from 1
 
 <box type="success" seamless>
 
 #### Output if command succeeds
 
-- displays message indicating mark is done successfully as well as specific task that is marked
+- Displays message indicating mark is done successfully as well as specific task that is marked
 
 </box>
 
@@ -611,39 +666,38 @@ Marks the specified task as done for the student
 
 #### Output if command fails
 
-- displays message indicating either:
-  - Invalid command format
-  - Invalid task index
-  - The display panel is not showing task list
+- Displays message indicating either:
+  - Invalid command format.
+  - Invalid task index.
+  - The display panel is not showing task list.
 
 </box>
 
 #### Examples:
+  <box type="warning">
 
-- When user is at the group directory `~/grp-001` and keys in the following command, the task list of a student with specified path `~/grp-001/0123Y` will be shown after entering the command `cat 0123Y`. Then, user can mark task by specifying the task index:
+    When using this command, you will first need to `cat` at the path where the task list is at before `mark`.
+
+  </box>
+
+- You are at `~/grp-001` would like to mark the first task allocated to student with StudentId, `0123Y`,
   - `cat 0123Y`
   - `mark 1`
 
 ### Unmark completed task: `unmark`
 
-Unmarks the specified task for the student
+Unmarks the specified task for the student or group. 
 
 **Format:** `unmark TASK_INDEX`
 
-#### Acceptable parameter should be:
-
-`TASK_INDEX`:
-
-- must be a valid index starts from 1
-
 <box type="success" seamless>
 
 #### Output if command succeeds:
 
 - displays message indicating either:
-  - Invalid command format
-  - Invalid task index
-  - The display panel is not showing task list
+  - Invalid command format.
+  - Invalid task index.
+  - The display panel is not showing task list.
 
 </box>
 
@@ -651,13 +705,18 @@ Unmarks the specified task for the student
 
 #### Output if command fails:
 
-- displays message indicating unmark is done successfully as well as specific task that is unmarked
+- Displays message indicating unmark is done successfully as well as specific task that is unmarked.
 
 </box>
 
 #### Examples:
+  <box type="warning">
+
+    When using this command, you will first need to `cat` at the path where the task list is at before `unmark`.
+
+  </box>
 
-- When user is at the group directory `~/grp-001` and keys in the following command, the task list of a student with specified path `~/grp-001/0123Y` will be shown after entering the command `cat 0123Y`. Then, user can unmark task by specifying the task index:
+- You are at `~/grp-001` would like to unmark the first task allocated to student with StudentId, `0123Y`,
   - `cat 0123Y`
   - `unmark 1`
 

From 2dff5e211fc316ac73c69028cf392b22d90bd136 Mon Sep 17 00:00:00 2001
From: Loo Mei Lin Zann <>
Date: Mon, 30 Oct 2023 15:18:47 +0800
Subject: [PATCH 03/15] Test emojis

---
 docs/UserGuide.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index b1fc6570990..2d3a429e635 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -9,7 +9,7 @@ Welcome to ProfBook, a specialised **student management system** exclusively tai
 students.  This guide is your gateway to unlocking the potential of ProfBook, where you will discover how ProfBook can 
 help streamline your administrative tasks, alleviate workload and most importantly reduce any administrative errors.
 
-## What can ProfBook do
+## What can ProfBook do :monocle_face:
 As current students of CS2103T, we understand that CS2103T tutors have a high administrative workload on top of their 
 existing tutor duties. On top of that, any administrative mistakes or oversights can increase that workload 
 exponentially and may adversely impact student's learning. We deeply appreciate your role, and it is precisely to 

From 50b10690ba0a62ce10aa8dbc44a69d9ca33805fa Mon Sep 17 00:00:00 2001
From: Loo Mei Lin Zann <>
Date: Mon, 30 Oct 2023 19:58:18 +0800
Subject: [PATCH 04/15] Edit formatting

---
 docs/UserGuide.md | 307 +++++++++++++++++++++++-----------------------
 1 file changed, 151 insertions(+), 156 deletions(-)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index 2d3a429e635..05ab27494da 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -9,12 +9,12 @@ Welcome to ProfBook, a specialised **student management system** exclusively tai
 students.  This guide is your gateway to unlocking the potential of ProfBook, where you will discover how ProfBook can 
 help streamline your administrative tasks, alleviate workload and most importantly reduce any administrative errors.
 
-## What can ProfBook do :monocle_face:
+## What can ProfBook do
 As current students of CS2103T, we understand that CS2103T tutors have a high administrative workload on top of their 
 existing tutor duties. On top of that, any administrative mistakes or oversights can increase that workload 
 exponentially and may adversely impact student's learning. We deeply appreciate your role, and it is precisely to 
-address these aforementioned issues that we designed Profbook as a student management system which can 
-**dramatically decrease administrative mistakes and workload**.
+address these aforementioned issues that we designed ProfBook. ProfBook aims to
+**drastically decrease administrative mistakes and your administrative workload**.
 
 ProfBook is optimized for tutors' use via a **familiar Command Line Interface (CLI) that uses linux-styled commands** 
 while retaining the benefits of a Graphical User Interface (GUI). If you are a fast typer, ProfBook will empower you 
@@ -27,19 +27,19 @@ with a gentle learning curve.
 
 ### Consolidated Information
 
-As a project-based module, CS2103T tutors have to juggle multiple groups **within** multiple tutorial slots. ProfBook  
+As a project-based module, CS2103T tutors have to juggle multiple groups **within** multiple tutorial slots. ProfBook
 aims to expedite this process by allowing you keep track of all your groups and their progress within a centralised 
-location. You would be able to traverse between the different groups quickly through familiar linux commands.
+location. You would be able to traverse between the different groups quickly through familiar Linux commands.
 
 ### Student and Group Management
 
-ProfBook aids with the **management of student and group information**.Profbook efficiently encapsulates information of 
-every project group so that you can easily monitor their progress and relevant information **seamlessly**.  You can 
-effortlessly **add, delete and edit students or group** and even **move students from one group to another**.
+ProfBook aids with the **management of student and group information**. ProfBook efficiently encapsulates information of 
+every project group so that you can easily monitor their progress and relevant information seamlessly.  You can 
+effortlessly **add, delete and edit students or groups** and even **move students from one group to another**.
 
 ### Task Management
 
-ProfBook aids with the **management of task information**.  You can easily **allocate tasks to specific student 
+ProfBook aids with the **management of task information**.  You can quickly **allocate tasks to specific student 
 or group** and track their progress. 
 
 <div class="page-break-before">
@@ -66,7 +66,7 @@ or group** and track their progress.
 
 ## Quick start
 
-1. Ensure you have Java `11` or above installed in your Computer.
+1. Ensure you have Java `11` or above installed in your computer.
 
 1. ProfBook supports all operating systems.
 
@@ -83,18 +83,17 @@ or group** and track their progress.
 
    </div>
 
-1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will
-   open the help window.<br>
-   Some example commands you can try:
+1. Type the command in the command box and press Enter to execute it.
+   <br> Some example commands you can try:
 
     - `cat grp-001` : Lists all tasks belonging to grp-001.
 
-    - `touch grp-001/stu-200 --name Bob`
+    - `touch grp-001/0123Y --name Bob`
       : Adds a student named `Bob` to the grp-001.
 
     - `rm grp-001` : Deletes grp-001.
 
-1. Refer to the [General Commands](#general-commands), [Student/Group Commands](#student-or-group-commands), [Task Commands](#tasks-command) below for details of each command.
+1. Refer to the [General Commands](#general-commands), [Student/ Group Commands](#student-or-group-commands), [Task Commands](#tasks-command) below for details of each command.
 
 ---
 
@@ -125,14 +124,30 @@ or group** and track their progress.
   The Root Directory serves as the main container for the ProfBook software. This is where all the data is organized.
 
   **Group Directories (e.g., `grp-001`, `grp-002`, ...)**<br>
-
   Within the Root Directory, there are Group Directories. Each Group Directory is dedicated to managing a specific group of students.
 
   **Student Directories (e.g., `1001Z`, `5815Y`, ...)**<br>
-
   Inside each Group Directory, you'll find Student Directories. These directories represent individual students within each group.
 
   This hierarchical structure enables a well-organized and efficient way to manage groups and students within ProfBook.
+
+<box type="info" theme="warning">
+
+**Acceptable values for each parameter:**
+
+`GroupId`:
+- Must be in the format `grp-XXX` where `XXX` is replaceable with any 3 digit number
+  - eg. `grp-001`
+
+`StudentId`:
+- Must be in the format `XXXX_` where `XXX` is replaceable with any 4 digit number and `_` is replaceable with any
+  capitalised alphabet.
+- This format accurately reflects the last 5 place of an NUS student's matriculation number while maintaining privacy and
+  security.
+  - eg. `8467U`
+
+
+  </box>
 </box>
 
 <div class="page-break-before">
@@ -145,19 +160,19 @@ or group** and track their progress.
 **Notes about the command format:**<br>
 
 - Words in `UPPER_CASE` are the parameters to be supplied by the user.
-    - e.g. In `touch SPECIFIED_PATH -n NAME`, `SPECIFIED_PATH` and the other fields in `UPPER_CASE` can be substituted 
-  with the desired details to form `touch stu-200 --name Bob`.
+  - e.g. In `touch SPECIFIED_PATH -n NAME`, `SPECIFIED_PATH` and the other fields in `UPPER_CASE` can be substituted 
+    with the desired details to form `touch stu-200 --name Bob`.
 
 - Words in `UPPER_CASE` and surrounded by `[square brackets]` are optional parameters to be supplied by the user.
   - e.g. In `cat [SPECIFIED_PATH]`, `[SPECIFIED_PATH]` can be substituted with details or left empty, 
-  `cat stu-200` and `cat` are acceptable commands. 
+    `cat stu-200` and `cat` are acceptable commands. 
 
 - Parameters can be in any order.
-    - e.g. If the command specifies `-n NAME -e EMAIL`, `-e EMAIL -n NAME` is also acceptable.
+  - e.g. If the command specifies `-n NAME -e EMAIL`, `-e EMAIL -n NAME` is also acceptable.
 
 - Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be  
-  ignored.<br>  
-  e.g. If the command specifies `help 123`, it will be interpreted as `help`.
+  ignored.
+  - e.g. If the command specifies `help 123`, it will be interpreted as `help`.
 
 - If you are using a PDF version of this document, please be careful when copying and pasting commands that span 
 multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
@@ -169,46 +184,24 @@ multiple lines as space characters surrounding line-breaks may be omitted when c
 **Acceptable values for each parameter:**
 
 `SPECIFIED_PATH`:
-
-- Must be valid path
+- Must be a valid path.
 
 `NAME`:
-
-- Must be a non-empty string
+- Must be a non-empty string.
 
 `EMAIL`:
-
-- Must be a non-empty string
+- Must be a non-empty string.
 
 `PHONE_NUMBER`:
-
-- Must be a non-empty string
+- Must be a non-empty string.
 
 `ADDRESS`:
-
 - Must be a non-empty string
 
 `TASK_INDEX`:
-- Must be a valid index starts from 1
-</box>
-
-<box type="info" theme="warning">
-
-**Acceptable values for each parameter:**
+- Must be a valid index starts from 1.
 
-`GroupId`:
-- Must be in the format `grp-XXX` where `XXX` is replaceable with any 3 digit number
-  - eg. `grp-001`
-
-`StudentId`:
-- Must be in the format `XXXX_` where `XXX` is replaceable with any 4 digit number and `_` is replaceable with any 
-capitalised alphabet.
-- This format accurately reflects the last 5 place of an NUS student's matriculation number while maintaining privacy and 
-security.
-  - eg. `8467U`
-
-
-  </box>
+</box>
 
 ---
 
@@ -227,47 +220,44 @@ Changes the current directory in the ProfBook.
 #### Acceptable values for each parameter:
 
 `SPECIFIED_PATH`:
-
-- must be a valid path to a group, student or root. 
+- Must be a valid path to a group, student or root. 
 
 <box type="success" seamless>
 
 #### Output if command succeeds:
-
-- displays message indicating successful navigation to target path.
+- Displays message indicating successful navigation to target path.
 
 </box>
 
 <box type="wrong" seamless>
 
 #### Output if command fails:
-
 - Displays message indicating either:
   - Invalid command format
   - Invalid path
 
 </box>
 
-#### Examples:
+#### Example(s):
 - When you are at the directory `~/grp-001` and would like to change directory from `grp-001` to `grp-002` you could
 use the command:
   -  `cd ../grp-002`
 
 ### Display Directories : `ls`
 
-Shows the list of children in the current directory
+Shows the list of children in specified directory. 
 
 **Format:** `ls [SPECIFIED_PATH]`
 
 #### Acceptable values for each parameter:
 
 `[SPECIFIED_PATH]`:
-
-- Must be a valid path to a group or root
+- (Optional)
+- Must be a valid path to a group or root.
 
 <box type="info">
   
-  If no `[SPECIFIED_PATH]` is given, the `ls` command will default to the current directory.
+  If `[SPECIFIED_PATH]` is provided, the `ls` command show the list of children in the current directory.
 
 </box>
 
@@ -285,17 +275,17 @@ Shows the list of children in the current directory
 #### Output if command fails:
 
 Displays message indicating either:
-  - Invalid command format
-  - Invalid path
+  - Invalid command format.
+  - Invalid path.
 
 </box>
 
-#### Examples:
+#### Example(s):
 
 - When you are at the directory `~/grp-001` and would like to see the students under `grp-001`,
-    - `ls` will return all the students in grp-001
-- When you are at the root directory `~/` and would like to see all groups you have,
-    - `ls` will return all the current groups
+    - `ls` will return all the students in `grp-001`.
+- When you are at the root directory `~/` and would like to see all the groups you have,
+    - `ls` will return all the current groups.
 
 ### Displays all tasks: `cat`
 
@@ -305,35 +295,36 @@ Displays all tasks depending on the directory you are at.
 
 #### Acceptable values for parameter:
 
-`SPECIFIED_PATH`:
-- Must be a valid path to group or student
-- Cannot be a path to root
+`[SPECIFIED_PATH]`:
+- (Optional)
+- Must be a valid path to a group or student.
+- Must **not** be a path to root. 
 
 <box type="success" seamless>
 
 #### Output if command succeeds:
-
-- Displays list of tasks assigned under input Path
+- Displays list of tasks assigned under input path. 
 
 </box>
 
 <box type="wrong" seamless>
 
 #### Output if command fails:
-If `cat` in root directory
-- Displays message indicating that tasks cannot be shown within root directory.
+- If `cat` in root directory,
+  - Displays message indicating that task list cannot be shown within root directory.
 
-If `cat` with invalid parameter
-- Displays message showing invalid path with user entered Path.
+- If `cat` with invalid parameter, 
+  - Displays message showing invalid path with user's input Path.
 
 </box>
 
-#### Examples:
+#### Example(s):
 - When you are at the directory `~/grp-001` and would like to see all tasks allocated to `grp-001`,
   - `cat` will return all the tasks allocated to grp-001.
-- If you are at the directory `~/grp-001` and would like take a quick look of the tasks allocated to student `0010Y`,
-  - `cat 0010Y` will return all the tasks allocated to student of studentId, `0010Y`.
-
+<box type="tip">
+If you are at the directory `~/grp-001` and would like take a quick look of the tasks allocated to student `0010Y`,
+- `cat 0010Y` will return all the tasks allocated to student of studentId, `0010Y`.
+<box>
 ---
 
 <div class="page-break-before">
@@ -356,14 +347,13 @@ Adds a student into the specified directory.
 #### Acceptable values for each parameter:
 
 `SPECIFIED_PATH`:
-
-- must be a valid path to a student
+- Must be a valid path to a student.
 
 <box type="success" seamless>
 
 #### Output if command succeeds:
 
-- Displays message indicating successful creation together with information of the new student.
+- Displays message indicating successful creation and information of the new student.
 
 </box>
 
@@ -372,49 +362,48 @@ Adds a student into the specified directory.
 #### Output if command fails:
 
 - Displays message indicating either:
-    - Invalid command format
-    - Invalid path
+  - Invalid command format.
+  - Invalid path.
 
 </box>
 
-#### Examples:
+#### Example(s):
 
 - When you are at the directory `~/grp-001`, you could add a new student to this group through this command,
   - `touch stu-200 --name Bob`
 
 <box type="tip">
-
-- When you are at the directory `~/grp-001` and would like to add a new student, Bob, to another directory 
-`~/grp-001`,
-  - You could use the command `touch ~/grp-002/0200Y --name Bob` to save yourself the hassle for having to change 
-  directory!
+##### ProTip:
+When you are at the directory `~/grp-001` and would like to add a new student, Bob, to another directory 
+`~/grp-002`, 
+- You could use the command `touch ~/grp-002/0200Y --name Bob` to save yourself the trouble for having to change 
+  directory before executing the `touch` command!
 
 </box>
 
 #### To note:
 
-- When the command is executed from within the group or if the specified path indicates the group, it creates a student 
-within that group.
-- However, if the command is executed outside a specific group, the specified path should extend to encompass both the 
+- When the command is executed from the group directory or if the specified path indicates the group, it creates a 
+student within that group.
+- However, if the command is executed outside a specific group, the specified path must extend to encompass both the 
 group and the student to ensure accurate execution.
 
-### Delete a Student or Group: `rm`
+### Deletes a Student or Group: `rm`
 
-Deletes a student/group from the specified directory.
+Removes a student or group from the specified directory.
 
 **Format:** `rm SPECIFIED_PATH`
 
 #### Acceptable values for each parameter:
 
 `SPECIFIED_PATH`:
-
-- must be a valid path to a student or group that user wants to delete
+- Must be a valid path to a student or group that user wants to delete.
 
 <box type="success" seamless>
 
 #### Output if command succeeds
 
-- Displays message indicating target successfully removed
+- Displays message indicating successfully removal of student or group. 
 
 </box>
 
@@ -423,20 +412,19 @@ Deletes a student/group from the specified directory.
 #### Output if command fails:
 
 - Displays message indicating either:
-    - Invalid command format
-    - No such target to delete
+    - Invalid command format.
+    - No such student or group to delete.
 
 </box>
 
-#### Examples:
+#### Example(s):
 
 - When you are at the root directory `~/` and would like to remove the group, `grp-001`,
     - `rm grp-001` will remove grp-001
 
 <box type="tip">
 
-- When you are at the directory `~/` and would like to remove the student with the StudentId, `0123Y`, in `grp-001`
-  `~/grp-001`,
+- When you are at the directory `~/` and would like to remove the student with the StudentId, `0123Y`, in `~/grp-001`,
   - You could use the command `rm ~/grp-001/0123Y` to save yourself the hassle for having to change directory!
 
 </box>
@@ -462,7 +450,7 @@ Moves student from one group to another group.
 
 #### Output if command succeeds
 
-- Displays message to indicate the successful transfer of a student from one group to another group
+- Displays message to indicate the successful transferal of a student from one group to another.
 
 </box>
 
@@ -477,36 +465,33 @@ Moves student from one group to another group.
 
 </box>
 
-#### Examples:
-- In the beginning of the semester, student transfer from groups are common. When you are at the root directory `~` and 
-would like to move a student from `grp-001` to `grp-002`,
+#### Example(s):
+- In the beginning of the semester, student transfers amongst groups are common. When you are at the root directory 
+`~/` you could move a student, `0123Y` from `grp-001` to `grp-002` through this command,
   - `mv grp-001/0123Y grp-002`
 
 <box type="tip">
 
-- When user is at the group directory `~/grp-001` and keys in the following command, student with specified path `~/grp-001/0123Y` will be moved from grp-001 to grp-002:
-  - `mv 0123Y ../grp-002`
-- When you are at the directory `~/grp-001` and would like to move a student to `grp-002` without changing to the root directory,
+- When you are at the directory `~/grp-001` and would like to move a student to `grp-002` without changing to the 
+root directory,
   - You could use the command `mv 0123Y ../grp-002`!
 
 </box>
 
 ### Create Group : `mkdir`
 
-Creates a group consisting of students.
+Creates a group that can contain students.
 
 **Format:** `mkdir SPECIFIED_PATH_TO_GROUP`
 
 #### Acceptable values for each parameter:
 
 `SPECIFIED_PATH_TO_GROUP`:
-
-- Must be a valid path to a group
+- Must be a valid path to a group.
 
 <box type="success" seamless>
 
 #### Output if command succeeds
-
 - Displays message indicating group with specific GroupId is created successfully.
 
 </box>
@@ -521,7 +506,7 @@ Creates a group consisting of students.
 
 </box>
 
-#### Examples:
+#### Example(s):
 
 - When you are at the root directory `~/` and would like to add a new group with GroupId `grp-001`, 
   - `mkdir grp-001`
@@ -529,11 +514,13 @@ Creates a group consisting of students.
 ### View help : `help`
 
 Shows a message explaining how to access the help page.
+
 **Format:** `help`
 
 ### Clearing all entries : `clear`
 
 Clears all entries from the address book.
+
 **Format:** `clear`
 
 <box type="tip">
@@ -544,13 +531,16 @@ students and groups, making way for the addition of new students.
 ### Exiting the program : `exit`
 
 Exits the program.
+
 **Format:** `exit`
 
 <box type="tip">
 
-This command is beneficial if you prefer not to switch to mouse usage in order to click on the cross button located in 
-the top left corner of the window.
+
+This command is a time-saver for those who would rather avoid using the mouse to click on the close button 
+positioned in the top-left corner of the window.
 </box>
+
 ---
 
 <div class="page-break-before">
@@ -566,8 +556,11 @@ Creates todo tasks for specific student(s) or group(s).
 **Format:** `todo SPECIFIED_PATH --desc DESCRIPTION [--all CATERGORY]`
 
 - `--desc` / `-d` : Description of the todo task
-- `--all` / `-al` : (Optional) Either `allStu` or `allGrp` to add a deadline task to all students or groups in the
+- `--all` / `-al` : (Optional) Either `allStu` or `allGrp` to add a todo task to all students/groups in the
   specified path
+  - `allStu` can only be used at a group directory.
+  - `allGrp` can only be used at root directory.
+
 
 <box type="success" seamless>
 
@@ -587,15 +580,15 @@ Creates todo tasks for specific student(s) or group(s).
 
 </box>
 
-#### Examples:
+#### Example(s):
 
-- When a specific student has to redo his tutorial, you could use the following command when you are in the directory 
-`~/grp-001` to allocate the task to this student,
-    - `todo 0001Y --desc Redo tutorial `
+- When a specific student, `0010Y`, has to redo his tutorial, you could use the following command when you are in the directory 
+`~/grp-001` to allocate the task to just this student,
+    - `todo 0001Y --desc Redo tutorial`
 
 <box type="tip">
 
-- When you have an assignment, `Assignment 1` to be allocated to all your students in `grp-001`, you could use the 
+- When you have an assignment, `Assignment 1` to be allocated to **all your students** in `grp-001`, you could use the 
 following command, 
   - `todo ~/grp-001 --desc Assignment 1 --all allStu`
 
@@ -609,7 +602,7 @@ Creates task with a deadline for specific student(s) or group(s).
 **Format:** `deadline SPECIFIED_PATH --desc DESCRIPTION --datetime DATE_AND_TIME [--all CATERGORY]`
 
 - `--desc` / `-d` : Description of the deadline task
-- `--datetime` / `-dt` : The duedate of the task. In the following format: `yyyy-MM-dd HH:mm`
+- `--datetime` / `-dt` : Duedate of task in `yyyy-MM-dd HH:mm` format. 
 - `--all` / `-al` : (Optional) Either `allStu` or `allGrp` to add a deadline task to all students/groups in the
   specified path
   - `allStu` can only be used at a group directory.
@@ -619,7 +612,7 @@ Creates task with a deadline for specific student(s) or group(s).
 
 #### Output if command succeeds
 
-- Displays message indicating deadline task created successfully.
+- Displays message indicating the successful creation of the deadline task.
 
 </box>
 
@@ -633,15 +626,15 @@ Creates task with a deadline for specific student(s) or group(s).
 
 </box>
 
-#### Examples:
+#### Example(s):
 
 - When a specific student has to hand in his assignment again by a certain date, 
 you could use the following command when you are in the directory `~/grp-001`,
-  - `deadline 0001Y- --desc resubmit Assignment 1 --datetime 2023-10-11 23:59`
+  - `deadline 0001Y --desc resubmit Assignment 1 --datetime 2023-10-11 23:59`
 
 <box type="tip">
 
-- When you have a task, `Project 1 submission` with deadline to be allocated to all your groups, 
+- When you have a task, `Project 1 submission` with a deadline to be allocated to **all your groups**, 
 you could use the following command at the root directory, `~/`,
   - `deadline ~/ --desc Project 1 submission --datetime 2023-10-11 23:59 --all allGrp`
 
@@ -649,7 +642,7 @@ you could use the following command at the root directory, `~/`,
 
 ### Mark tasks as completed: `mark`
 
-Marks the specified task as done for the student or group. 
+Marks the specified task as done for the specified student or group. 
 
 **Format:** `mark TASK_INDEX`
 
@@ -658,7 +651,7 @@ Marks the specified task as done for the student or group.
 
 #### Output if command succeeds
 
-- Displays message indicating mark is done successfully as well as specific task that is marked
+- Displays message indicating mark is done successfully as well as specific task that is marked.
 
 </box>
 
@@ -673,14 +666,14 @@ Marks the specified task as done for the student or group.
 
 </box>
 
-#### Examples:
-  <box type="warning">
+<box type="warning">
 
-    When using this command, you will first need to `cat` at the path where the task list is at before `mark`.
+When using this command, you will first need to `cat` at the path where the task list is at before `mark`.
+</box>
 
-  </box>
+#### Example(s):
 
-- You are at `~/grp-001` would like to mark the first task allocated to student with StudentId, `0123Y`,
+- When you are at `~/grp-001` and would like to mark the first task allocated to student with StudentId, `0123Y`,
   - `cat 0123Y`
   - `mark 1`
 
@@ -694,7 +687,7 @@ Unmarks the specified task for the student or group.
 
 #### Output if command succeeds:
 
-- displays message indicating either:
+- Displays message indicating either:
   - Invalid command format.
   - Invalid task index.
   - The display panel is not showing task list.
@@ -709,12 +702,12 @@ Unmarks the specified task for the student or group.
 
 </box>
 
-#### Examples:
-  <box type="warning">
+<box type="warning">
 
-    When using this command, you will first need to `cat` at the path where the task list is at before `unmark`.
+When using this command, you will first need to `cat` at the path where the task list is at before `unmark`.
+</box>
 
-  </box>
+#### Example(s):
 
 - You are at `~/grp-001` would like to unmark the first task allocated to student with StudentId, `0123Y`,
   - `cat 0123Y`
@@ -748,8 +741,8 @@ _Details coming soon ..._
 
 ## FAQ
 
-**Q**: How do I transfer my data to another Computer?<br>
-**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains
+**Q**: How do I transfer my data to another computer?<br>
+**A**: Install ProfBook in the other computer and overwrite the empty data file it creates with the file that contains
 the data of your previous ProfBook home folder.
 
 ---
@@ -768,16 +761,18 @@ the data of your previous ProfBook home folder.
 
 
 ## Command summary
-| Action              | Format, Examples|
-|:------              |:------|
-| **Help**            | `help` |
-| **Change Directory**| `cd SPECIFIED_PATH` <br> e.g., `cd ../grp-001`|
-| **Display Directories**| `ls SPECIFIED_PATH` <br> e.g., `ls grp-001`|
-| **Display Task List**  | `cat SPECIFIED_PATH`<br> e.g., `cat 1234A, cat grp-001`|
-| **Add Student**     | `touch SPECIFIED_PATH -n NAME -e EMAIL - p PHONE_NUMBER -a ADDRESS` <br> e.g., `touch stu-200 --name Bob --email bobby@example.com --phone 92929292 --address blk 258 Toa Payoh ` |
-| **Create Group**    | `mkdir [groupId]` <br> e.g., `mkdir grp-1`|
-| **Delete**          | `rm SPECIFIED_PATH` <br> e.g., `rm 0123Y`, `rm grp-002`|
-| **Create Todo**     | `todo SPECIFIED_PATH --desc DESCRIPTION --all CATERGORY` <br> e.g., `todo stu-001 --desc Assignment 1|
-| **Create Deadline** | `deadline SPECIFIED_PATH --desc DESCRIPTION --datetime DATE_AND_TIME --all CATERGORY`<br> e.g., `deadline stu-001 --desc Assignment 1 --datetime 2023-10-11 23:59 `|
-| **Mark**            | `mark TASK_INDEX`<br> e.g.,`mark 1`|
-| **Unmark**          | `unmark TASK_INDEX`<br> e.g.,`unmark 2`|
+| Action                  | Format, Example(s)                                                                                                                                                                      |
+|:------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Help**                | `help`                                                                                                                                                                                  |
+| **Clear all entries**   | `clear`                                                                                                                                                                                 |
+| **Exits the program**   | `exit`                                                                                                                                                                                  |
+| **Change Directory**    | `cd SPECIFIED_PATH` <br> e.g., `cd ../grp-001`                                                                                                                                          |
+| **Display Directories** | `ls [SPECIFIED_PATH]` <br> e.g., `ls grp-001`                                                                                                                                           |
+| **Display Task List**   | `cat [SPECIFIED_PATH]`<br> e.g., `cat 1234A, cat grp-001`                                                                                                                               |
+| **Add Student**         | `touch SPECIFIED_PATH -n NAME [-e EMAIL] [- p PHONE_NUMBER] [-a ADDRESS]` <br> e.g., `touch stu-200 --name Bob --email bobby@example.com --phone 92929292 --address blk 258 Toa Payoh ` |
+| **Create Group**        | `mkdir [groupId]` <br> e.g., `mkdir grp-1`                                                                                                                                              |
+| **Delete**              | `rm SPECIFIED_PATH` <br> e.g., `rm 0123Y`, `rm grp-002`                                                                                                                                 |
+| **Create Todo**         | `todo SPECIFIED_PATH --desc DESCRIPTION --all CATERGORY` <br> e.g., `todo stu-001 --desc Assignment 1                                                                                   |
+| **Create Deadline**     | `deadline SPECIFIED_PATH --desc DESCRIPTION --datetime DATE_AND_TIME --all CATERGORY`<br> e.g., `deadline stu-001 --desc Assignment 1 --datetime 2023-10-11 23:59 `                     |
+| **Mark**                | `mark TASK_INDEX`<br> e.g.,`mark 1`                                                                                                                                                     |
+| **Unmark**              | `unmark TASK_INDEX`<br> e.g.,`unmark 2`                                                                                                                                                 |

From c2e0e28d73ec94b28ba70651270ca8b0ea925fad Mon Sep 17 00:00:00 2001
From: Loo Mei Lin Zann <>
Date: Mon, 30 Oct 2023 20:16:19 +0800
Subject: [PATCH 05/15] Edit formatting

---
 docs/UserGuide.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index 05ab27494da..9e6490890fe 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -133,7 +133,7 @@ or group** and track their progress.
 
 <box type="info" theme="warning">
 
-**Acceptable values for each parameter:**
+**Acceptable values for each Id:**
 
 `GroupId`:
 - Must be in the format `grp-XXX` where `XXX` is replaceable with any 3 digit number
@@ -321,10 +321,14 @@ Displays all tasks depending on the directory you are at.
 #### Example(s):
 - When you are at the directory `~/grp-001` and would like to see all tasks allocated to `grp-001`,
   - `cat` will return all the tasks allocated to grp-001.
+
 <box type="tip">
+
 If you are at the directory `~/grp-001` and would like take a quick look of the tasks allocated to student `0010Y`,
 - `cat 0010Y` will return all the tasks allocated to student of studentId, `0010Y`.
+
 <box>
+
 ---
 
 <div class="page-break-before">

From 48a4b7b6e4cd186508362691e734fbf9fa6ed16a Mon Sep 17 00:00:00 2001
From: Loo Mei Lin Zann <>
Date: Mon, 30 Oct 2023 20:18:19 +0800
Subject: [PATCH 06/15] Update formatting

---
 docs/UserGuide.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index 9e6490890fe..ddbaa00d30e 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -327,7 +327,7 @@ Displays all tasks depending on the directory you are at.
 If you are at the directory `~/grp-001` and would like take a quick look of the tasks allocated to student `0010Y`,
 - `cat 0010Y` will return all the tasks allocated to student of studentId, `0010Y`.
 
-<box>
+</box>
 
 ---
 
@@ -377,7 +377,7 @@ Adds a student into the specified directory.
   - `touch stu-200 --name Bob`
 
 <box type="tip">
-##### ProTip:
+
 When you are at the directory `~/grp-001` and would like to add a new student, Bob, to another directory 
 `~/grp-002`, 
 - You could use the command `touch ~/grp-002/0200Y --name Bob` to save yourself the trouble for having to change 

From 67a4f5223e5e706a092db178869ee103688193b2 Mon Sep 17 00:00:00 2001
From: Loo Mei Lin Zann <>
Date: Mon, 30 Oct 2023 21:47:23 +0800
Subject: [PATCH 07/15] Include Edit Command

---
 docs/UserGuide.md | 134 +++++++++++++++++++++++++++++++++-------------
 1 file changed, 96 insertions(+), 38 deletions(-)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index ddbaa00d30e..b3aa78a4596 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -179,7 +179,23 @@ multiple lines as space characters surrounding line-breaks may be omitted when c
 
 </box>
 
-<box type="info" theme="warning">
+<box type="info">
+
+**Flags:**
+Flags comes before essential details required by the command and come in both long and short forms:
+
+- `--name` / `-n` followed by name of student or group specified by command.
+- `--email` / `-e` followed by email of student. 
+- `--desc` followed by description of task specified by command.
+- `--phone` / `-p` followed by phone number of student.
+- `--datetime` / `-dt` followed by due date of a deadline task in the `yyyy-MM-dd HH:mm` format.  
+- `--all` / `-al` followed by either `allStu` or `allGrp` to add a task to all students or groups in the  
+  - `allStu` can only be used at a group directory.  
+  - `allGrp` can only be used at root directory.  <box type="info" theme="warning">
+
+</box>
+
+<box type="info" theme = "warning"> 
 
 **Acceptable values for each parameter:**
 
@@ -257,7 +273,7 @@ Shows the list of children in specified directory.
 
 <box type="info">
   
-  If `[SPECIFIED_PATH]` is provided, the `ls` command show the list of children in the current directory.
+  If `[SPECIFIED_PATH]` is not provided, the `ls` command show the list of children in the current directory.
 
 </box>
 
@@ -287,7 +303,7 @@ Displays message indicating either:
 - When you are at the root directory `~/` and would like to see all the groups you have,
     - `ls` will return all the current groups.
 
-### Displays all tasks: `cat`
+### Display all tasks: `cat`
 
 Displays all tasks depending on the directory you are at.
 
@@ -343,11 +359,6 @@ Adds a student into the specified directory.
 
 **Format:** `touch SPECIFIED_PATH -n NAME [-e EMAIL] [-p PHONE_NUMBER] [-a ADDRESS]`
 
-- `--name` / `-n` : Name of Student
-- `--email` / `-e` : Email of Student
-- `--phone` / `-p`: Phone number of Student
-- `--address` / `-a`: Address of Student
-
 #### Acceptable values for each parameter:
 
 `SPECIFIED_PATH`:
@@ -392,6 +403,55 @@ student within that group.
 - However, if the command is executed outside a specific group, the specified path must extend to encompass both the 
 group and the student to ensure accurate execution.
 
+### Edit a student: `edit`
+Edits a student's details including name, email, phone or address in the specified path. 
+One or more fields can be edited in a single command.
+
+**Format:** `edit [SPECIFIED_PATH] [-n NAME] [-e EMAIL] [-p PHONE_NUMBER] [-a ADDRESS]`
+
+#### Acceptable values for each parameter:
+
+`SPECIFIED_PATH`:  
+- Must be a valid path to a student.
+
+<box type="info">
+
+If `[SPECIFIED_PATH]` is not provided, current directory must be a student directory.
+The `edit` command will edit the student at current directory.  
+</box>
+
+<box type="warning">
+
+At least one field (`NAME`, `EMAIL`, `PHONE_NUMBER` or `ADDRESS`) must be provided.
+</box>  
+<box type="success" seamless>
+
+#### Output if command succeeds: 
+- Displays message indicating successful edition of specified student. 
+
+</box>
+
+<box type="wrong" seamless> 
+
+#### Output if command fails: 
+- Displays message indicating either:
+  - Invalid command format.  
+  - Invalid path. 
+  - At least one field to edit must be provided.
+
+</box>
+
+#### Example(s):        
+  
+- If a student in `grp-001` of StudentId `0010Y` changes his phone number, you could execute the following command 
+at the directory `~/grp-001`, to make the necessary changes. 
+  - `edit 0010Y --phone 91919191`
+<box type="tip">  
+
+When you are at the root directory `~/` and would like to edit the same student's phone number,
+- You could use the command `edit ~/grp-001/0010Y --phone 91919191` to save yourself the trouble for having to change 
+directory before executing the `touch` command! 
+ 
 ### Deletes a Student or Group: `rm`
 
 Removes a student or group from the specified directory.
@@ -428,8 +488,8 @@ Removes a student or group from the specified directory.
 
 <box type="tip">
 
-- When you are at the directory `~/` and would like to remove the student with the StudentId, `0123Y`, in `~/grp-001`,
-  - You could use the command `rm ~/grp-001/0123Y` to save yourself the hassle for having to change directory!
+When you are at the directory `~/` and would like to remove the student with the StudentId, `0123Y`, in `~/grp-001`,
+- You could use the command `rm ~/grp-001/0123Y` to save yourself the hassle for having to change directory!
 
 </box>
 
@@ -476,9 +536,9 @@ Moves student from one group to another group.
 
 <box type="tip">
 
-- When you are at the directory `~/grp-001` and would like to move a student to `grp-002` without changing to the 
+When you are at the directory `~/grp-001` and would like to move a student to `grp-002` without changing to the 
 root directory,
-  - You could use the command `mv 0123Y ../grp-002`!
+- You could use the command `mv 0123Y ../grp-002`!
 
 </box>
 
@@ -557,14 +617,18 @@ positioned in the top-left corner of the window.
 
 Creates todo tasks for specific student(s) or group(s).
 
-**Format:** `todo SPECIFIED_PATH --desc DESCRIPTION [--all CATERGORY]`
+**Format:** `todo [SPECIFIED_PATH] --desc DESCRIPTION [--all CATERGORY]`
+
+#### Acceptable values for each parameter: 
 
-- `--desc` / `-d` : Description of the todo task
-- `--all` / `-al` : (Optional) Either `allStu` or `allGrp` to add a todo task to all students/groups in the
-  specified path
-  - `allStu` can only be used at a group directory.
-  - `allGrp` can only be used at root directory.
+`[SPECIFIED_PATH]`:    
+- Must be a valid path to a student or group. 
+
+<box type="info">
 
+If `[SPECIFIED_PATH]` is not provided, current directory must be a student or group directory.
+The `todo` command will create todo task for the student or group at current directory.
+</box>
 
 <box type="success" seamless>
 
@@ -592,9 +656,9 @@ Creates todo tasks for specific student(s) or group(s).
 
 <box type="tip">
 
-- When you have an assignment, `Assignment 1` to be allocated to **all your students** in `grp-001`, you could use the 
+When you have an assignment, `Assignment 1` to be allocated to **all your students** in `grp-001`, you could use the 
 following command, 
-  - `todo ~/grp-001 --desc Assignment 1 --all allStu`
+- `todo ~/grp-001 --desc Assignment 1 --all allStu`
 
 </box>
 
@@ -603,24 +667,17 @@ following command,
 
 Creates task with a deadline for specific student(s) or group(s).
 
-**Format:** `deadline SPECIFIED_PATH --desc DESCRIPTION --datetime DATE_AND_TIME [--all CATERGORY]`
-
-- `--desc` / `-d` : Description of the deadline task
-- `--datetime` / `-dt` : Duedate of task in `yyyy-MM-dd HH:mm` format. 
-- `--all` / `-al` : (Optional) Either `allStu` or `allGrp` to add a deadline task to all students/groups in the
-  specified path
-  - `allStu` can only be used at a group directory.
-  - `allGrp` can only be used at root directory.
-
-<box type="success" seamless>
-
-#### Output if command succeeds
+**Format:** `deadline [SPECIFIED_PATH] --desc DESCRIPTION --datetime DATE_AND_TIME [--all CATERGORY]`
 
-- Displays message indicating the successful creation of the deadline task.
+#### Acceptable values for each parameter:  
+`[SPECIFIED_PATH]`:
+- Must be a valid path to a student.
 
-</box>
+<box type="info">
 
-<box type="wrong" seamless>
+If `[SPECIFIED_PATH]` is not provided, current directory must be a student or group directory.
+The `deadline` command will create task with deadline for the student or group at current directory.
+</box> 
 
 #### Output if command fails:
 
@@ -638,9 +695,9 @@ you could use the following command when you are in the directory `~/grp-001`,
 
 <box type="tip">
 
-- When you have a task, `Project 1 submission` with a deadline to be allocated to **all your groups**, 
+When you have a task, `Project 1 submission` with a deadline to be allocated to **all your groups**, 
 you could use the following command at the root directory, `~/`,
-  - `deadline ~/ --desc Project 1 submission --datetime 2023-10-11 23:59 --all allGrp`
+- `deadline ~/ --desc Project 1 submission --datetime 2023-10-11 23:59 --all allGrp`
 
 </box>
 
@@ -769,11 +826,12 @@ the data of your previous ProfBook home folder.
 |:------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **Help**                | `help`                                                                                                                                                                                  |
 | **Clear all entries**   | `clear`                                                                                                                                                                                 |
-| **Exits the program**   | `exit`                                                                                                                                                                                  |
+| **Exit the program**    | `exit`                                                                                                                                                                                  |
 | **Change Directory**    | `cd SPECIFIED_PATH` <br> e.g., `cd ../grp-001`                                                                                                                                          |
 | **Display Directories** | `ls [SPECIFIED_PATH]` <br> e.g., `ls grp-001`                                                                                                                                           |
 | **Display Task List**   | `cat [SPECIFIED_PATH]`<br> e.g., `cat 1234A, cat grp-001`                                                                                                                               |
 | **Add Student**         | `touch SPECIFIED_PATH -n NAME [-e EMAIL] [- p PHONE_NUMBER] [-a ADDRESS]` <br> e.g., `touch stu-200 --name Bob --email bobby@example.com --phone 92929292 --address blk 258 Toa Payoh ` |
+| **Edit Student**        | `edit SPECIFIED_PATH [-n NAME] [-e EMAIL] [-p PHONE_NUMBER] [-a ADDRESS]` <br> e.g., `edit 0010Y --phone 91919191`                                                                      |
 | **Create Group**        | `mkdir [groupId]` <br> e.g., `mkdir grp-1`                                                                                                                                              |
 | **Delete**              | `rm SPECIFIED_PATH` <br> e.g., `rm 0123Y`, `rm grp-002`                                                                                                                                 |
 | **Create Todo**         | `todo SPECIFIED_PATH --desc DESCRIPTION --all CATERGORY` <br> e.g., `todo stu-001 --desc Assignment 1                                                                                   |

From bed5902186989a967ac399fbdd6a9d1077834d0e Mon Sep 17 00:00:00 2001
From: Loo Mei Lin Zann <>
Date: Mon, 30 Oct 2023 22:05:26 +0800
Subject: [PATCH 08/15] Edit incorrect formatting

---
 docs/UserGuide.md | 40 +++++++++++++++++++++-------------------
 1 file changed, 21 insertions(+), 19 deletions(-)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index b3aa78a4596..3c551143456 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -14,7 +14,7 @@ As current students of CS2103T, we understand that CS2103T tutors have a high ad
 existing tutor duties. On top of that, any administrative mistakes or oversights can increase that workload 
 exponentially and may adversely impact student's learning. We deeply appreciate your role, and it is precisely to 
 address these aforementioned issues that we designed ProfBook. ProfBook aims to
-**drastically decrease administrative mistakes and your administrative workload**.
+**drastically decrease administrative mistakes and your workload**.
 
 ProfBook is optimized for tutors' use via a **familiar Command Line Interface (CLI) that uses linux-styled commands** 
 while retaining the benefits of a Graphical User Interface (GUI). If you are a fast typer, ProfBook will empower you 
@@ -27,20 +27,20 @@ with a gentle learning curve.
 
 ### Consolidated Information
 
-As a project-based module, CS2103T tutors have to juggle multiple groups **within** multiple tutorial slots. ProfBook
-aims to expedite this process by allowing you keep track of all your groups and their progress within a centralised 
+As a project-based module, CS2103T tutors have to juggle multiple groups. ProfBook
+aims to expedite this process by allowing you to keep track of all your groups and their progress within a centralised 
 location. You would be able to traverse between the different groups quickly through familiar Linux commands.
 
 ### Student and Group Management
 
 ProfBook aids with the **management of student and group information**. ProfBook efficiently encapsulates information of 
-every project group so that you can easily monitor their progress and relevant information seamlessly.  You can 
+every project group so that you can easily monitor their progress and relevant information.  You can 
 effortlessly **add, delete and edit students or groups** and even **move students from one group to another**.
 
 ### Task Management
 
-ProfBook aids with the **management of task information**.  You can quickly **allocate tasks to specific student 
-or group** and track their progress. 
+ProfBook aids with the **management of task information**.  You can quickly and seamlessly **allocate tasks to 
+specific student or group** and track their progress. 
 
 <div class="page-break-before">
     <!-- Content that will start on a new printed page -->
@@ -68,8 +68,6 @@ or group** and track their progress.
 
 1. Ensure you have Java `11` or above installed in your computer.
 
-1. ProfBook supports all operating systems.
-
 1. Download the latest `ProfBook.jar` from [here](https://github.com/AY2324S1-CS2103T-W15-2/tp/releases).
 
 1. Copy the file to the folder you want to use as the _home folder_ for your ProfBook.
@@ -93,7 +91,7 @@ or group** and track their progress.
 
     - `rm grp-001` : Deletes grp-001.
 
-1. Refer to the [General Commands](#general-commands), [Student/ Group Commands](#student-or-group-commands), [Task Commands](#tasks-command) below for details of each command.
+1. Refer to the [General Commands](#general-commands), [Student or Group Commands](#student-or-group-commands), [Tasks Commands](#tasks-command) below for details of each command.
 
 ---
 
@@ -159,11 +157,11 @@ or group** and track their progress.
 
 **Notes about the command format:**<br>
 
-- Words in `UPPER_CASE` are the parameters to be supplied by the user.
-  - e.g. In `touch SPECIFIED_PATH -n NAME`, `SPECIFIED_PATH` and the other fields in `UPPER_CASE` can be substituted 
+- Words in `UPPER_CASE` are the parameters to be supplied by you.
+  - e.g. In `touch SPECIFIED_PATH -n NAME`, `SPECIFIED_PATH` and the other field in `UPPER_CASE` can be substituted 
     with the desired details to form `touch stu-200 --name Bob`.
 
-- Words in `UPPER_CASE` and surrounded by `[square brackets]` are optional parameters to be supplied by the user.
+- Words in `UPPER_CASE` that are surrounded by `[square brackets]` are optional parameters to be supplied by you.
   - e.g. In `cat [SPECIFIED_PATH]`, `[SPECIFIED_PATH]` can be substituted with details or left empty, 
     `cat stu-200` and `cat` are acceptable commands. 
 
@@ -182,16 +180,18 @@ multiple lines as space characters surrounding line-breaks may be omitted when c
 <box type="info">
 
 **Flags:**
-Flags comes before essential details required by the command and come in both long and short forms:
+Flags come before essential details required by the command and come in both long and short forms:
 
 - `--name` / `-n` followed by name of student or group specified by command.
 - `--email` / `-e` followed by email of student. 
 - `--desc` followed by description of task specified by command.
 - `--phone` / `-p` followed by phone number of student.
 - `--datetime` / `-dt` followed by due date of a deadline task in the `yyyy-MM-dd HH:mm` format.  
-- `--all` / `-al` followed by either `allStu` or `allGrp` to add a task to all students or groups in the  
-  - `allStu` can only be used at a group directory.  
-  - `allGrp` can only be used at root directory.  <box type="info" theme="warning">
+- `--all` / `-al` followed by either: 
+  - `allStu` to add a task to all students.
+    - can only be used at a group directory.  
+  - `allGrp` to add a task to all groups.
+    - can only be used at root directory.
 
 </box>
 
@@ -268,12 +268,12 @@ Shows the list of children in specified directory.
 #### Acceptable values for each parameter:
 
 `[SPECIFIED_PATH]`:
-- (Optional)
+- (Optional) 
 - Must be a valid path to a group or root.
 
 <box type="info">
   
-  If `[SPECIFIED_PATH]` is not provided, the `ls` command show the list of children in the current directory.
+  If `[SPECIFIED_PATH]` is not provided, the `ls` command shows the list of children in the current directory.
 
 </box>
 
@@ -451,7 +451,9 @@ at the directory `~/grp-001`, to make the necessary changes.
 When you are at the root directory `~/` and would like to edit the same student's phone number,
 - You could use the command `edit ~/grp-001/0010Y --phone 91919191` to save yourself the trouble for having to change 
 directory before executing the `touch` command! 
- 
+    
+</box>
+
 ### Deletes a Student or Group: `rm`
 
 Removes a student or group from the specified directory.

From 832da5774d33cf885b84a66873fb00b05d152503 Mon Sep 17 00:00:00 2001
From: Loo Mei Lin Zann <>
Date: Tue, 31 Oct 2023 09:20:08 +0800
Subject: [PATCH 09/15] Edit spelling and format

---
 docs/UserGuide.md | 66 +++++++++++++++++++++++++++++------------------
 1 file changed, 41 insertions(+), 25 deletions(-)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index 3c551143456..6b330d2028c 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -138,7 +138,7 @@ specific student or group** and track their progress.
   - eg. `grp-001`
 
 `StudentId`:
-- Must be in the format `XXXX_` where `XXX` is replaceable with any 4 digit number and `_` is replaceable with any
+- Must be in the format `XXXX_` where `XXXX` is replaceable with any 4 digit number and `_` is replaceable with any
   capitalised alphabet.
 - This format accurately reflects the last 5 place of an NUS student's matriculation number while maintaining privacy and
   security.
@@ -172,6 +172,8 @@ specific student or group** and track their progress.
   ignored.
   - e.g. If the command specifies `help 123`, it will be interpreted as `help`.
 
+- Duplicate can only be detected if all field is exactly the same.
+
 - If you are using a PDF version of this document, please be careful when copying and pasting commands that span 
 multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
 
@@ -180,12 +182,13 @@ multiple lines as space characters surrounding line-breaks may be omitted when c
 <box type="info">
 
 **Flags:**
-Flags come before essential details required by the command and come in both long and short forms:
+Flags come before essential details required by the command and are compatible in both long and short forms:
 
 - `--name` / `-n` followed by name of student or group specified by command.
 - `--email` / `-e` followed by email of student. 
-- `--desc` followed by description of task specified by command.
 - `--phone` / `-p` followed by phone number of student.
+- `--address` / `-a` followed by address of student.
+- `--desc` followed by description of task specified by command.
 - `--datetime` / `-dt` followed by due date of a deadline task in the `yyyy-MM-dd HH:mm` format.  
 - `--all` / `-al` followed by either: 
   - `allStu` to add a task to all students.
@@ -236,7 +239,7 @@ Changes the current directory in the ProfBook.
 #### Acceptable values for each parameter:
 
 `SPECIFIED_PATH`:
-- Must be a valid path to a group, student or root. 
+- Must be a valid path to a student, group or root. 
 
 <box type="success" seamless>
 
@@ -257,7 +260,7 @@ Changes the current directory in the ProfBook.
 #### Example(s):
 - When you are at the directory `~/grp-001` and would like to change directory from `grp-001` to `grp-002` you could
 use the command:
-  -  `cd ../grp-002`
+  -  `cd ../grp-002` ->  type `..` to step up one level before proceeding to the `grp-002` directory.
 
 ### Display Directories : `ls`
 
@@ -273,7 +276,7 @@ Shows the list of children in specified directory.
 
 <box type="info">
   
-  If `[SPECIFIED_PATH]` is not provided, the `ls` command shows the list of children in the current directory.
+  If `[SPECIFIED_PATH]` is not provided, the `ls` command will show the list of children in the current directory.
 
 </box>
 
@@ -298,11 +301,15 @@ Displays message indicating either:
 
 #### Example(s):
 
-- When you are at the directory `~/grp-001` and would like to see the students under `grp-001`,
-    - `ls` will return all the students in `grp-001`.
 - When you are at the root directory `~/` and would like to see all the groups you have,
     - `ls` will return all the current groups.
 
+<box type="tip">
+
+- When you are at the root directory `~/` and would like to see the students under `grp-001`,
+  - `ls grp-001` will return all the students in `grp-001`.
+</box>
+  
 ### Display all tasks: `cat`
 
 Displays all tasks depending on the directory you are at.
@@ -385,22 +392,20 @@ Adds a student into the specified directory.
 #### Example(s):
 
 - When you are at the directory `~/grp-001`, you could add a new student to this group through this command,
-  - `touch stu-200 --name Bob`
+  - `touch 0200Y --name Bob`
 
 <box type="tip">
 
 When you are at the directory `~/grp-001` and would like to add a new student, Bob, to another directory 
 `~/grp-002`, 
-- You could use the command `touch ~/grp-002/0200Y --name Bob` to save yourself the trouble for having to change 
+- You could use the command `touch ../grp-002/0200Y --name Bob` to save yourself the trouble for having to change 
   directory before executing the `touch` command!
 
 </box>
 
 #### To note:
 
-- When the command is executed from the group directory or if the specified path indicates the group, it creates a 
-student within that group.
-- However, if the command is executed outside a specific group, the specified path must extend to encompass both the 
+- If the command is executed outside a specific group, the specified path must extend to encompass both the 
 group and the student to ensure accurate execution.
 
 ### Edit a student: `edit`
@@ -463,7 +468,7 @@ Removes a student or group from the specified directory.
 #### Acceptable values for each parameter:
 
 `SPECIFIED_PATH`:
-- Must be a valid path to a student or group that user wants to delete.
+- Must be a valid path to a student or group that you would like to delete.
 
 <box type="success" seamless>
 
@@ -490,13 +495,14 @@ Removes a student or group from the specified directory.
 
 <box type="tip">
 
-When you are at the directory `~/` and would like to remove the student with the StudentId, `0123Y`, in `~/grp-001`,
+When you are at the root directory `~/` and would like to remove the student with the StudentId, `0123Y`,
+in `~/grp-001`,
 - You could use the command `rm ~/grp-001/0123Y` to save yourself the hassle for having to change directory!
 
 </box>
 
 
-### Move Student or Group: `mv`
+### Move Student: `mv`
 
 Moves student from one group to another group.
 
@@ -506,11 +512,11 @@ Moves student from one group to another group.
 
 `SPECIFIED_PATH_TO_STUDENT`:
 
-- Must be a valid path to a student.
+- Must be a valid path to a student that you would like to move.
 
 `SPECIFIED_PATH_TO_GROUP`:
 
-- Must be a valid path to a group.
+- Must be a valid path to a group that you would like to move the student to.
 
 <box type="success" seamless>
 
@@ -533,7 +539,7 @@ Moves student from one group to another group.
 
 #### Example(s):
 - In the beginning of the semester, student transfers amongst groups are common. When you are at the root directory 
-`~/` you could move a student, `0123Y` from `grp-001` to `grp-002` through this command,
+`~/` you could move a student, `0123Y`, from `grp-001` to `grp-002` through this command easily,
   - `mv grp-001/0123Y grp-002`
 
 <box type="tip">
@@ -558,7 +564,7 @@ Creates a group that can contain students.
 <box type="success" seamless>
 
 #### Output if command succeeds
-- Displays message indicating group with specific GroupId is created successfully.
+- Displays message indicating successful creation and information of the new group.
 
 </box>
 
@@ -579,13 +585,13 @@ Creates a group that can contain students.
 
 ### View help : `help`
 
-Shows a message explaining how to access the help page.
+Shows a message of some commands you could use.
 
 **Format:** `help`
 
 ### Clearing all entries : `clear`
 
-Clears all entries from the address book.
+Clears all entries from the ProfBook.
 
 **Format:** `clear`
 
@@ -681,6 +687,16 @@ If `[SPECIFIED_PATH]` is not provided, current directory must be a student or gr
 The `deadline` command will create task with deadline for the student or group at current directory.
 </box> 
 
+<box type="success" seamless>
+
+#### Output if command succeeds
+
+- Displays message indicating the successful creation of the deadline task.
+
+</box>
+
+<box type="wrong" seamless>
+
 #### Output if command fails:
 
 - Displays message indicating either:
@@ -699,7 +715,7 @@ you could use the following command when you are in the directory `~/grp-001`,
 
 When you have a task, `Project 1 submission` with a deadline to be allocated to **all your groups**, 
 you could use the following command at the root directory, `~/`,
-- `deadline ~/ --desc Project 1 submission --datetime 2023-10-11 23:59 --all allGrp`
+- `deadline --desc Project 1 submission --datetime 2023-10-11 23:59 --all allGrp`
 
 </box>
 
@@ -731,7 +747,7 @@ Marks the specified task as done for the specified student or group.
 
 <box type="warning">
 
-When using this command, you will first need to `cat` at the path where the task list is at before `mark`.
+When using this command, you will first need to `cat` at the path where the task list is at before executing `mark`.
 </box>
 
 #### Example(s):
@@ -767,7 +783,7 @@ Unmarks the specified task for the student or group.
 
 <box type="warning">
 
-When using this command, you will first need to `cat` at the path where the task list is at before `unmark`.
+When using this command, you will first need to `cat` at the path where the task list is at before executing `unmark`.
 </box>
 
 #### Example(s):

From fefa4fe6486ba89c432a80518914bf21a68c7cf0 Mon Sep 17 00:00:00 2001
From: Loo Mei Lin Zann <>
Date: Wed, 1 Nov 2023 19:56:37 +0800
Subject: [PATCH 10/15] Test emoji

---
 docs/UserGuide.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index 6b330d2028c..d559eaebfd0 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -3,7 +3,7 @@ layout: default.md
 title: "User Guide"
 pageNav: 3
 ---
-# ProfBook User Guide
+# ProfBook User Guide :bulb:
 
 Welcome to ProfBook, a specialised **student management system** exclusively tailored for **CS2103T tutors** by CS2103T 
 students.  This guide is your gateway to unlocking the potential of ProfBook, where you will discover how ProfBook can 

From f32e812b9b925ea162309dfe43e17fd050ef6858 Mon Sep 17 00:00:00 2001
From: Loo Mei Lin Zann <>
Date: Wed, 1 Nov 2023 23:02:46 +0800
Subject: [PATCH 11/15] Update UG based on draft 1 comments

---
 docs/UserGuide.md      | 263 ++++++++++++++++++++++++++---------------
 docs/package-lock.json |  36 +++---
 2 files changed, 186 insertions(+), 113 deletions(-)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index d559eaebfd0..34ac466634c 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -9,7 +9,7 @@ Welcome to ProfBook, a specialised **student management system** exclusively tai
 students.  This guide is your gateway to unlocking the potential of ProfBook, where you will discover how ProfBook can 
 help streamline your administrative tasks, alleviate workload and most importantly reduce any administrative errors.
 
-## What can ProfBook do
+## What can ProfBook do :raising_hand:
 As current students of CS2103T, we understand that CS2103T tutors have a high administrative workload on top of their 
 existing tutor duties. On top of that, any administrative mistakes or oversights can increase that workload 
 exponentially and may adversely impact student's learning. We deeply appreciate your role, and it is precisely to 
@@ -39,8 +39,10 @@ effortlessly **add, delete and edit students or groups** and even **move student
 
 ### Task Management
 
-ProfBook aids with the **management of task information**.  You can quickly and seamlessly **allocate tasks to 
-specific student or group** and track their progress. 
+In addition to the efficient management of student and group information, ProfBook also aids with the 
+**management of task information**.  You can quickly and seamlessly **allocate tasks to specific student or group** 
+and track their progress. With ProfBook, you can easily monitor each stage of the task journey, 
+from start to finish, ensuring optimal productivity.
 
 <div class="page-break-before">
     <!-- Content that will start on a new printed page -->
@@ -99,13 +101,11 @@ specific student or group** and track their progress.
     <!-- Content that will start on a new printed page -->
 </div>
 
-## Understanding ProfBook
+## Understanding ProfBook :books:
 
-<box type="definition">
+### ProfBook Software Structure
 
-  **ProfBook Software Structure** <br>
-
-  ProfBook is organized hierarchically with the following structure:
+ProfBook is organized hierarchically with the following structure:
 
   <tree>
   ~/
@@ -123,65 +123,49 @@ specific student or group** and track their progress.
 
   **Group Directories (e.g., `grp-001`, `grp-002`, ...)**<br>
   Within the Root Directory, there are Group Directories. Each Group Directory is dedicated to managing a specific group of students.
+  
+<box type="info">
+
+  **Required format for `GroupId`:**
+  - Must be in the format `grp-XXX` where `XXX` is replaceable with any 3 digit number
+    - eg. `grp-001`
+  
+  </box>
 
-  **Student Directories (e.g., `1001Z`, `5815Y`, ...)**<br>
+**Student Directories (e.g., `1001Z`, `5815Y`, ...)**<br>
   Inside each Group Directory, you'll find Student Directories. These directories represent individual students within each group.
 
   This hierarchical structure enables a well-organized and efficient way to manage groups and students within ProfBook.
 
-<box type="info" theme="warning">
-
-**Acceptable values for each Id:**
-
-`GroupId`:
-- Must be in the format `grp-XXX` where `XXX` is replaceable with any 3 digit number
-  - eg. `grp-001`
-
-`StudentId`:
-- Must be in the format `XXXX_` where `XXXX` is replaceable with any 4 digit number and `_` is replaceable with any
+  <box type="info">
+  
+  **Required format for `StudentId`:**
+  - Must be in the format `XXXXA` where `XXXX` is replaceable with any 4 digit number and `A` is replaceable with any
   capitalised alphabet.
-- This format accurately reflects the last 5 place of an NUS student's matriculation number while maintaining privacy and
-  security.
-  - eg. `8467U`
+    - This format accurately reflects the last 5 place of an NUS student's matriculation number while maintaining 
+    privacy and security.
+      - eg. `8467U`
+    </box>
 
 
-  </box>
-</box>
-
-<div class="page-break-before">
-    <!-- Content that will start on a new printed page -->
-</div>
-
-
-<box type="info">
-
-**Notes about the command format:**<br>
+### ProfBook Command Format
 
 - Words in `UPPER_CASE` are the parameters to be supplied by you.
-  - e.g. In `touch SPECIFIED_PATH -n NAME`, `SPECIFIED_PATH` and the other field in `UPPER_CASE` can be substituted 
-    with the desired details to form `touch stu-200 --name Bob`.
-
-- Words in `UPPER_CASE` that are surrounded by `[square brackets]` are optional parameters to be supplied by you.
-  - e.g. In `cat [SPECIFIED_PATH]`, `[SPECIFIED_PATH]` can be substituted with details or left empty, 
-    `cat stu-200` and `cat` are acceptable commands. 
-
+  * e.g. In `touch SPECIFIED_PATH -n NAME`, `SPECIFIED_PATH` and the other field in `UPPER_CASE` can be substituted 
+  with the desired details to form `touch 2000Y --name Bob`.
+* Words in `UPPER_CASE` that are surrounded by `[square brackets]` are optional parameters to be supplied by you.
+  * e.g. In `cat [SPECIFIED_PATH]`, `[SPECIFIED_PATH]` can be substituted with details or left empty, 
+      `cat 2000Y` and `cat` are acceptable commands.
 - Parameters can be in any order.
-  - e.g. If the command specifies `-n NAME -e EMAIL`, `-e EMAIL -n NAME` is also acceptable.
-
-- Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be  
-  ignored.
-  - e.g. If the command specifies `help 123`, it will be interpreted as `help`.
-
+  * e.g. If the command specifies `-n NAME -e EMAIL`, `-e EMAIL -n NAME` is also acceptable.
+* Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be  
+  ignored. 
+  * e.g. If the command specifies `help 123`, it will be interpreted as `help`.
 - Duplicate can only be detected if all field is exactly the same.
-
-- If you are using a PDF version of this document, please be careful when copying and pasting commands that span 
+* If you are using a PDF version of this document, please be careful when copying and pasting commands that span 
 multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
 
-</box>
-
-<box type="info">
-
-**Flags:**
+### Flags :triangular_flag_on_post::triangular_flag_on_post::triangular_flag_on_post:
 Flags come before essential details required by the command and are compatible in both long and short forms:
 
 - `--name` / `-n` followed by name of student or group specified by command.
@@ -196,11 +180,7 @@ Flags come before essential details required by the command and are compatible i
   - `allGrp` to add a task to all groups.
     - can only be used at root directory.
 
-</box>
-
-<box type="info" theme = "warning"> 
-
-**Acceptable values for each parameter:**
+### Acceptable values for each parameter:
 
 `SPECIFIED_PATH`:
 - Must be a valid path.
@@ -219,11 +199,49 @@ Flags come before essential details required by the command and are compatible i
 
 `TASK_INDEX`:
 - Must be a valid index starts from 1.
+---
+<div class="page-break-before">
+    <!-- Content that will start on a new printed page -->
+</div>
+
+## How to use the User Guide :heart_eyes:
+We understand that it may be daunting to delve into a completely new user guide. This section designed 
+to make this journey more smooth sailing for you and enhance your understanding of the commonly used icons and boxes. 
+We hope you enjoy your reading experience! :relaxed::book:
+
+<box type="info">
 
+**Light blue boxes** like this with an **"i" icon** are designated for information-related content.
 </box>
 
----
+<box type="tip">
 
+Keep a look-out for **green boxes** like this with a **light bulb icon**, they provide valuable suggestions on
+how you can better make use of the commands for greater efficiency and convenience once you have mastered 
+the basics of the commands. 
+</box>
+
+<box type="warning">
+
+When you come across **yellow boxes** like this with a **"!" icon**, do take extra note and caution! <br>
+It contains crucial cautionary information that is definitely a **must read**.
+</box>
+
+<box type="success" seamless>
+
+This is utilized to indicate the output if command fails.:ok_woman:
+
+</box>
+
+<box type="wrong" seamless>
+
+This is utilized to indicate the output if command fails.:no_good:
+
+- There are [hyperlinks to some commonly made mistakes](#commonly-made-mistake) to help you recover from them!
+
+</box>
+
+---
 <div class="page-break-before">
     <!-- Content that will start on a new printed page -->
 </div>
@@ -252,8 +270,8 @@ Changes the current directory in the ProfBook.
 
 #### Output if command fails:
 - Displays message indicating either:
-  - Invalid command format
-  - Invalid path
+  - [Invalid command format.](#mistake-1-invalid-command-format)
+  - [Invalid path.](#mistake-2-invalid-path)
 
 </box>
 
@@ -271,7 +289,6 @@ Shows the list of children in specified directory.
 #### Acceptable values for each parameter:
 
 `[SPECIFIED_PATH]`:
-- (Optional) 
 - Must be a valid path to a group or root.
 
 <box type="info">
@@ -294,8 +311,8 @@ Shows the list of children in specified directory.
 #### Output if command fails:
 
 Displays message indicating either:
-  - Invalid command format.
-  - Invalid path.
+  - [Invalid command format.](#mistake-1-invalid-command-format)
+  - [Invalid path.](#mistake-2-invalid-path)
 
 </box>
 
@@ -319,10 +336,15 @@ Displays all tasks depending on the directory you are at.
 #### Acceptable values for parameter:
 
 `[SPECIFIED_PATH]`:
-- (Optional)
 - Must be a valid path to a group or student.
 - Must **not** be a path to root. 
 
+<box type="info">
+
+If `[SPECIFIED_PATH]` is not provided, the `ls` command will show the list of children in the current directory.
+
+</box>
+
 <box type="success" seamless>
 
 #### Output if command succeeds:
@@ -358,7 +380,7 @@ If you are at the directory `~/grp-001` and would like take a quick look of the
     <!-- Content that will start on a new printed page -->
 </div>
 
-## Student or Group Commands
+## Student or Group Commands :family:
 
 ### Add a student: `touch`
 
@@ -384,8 +406,8 @@ Adds a student into the specified directory.
 #### Output if command fails:
 
 - Displays message indicating either:
-  - Invalid command format.
-  - Invalid path.
+  - [Invalid command format.](#mistake-1-invalid-command-format)
+  - [Invalid path.](#mistake-2-invalid-path)
 
 </box>
 
@@ -440,8 +462,8 @@ At least one field (`NAME`, `EMAIL`, `PHONE_NUMBER` or `ADDRESS`) must be provid
 
 #### Output if command fails: 
 - Displays message indicating either:
-  - Invalid command format.  
-  - Invalid path. 
+  - [Invalid command format.](#mistake-1-invalid-command-format)
+  - [Invalid path.](#mistake-2-invalid-path)
   - At least one field to edit must be provided.
 
 </box>
@@ -483,8 +505,8 @@ Removes a student or group from the specified directory.
 #### Output if command fails:
 
 - Displays message indicating either:
-    - Invalid command format.
-    - No such student or group to delete.
+    - [Invalid command format](#mistake-1-invalid-command-format)
+    - [No such student or group to delete.](#mistake-3-no-such-student-or-group-to-delete)
 
 </box>
 
@@ -531,8 +553,8 @@ Moves student from one group to another group.
 #### Output if command fails
 
 - Displays message indicating either:
-  - Invalid command format.
-  - No such student to move.
+  - [Invalid command format](#mistake-1-invalid-command-format)
+  - [No such student to move.](#mistake-4-no-such-student-to-move)
   - Invalid destination path.
 
 </box>
@@ -573,7 +595,7 @@ Creates a group that can contain students.
 #### Output if command fails
 
 - Displays message indicating either:
-    - Invalid command format.
+    - [Invalid command format.](#mistake-1-invalid-command-format)
     - Invalid path to a group.
 
 </box>
@@ -591,10 +613,17 @@ Shows a message of some commands you could use.
 
 ### Clearing all entries : `clear`
 
-Clears all entries from the ProfBook.
+Clears all entries from ProfBook.
 
 **Format:** `clear`
 
+<box type="warning">
+
+The `clear` command, upon confirmation by pressing enter, will clear all entries from ProfBook. 
+It is crucial to note that there is **no way to recover these entries** once the `clear` command has been executed. 
+Therefore, we strongly advise exercising caution when using this command.
+</box>
+
 <box type="tip">
 This command is particularly valuable at the beginning of a new semester when you wish to clear all your previous 
 students and groups, making way for the addition of new students. 
@@ -619,7 +648,7 @@ positioned in the top-left corner of the window.
     <!-- Content that will start on a new printed page -->
 </div>
 
-## Tasks command
+## Tasks command :clipboard:
 
 ### Create Todo Task : `todo`
 
@@ -651,8 +680,8 @@ The `todo` command will create todo task for the student or group at current dir
 #### Output if command fails:
 
 - Displays message indicating either:
-  - Invalid command format.
-  - Invalid path.
+  - [Invalid command format.](#mistake-1-invalid-command-format)
+  - [Invalid path.](#mistake-2-invalid-path)
 
 </box>
 
@@ -700,8 +729,8 @@ The `deadline` command will create task with deadline for the student or group a
 #### Output if command fails:
 
 - Displays message indicating either:
-  - Invalid command format.
-  - Invalid path.
+  - [Invalid command format.](#mistake-1-invalid-command-format)
+  - [Invalid path.](#mistake-2-invalid-path)
 
 </box>
 
@@ -739,15 +768,15 @@ Marks the specified task as done for the specified student or group.
 #### Output if command fails
 
 - Displays message indicating either:
-  - Invalid command format.
-  - Invalid task index.
-  - The display panel is not showing task list.
+  - [Invalid command format](#mistake-1-invalid-command-format)
+  - [Invalid task index.](#mistake-5-invalid-task-index)
+  - [The display panel is not showing task list.](#mistake-6-the-display-panel-is-not-showing-task-list)
 
 </box>
 
 <box type="warning">
 
-When using this command, you will first need to `cat` at the path where the task list is at before executing `mark`.
+When using this command, you will first need to [`cat`](#display-all-tasks-cat) at the path where the task list is at before executing `mark`.
 </box>
 
 #### Example(s):
@@ -766,10 +795,7 @@ Unmarks the specified task for the student or group.
 
 #### Output if command succeeds:
 
-- Displays message indicating either:
-  - Invalid command format.
-  - Invalid task index.
-  - The display panel is not showing task list.
+- Displays message indicating unmark is done successfully as well as specific task that is unmarked.
 
 </box>
 
@@ -777,13 +803,15 @@ Unmarks the specified task for the student or group.
 
 #### Output if command fails:
 
-- Displays message indicating unmark is done successfully as well as specific task that is unmarked.
-
+- Displays message indicating either:
+  - [Invalid command format](#mistake-1-invalid-command-format)
+  - [Invalid task index.](#mistake-5-invalid-task-index)
+  - [The display panel is not showing task list.](#mistake-6-the-display-panel-is-not-showing-task-list)
 </box>
 
 <box type="warning">
 
-When using this command, you will first need to `cat` at the path where the task list is at before executing `unmark`.
+When using this command, you will first need to [`cat`](#display-all-tasks-cat) at the path where the task list is at before executing `unmark`.
 </box>
 
 #### Example(s):
@@ -818,6 +846,51 @@ _Details coming soon ..._
     <!-- Content that will start on a new printed page -->
 </div>
 
+## Commonly made mistake
+
+<box type="warning">
+
+As Albert Einstein wisely said, "A person who never made a mistake never tried anything new"
+</box>
+
+At ProfBook, we wholeheartedly believe that mistakes are part of the learning journey. We are here to support
+you in your quest of mastering ProfBook, helping you recover from any hiccups that may happen along the way. 
+As such, we have collated a list of some commonly made mistakes and solutions to them. :muscle:
+
+##### Mistake 1: Invalid command format
+**Solution:**
+Ensure that the command you enter adheres to the format provided in the user guide.
+
+##### Mistake 2: Invalid path
+**Solution:**
+Please check that the path you have entered is the intended path you wish you utilise, 
+and it exists within ProBook.
+
+##### Mistake 3: No such student or group to delete.
+**Solution:**
+Verify that the StudentId or GroupId belonging to the student or group you wish to delete is correct
+and that the student or group exists in the specified path from which you wish to delete them.
+
+##### Mistake 4: No such student to move.
+**Solution:**
+Verify that the StudentId belonging to the student you wish to move is correct
+and that the student exists in the specified path from which you wish to move them.
+
+##### Mistake 5: Invalid task index
+**Solution:**
+Task index starts from 1. Check that the index you input is a whole number and falls within the range 
+of 1 to the total number of tasks in the task list.
+
+##### Mistake 6: The display panel is not showing task list
+**Solution:**
+Please do not forget to execute the [`cat`](#display-all-tasks-cat) command prior to executing the required command.
+
+---
+
+<div class="page-break-before">
+    <!-- Content that will start on a new printed page -->
+</div>
+
 ## FAQ
 
 **Q**: How do I transfer my data to another computer?<br>
@@ -848,11 +921,11 @@ the data of your previous ProfBook home folder.
 | **Change Directory**    | `cd SPECIFIED_PATH` <br> e.g., `cd ../grp-001`                                                                                                                                          |
 | **Display Directories** | `ls [SPECIFIED_PATH]` <br> e.g., `ls grp-001`                                                                                                                                           |
 | **Display Task List**   | `cat [SPECIFIED_PATH]`<br> e.g., `cat 1234A, cat grp-001`                                                                                                                               |
-| **Add Student**         | `touch SPECIFIED_PATH -n NAME [-e EMAIL] [- p PHONE_NUMBER] [-a ADDRESS]` <br> e.g., `touch stu-200 --name Bob --email bobby@example.com --phone 92929292 --address blk 258 Toa Payoh ` |
+| **Add Student**         | `touch SPECIFIED_PATH -n NAME [-e EMAIL] [- p PHONE_NUMBER] [-a ADDRESS]` <br> e.g., `touch 2000Y --name Bob --email bobby@example.com --phone 92929292 --address blk 258 Toa Payoh ` |
 | **Edit Student**        | `edit SPECIFIED_PATH [-n NAME] [-e EMAIL] [-p PHONE_NUMBER] [-a ADDRESS]` <br> e.g., `edit 0010Y --phone 91919191`                                                                      |
 | **Create Group**        | `mkdir [groupId]` <br> e.g., `mkdir grp-1`                                                                                                                                              |
 | **Delete**              | `rm SPECIFIED_PATH` <br> e.g., `rm 0123Y`, `rm grp-002`                                                                                                                                 |
-| **Create Todo**         | `todo SPECIFIED_PATH --desc DESCRIPTION --all CATERGORY` <br> e.g., `todo stu-001 --desc Assignment 1                                                                                   |
-| **Create Deadline**     | `deadline SPECIFIED_PATH --desc DESCRIPTION --datetime DATE_AND_TIME --all CATERGORY`<br> e.g., `deadline stu-001 --desc Assignment 1 --datetime 2023-10-11 23:59 `                     |
+| **Create Todo**         | `todo SPECIFIED_PATH --desc DESCRIPTION --all CATERGORY` <br> e.g., `todo 2000Y --desc Assignment 1                                                                                   |
+| **Create Deadline**     | `deadline SPECIFIED_PATH --desc DESCRIPTION --datetime DATE_AND_TIME --all CATERGORY`<br> e.g., `deadline 2000Y --desc Assignment 1 --datetime 2023-10-11 23:59 `                     |
 | **Mark**                | `mark TASK_INDEX`<br> e.g.,`mark 1`                                                                                                                                                     |
 | **Unmark**              | `unmark TASK_INDEX`<br> e.g.,`unmark 2`                                                                                                                                                 |
diff --git a/docs/package-lock.json b/docs/package-lock.json
index 63a232e05dc..ea3b661b1fa 100644
--- a/docs/package-lock.json
+++ b/docs/package-lock.json
@@ -779,9 +779,9 @@
       }
     },
     "node_modules/crypto-js": {
-      "version": "4.1.1",
-      "resolved": "https://registry.npmjs.org/crypto-js/-/crypto-js-4.1.1.tgz",
-      "integrity": "sha512-o2JlM7ydqd3Qk9CA0L4NL6mTzU2sdx96a+oOfPu8Mkl/PK51vSyoi8/rQ8NknZtk44vq15lmhAj9CIAGwgeWKw==",
+      "version": "4.2.0",
+      "resolved": "https://registry.npmjs.org/crypto-js/-/crypto-js-4.2.0.tgz",
+      "integrity": "sha512-KALDyEYgpY+Rlob/iriUtjV6d5Eq+Y191A5g4UqLAi8CyGP9N1+FdVbkc1SxKc2r4YAYqG8JzO2KGL+AizD70Q==",
       "dev": true
     },
     "node_modules/css-select": {
@@ -836,9 +836,9 @@
       }
     },
     "node_modules/decode-uri-component": {
-      "version": "0.2.0",
-      "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.0.tgz",
-      "integrity": "sha512-hjf+xovcEn31w/EUYdTXQh/8smFL/dzYjohQGEIgjyNavaJfBY2p5F527Bo1VPATxv0VYTUC2bOcXvqFwk78Og==",
+      "version": "0.2.2",
+      "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.2.tgz",
+      "integrity": "sha512-FqUYQ+8o158GyGTrMFJms9qh3CqTKvAqgqsTnkLI8sKu0028orqBhxNMFkFen0zGyg6epACD32pjVk58ngIErQ==",
       "dev": true,
       "engines": {
         "node": ">=0.10"
@@ -4662,9 +4662,9 @@
       }
     },
     "node_modules/winston-daily-rotate-file/node_modules/semver": {
-      "version": "6.3.0",
-      "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz",
-      "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==",
+      "version": "6.3.1",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz",
+      "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==",
       "dev": true,
       "bin": {
         "semver": "bin/semver.js"
@@ -5367,9 +5367,9 @@
       }
     },
     "crypto-js": {
-      "version": "4.1.1",
-      "resolved": "https://registry.npmjs.org/crypto-js/-/crypto-js-4.1.1.tgz",
-      "integrity": "sha512-o2JlM7ydqd3Qk9CA0L4NL6mTzU2sdx96a+oOfPu8Mkl/PK51vSyoi8/rQ8NknZtk44vq15lmhAj9CIAGwgeWKw==",
+      "version": "4.2.0",
+      "resolved": "https://registry.npmjs.org/crypto-js/-/crypto-js-4.2.0.tgz",
+      "integrity": "sha512-KALDyEYgpY+Rlob/iriUtjV6d5Eq+Y191A5g4UqLAi8CyGP9N1+FdVbkc1SxKc2r4YAYqG8JzO2KGL+AizD70Q==",
       "dev": true
     },
     "css-select": {
@@ -5418,9 +5418,9 @@
       }
     },
     "decode-uri-component": {
-      "version": "0.2.0",
-      "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.0.tgz",
-      "integrity": "sha512-hjf+xovcEn31w/EUYdTXQh/8smFL/dzYjohQGEIgjyNavaJfBY2p5F527Bo1VPATxv0VYTUC2bOcXvqFwk78Og==",
+      "version": "0.2.2",
+      "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.2.tgz",
+      "integrity": "sha512-FqUYQ+8o158GyGTrMFJms9qh3CqTKvAqgqsTnkLI8sKu0028orqBhxNMFkFen0zGyg6epACD32pjVk58ngIErQ==",
       "dev": true
     },
     "define-property": {
@@ -8526,9 +8526,9 @@
       },
       "dependencies": {
         "semver": {
-          "version": "6.3.0",
-          "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz",
-          "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==",
+          "version": "6.3.1",
+          "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz",
+          "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==",
           "dev": true
         }
       }

From 1e2b4c9e9a60a0d44344185072cc742946a24338 Mon Sep 17 00:00:00 2001
From: Loo Mei Lin Zann <>
Date: Wed, 1 Nov 2023 23:20:48 +0800
Subject: [PATCH 12/15] Change emoji

---
 docs/UserGuide.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index 34ac466634c..4cf63b97d79 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -207,7 +207,7 @@ Flags come before essential details required by the command and are compatible i
 ## How to use the User Guide :heart_eyes:
 We understand that it may be daunting to delve into a completely new user guide. This section designed 
 to make this journey more smooth sailing for you and enhance your understanding of the commonly used icons and boxes. 
-We hope you enjoy your reading experience! :relaxed::book:
+We hope you enjoy your reading experience! :blush::book:
 
 <box type="info">
 

From b679025ae2062e7db7d973f6b2d9b317d01eac94 Mon Sep 17 00:00:00 2001
From: Loo Mei Lin Zann <>
Date: Wed, 1 Nov 2023 23:48:41 +0800
Subject: [PATCH 13/15] Correct spelling and phrasing

---
 docs/UserGuide.md | 28 +++++++++++-----------------
 1 file changed, 11 insertions(+), 17 deletions(-)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index 4cf63b97d79..f949142fcd6 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -205,9 +205,9 @@ Flags come before essential details required by the command and are compatible i
 </div>
 
 ## How to use the User Guide :heart_eyes:
-We understand that it may be daunting to delve into a completely new user guide. This section designed 
+We understand that it may be daunting to delve into a completely new user guide. This section is designed 
 to make this journey more smooth sailing for you and enhance your understanding of the commonly used icons and boxes. 
-We hope you enjoy your reading experience! :blush::book:
+We hope you enjoy your reading experience! :blush: :book:
 
 <box type="info">
 
@@ -218,7 +218,7 @@ We hope you enjoy your reading experience! :blush::book:
 
 Keep a look-out for **green boxes** like this with a **light bulb icon**, they provide valuable suggestions on
 how you can better make use of the commands for greater efficiency and convenience once you have mastered 
-the basics of the commands. 
+the basics of the command. 
 </box>
 
 <box type="warning">
@@ -229,7 +229,7 @@ It contains crucial cautionary information that is definitely a **must read**.
 
 <box type="success" seamless>
 
-This is utilized to indicate the output if command fails.:ok_woman:
+This is utilized to indicate the output if command succeeds.:ok_woman:
 
 </box>
 
@@ -358,7 +358,7 @@ If `[SPECIFIED_PATH]` is not provided, the `ls` command will show the list of ch
 - If `cat` in root directory,
   - Displays message indicating that task list cannot be shown within root directory.
 
-- If `cat` with invalid parameter, 
+* If `cat` with invalid parameter, 
   - Displays message showing invalid path with user's input Path.
 
 </box>
@@ -438,7 +438,7 @@ One or more fields can be edited in a single command.
 
 #### Acceptable values for each parameter:
 
-`SPECIFIED_PATH`:  
+`[SPECIFIED_PATH]`:  
 - Must be a valid path to a student.
 
 <box type="info">
@@ -447,12 +447,6 @@ If `[SPECIFIED_PATH]` is not provided, current directory must be a student direc
 The `edit` command will edit the student at current directory.  
 </box>
 
-<box type="warning">
-
-At least one field (`NAME`, `EMAIL`, `PHONE_NUMBER` or `ADDRESS`) must be provided.
-</box>  
-<box type="success" seamless>
-
 #### Output if command succeeds: 
 - Displays message indicating successful edition of specified student. 
 
@@ -464,7 +458,7 @@ At least one field (`NAME`, `EMAIL`, `PHONE_NUMBER` or `ADDRESS`) must be provid
 - Displays message indicating either:
   - [Invalid command format.](#mistake-1-invalid-command-format)
   - [Invalid path.](#mistake-2-invalid-path)
-  - At least one field to edit must be provided.
+  - At least one field (`NAME`, `EMAIL`, `PHONE_NUMBER` or `ADDRESS`)to edit must be provided.
 
 </box>
 
@@ -776,7 +770,7 @@ Marks the specified task as done for the specified student or group.
 
 <box type="warning">
 
-When using this command, you will first need to [`cat`](#display-all-tasks-cat) at the path where the task list is at before executing `mark`.
+When using this command, you will first need to [cat](#display-all-tasks-cat) at the path where the task list is at before executing `mark`.
 </box>
 
 #### Example(s):
@@ -811,7 +805,7 @@ Unmarks the specified task for the student or group.
 
 <box type="warning">
 
-When using this command, you will first need to [`cat`](#display-all-tasks-cat) at the path where the task list is at before executing `unmark`.
+When using this command, you will first need to [cat](#display-all-tasks-cat) at the path where the task list is at before executing `unmark`.
 </box>
 
 #### Example(s):
@@ -863,8 +857,8 @@ Ensure that the command you enter adheres to the format provided in the user gui
 
 ##### Mistake 2: Invalid path
 **Solution:**
-Please check that the path you have entered is the intended path you wish you utilise, 
-and it exists within ProBook.
+Please check that the path you have entered is the path required by the command. Additionally, do ensure that it is
+the intended path you wish you utilise, and it exists within ProBook.
 
 ##### Mistake 3: No such student or group to delete.
 **Solution:**

From 333c6c452f083bd692ce5298cb435b5979f46771 Mon Sep 17 00:00:00 2001
From: Loo Mei Lin Zann <>
Date: Thu, 2 Nov 2023 15:59:24 +0800
Subject: [PATCH 14/15] Update UG

---
 docs/UserGuide.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index f949142fcd6..a42e9dd4b9d 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -162,7 +162,9 @@ ProfBook is organized hierarchically with the following structure:
   ignored. 
   * e.g. If the command specifies `help 123`, it will be interpreted as `help`.
 - Duplicate can only be detected if all field is exactly the same.
-* If you are using a PDF version of this document, please be careful when copying and pasting commands that span 
+* If you would like to pass in a field that starts with `-`, you need to use `\` before the start of that field.
+  * e.g. To pass in `-Clementi` in the `edit` command, the command would be `edit -a \-Clementi`.
+- If you are using a PDF version of this document, please be careful when copying and pasting commands that span 
 multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
 
 ### Flags :triangular_flag_on_post::triangular_flag_on_post::triangular_flag_on_post:

From a71236c8c248857519d16827b05e5906fbce4efc Mon Sep 17 00:00:00 2001
From: Loo Mei Lin Zann <>
Date: Thu, 2 Nov 2023 16:02:42 +0800
Subject: [PATCH 15/15] Update UG

---
 docs/UserGuide.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index a42e9dd4b9d..f8bcc7476b1 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -162,7 +162,7 @@ ProfBook is organized hierarchically with the following structure:
   ignored. 
   * e.g. If the command specifies `help 123`, it will be interpreted as `help`.
 - Duplicate can only be detected if all field is exactly the same.
-* If you would like to pass in a field that starts with `-`, you need to use `\` before the start of that field.
+* If you would like to pass in a field that starts with `-` or `--`, you need to use `\` before the start of that field.
   * e.g. To pass in `-Clementi` in the `edit` command, the command would be `edit -a \-Clementi`.
 - If you are using a PDF version of this document, please be careful when copying and pasting commands that span 
 multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.