From aa3ecedcac3190df532c842b54f1cc062197370a Mon Sep 17 00:00:00 2001 From: raydenlim Date: Fri, 10 Nov 2023 07:35:35 +0800 Subject: [PATCH] Add emoji for viewing help --- docs/UserGuide.md | 64 +++++++++++++++++++++++------------------------ 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 7978411f4c3..d3f857f93dc 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -42,44 +42,44 @@ If you are new to CLI, or unfamiliar with the commands F.A.K.E.J.A.R.V.I.S. offe       4.1 [Command Parameters](#command-parameters)  5 [Features](#features)       5.1 [General Commands](#general-commands) -            5.1.1 [🔀Switching between different tabs : `tab`](#switching-between-different-tabs-tab) -            5.1.2 [👀Viewing help : `help`](#viewing-help-help) -            5.1.3 [🏃🚪Exiting F.A.K.E.J.A.R.V.I.S. : `exit`](#exiting-f-a-k-e-j-a-r-v-i-s-exit) -            5.1.4 [💾Saving the Data](#saving-the-data) -            5.1.5 [🛠️Editing the Data File](#editing-the-data-file) -            5.1.6 [💾Archiving Data Files `[coming in v2.0]`](#archiving-data-files-coming-in-v2-0) +            5.1.1 [🔀 Switching between different tabs : `tab`](#switching-between-different-tabs-tab) +            5.1.2 [👀 Viewing help : `help`](#viewing-help-help) +            5.1.3 [🏃🚪 Exiting F.A.K.E.J.A.R.V.I.S. : `exit`](#exiting-f-a-k-e-j-a-r-v-i-s-exit) +            5.1.4 [💾 Saving the Data](#saving-the-data) +            5.1.5 [🛠️ Editing the Data File](#editing-the-data-file) +            5.1.6 [💾 Archiving Data Files `[coming in v2.0]`](#archiving-data-files-coming-in-v2-0)       5.2 [Student Management](#student-management) -            5.2.1 [📝Adding a Student: `add`](#adding-a-student-add) -            5.2.2 [👀Listing All Students : `list`](#listing-all-students-list) -            5.2.3 [🛠️Editing a Student Field : `edit`](#editing-a-student-field-edit) -            5.2.4 [🔎Locating Student by Name: `find`](#locating-student-by-name-find) -            5.2.5 [❌Deleting a Student : `delete`](#deleting-a-student-delete) -            5.2.6 [🗑️Clearing all Entries : `clear`](#clearing-all-entries-clear) +            5.2.1 [📝 Adding a Student: `add`](#adding-a-student-add) +            5.2.2 [👀 Listing All Students : `list`](#listing-all-students-list) +            5.2.3 [🛠️ Editing a Student Field : `edit`](#editing-a-student-field-edit) +            5.2.4 [🔎 Locating Student by Name: `find`](#locating-student-by-name-find) +            5.2.5 [❌ Deleting a Student : `delete`](#deleting-a-student-delete) +            5.2.6 [🗑️ Clearing all Entries : `clear`](#clearing-all-entries-clear)       5.3 [Task Management](#task-management) -            5.3.1 [📝Adding a Task: `addtask`](#adding-a-task-addtask) -            5.3.2 [👀Viewing Tasks: `viewtasks`](#viewing-tasks-viewtasks) -            5.3.3 [🛠️Updating a Task's Progress: `updateprogress`](#updating-a-task-s-progress-updateprogress) -            5.3.4 [❌Deleting a Task: `deletetask`](#deleting-a-task-deletetask) +            5.3.1 [📝 Adding a Task: `addtask`](#adding-a-task-addtask) +            5.3.2 [👀 Viewing Tasks: `viewtasks`](#viewing-tasks-viewtasks) +            5.3.3 [🛠️ Updating a Task's Progress: `updateprogress`](#updating-a-task-s-progress-updateprogress) +            5.3.4 [❌ Deleting a Task: `deletetask`](#deleting-a-task-deletetask)       5.4 [Attendance Management](#attendance-management) -            5.4.1 [📆Taking Attendance: `takeattendance`](#taking-attendance-takeattendance) -            5.4.2 [👀Viewing Attendance: `viewattendance`](#viewing-attendance-viewattendance) +            5.4.1 [📆 Taking Attendance: `takeattendance`](#taking-attendance-takeattendance) +            5.4.2 [👀 Viewing Attendance: `viewattendance`](#viewing-attendance-viewattendance)       5.5 [Assignment Management](#assignment-management) -            5.5.1 [👀Viewing a list of Assignments: `viewassignments`](#viewing-a-list-of-assignments-viewassignments) -            5.5.2 [🛠️Editing an Assignment Grade: `editgrade`](#editing-an-assignment-grade-editgrade) -            5.5.3 [❌Deleting an Assignment Grade: `deletegrade`](#deleting-an-assignment-grade-deletegrade) -            5.5.4 [🛠️Editing an Assignment Comment: `editcomment`](#editing-an-assignment-comment-editcomment) -            5.5.5 [❌Deleting an Assignment Comment: `deletecomment`](#deleting-an-assignment-comment-deletecomment) +            5.5.1 [👀 Viewing a list of Assignments: `viewassignments`](#viewing-a-list-of-assignments-viewassignments) +            5.5.2 [🛠️ Editing an Assignment Grade: `editgrade`](#editing-an-assignment-grade-editgrade) +            5.5.3 [❌ Deleting an Assignment Grade: `deletegrade`](#deleting-an-assignment-grade-deletegrade) +            5.5.4 [🛠️ Editing an Assignment Comment: `editcomment`](#editing-an-assignment-comment-editcomment) +            5.5.5 [❌ Deleting an Assignment Comment: `deletecomment`](#deleting-an-assignment-comment-deletecomment)       5.6 [Graded Test Management](#graded-test-management) -            5.6.1 [🛠️Editing a Graded Test Score: `editgradedtest`](#editing-a-graded-test-score-editgradedtest) +            5.6.1 [🛠️ Editing a Graded Test Score: `editgradedtest`](#editing-a-graded-test-score-editgradedtest)       5.7 [Session Management](#session-management) -            5.7.1 [📝Creating a Session: `createsession`](#creating-a-session-createsession) -            5.7.2 [🛠️Updating a Session's Remark: `updatesessionremark`](#updating-a-session-s-remark-updatesessionremark) -            5.7.3 [❌Deleting a Session: `deletesession`](#deleting-a-session-deletesession) +            5.7.1 [📝 Creating a Session: `createsession`](#creating-a-session-createsession) +            5.7.2 [🛠️ Updating a Session's Remark: `updatesessionremark`](#updating-a-session-s-remark-updatesessionremark) +            5.7.3 [❌ Deleting a Session: `deletesession`](#deleting-a-session-deletesession)       5.8 [Consultation Management](#consultation-management) -            5.8.1 [📝Creating a Consultation: `createconsult`](#creating-a-consultation-createconsult) -            5.8.2 [📝Adding students to a consultation: `addtoconsult`](#adding-students-to-a-consultation-addtoconsult) -            5.8.3 [❌Removing Students from a Consultation: `removefromconsult`](#removing-students-from-a-consultation-removefromconsult) -            5.8.4 [❌Deleting a Consultation: `deleteconsult`](#deleting-a-consultation-deleteconsult) +            5.8.1 [📝 Creating a Consultation: `createconsult`](#creating-a-consultation-createconsult) +            5.8.2 [📝 Adding students to a consultation: `addtoconsult`](#adding-students-to-a-consultation-addtoconsult) +            5.8.3 [❌ Removing Students from a Consultation: `removefromconsult`](#removing-students-from-a-consultation-removefromconsult) +            5.8.4 [❌ Deleting a Consultation: `deleteconsult`](#deleting-a-consultation-deleteconsult)  6 [FAQ](#faq)  7 [Known Issues](#known-issues)  8 [Command Summary](#command-summary) @@ -368,7 +368,7 @@ For the list of tab indexes to use:
-#### Viewing help : `help` +#### 👀Viewing help : `help` You can view a message explaining how to access the help page, if you require assistance in understanding the commands and their formats.