Update user guide with pictures

AY2324S2-CS2103-F08-4 · Apr 14, 2024 · a4d1521 · a4d1521
1 parent 6cec10c
commit a4d1521
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 48 deletions.
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -15,7 +15,7 @@ We are a team based in the [School of Computing, National University of Singapor
 <img src="images/joelgoh1.png" width="200px">
 
 [[github](http://github.com/joelgoh1)]
-[[portfolio](team/joelgoh.md)]
+[[portfolio](team/joelgoh1.md)]
 
 * Role: Developer
 * Responsibilities: Deliverables and deadlines

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -6,7 +6,13 @@
 
 # TutorTrack User Guide
 
-TutorTrack is a **desktop app for managing contacts, optimized for use via a  Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, TutorTrack can get your contact management tasks done faster than traditional GUI apps.
+Welcome, Tutors! Thank you for choosing TutorTrack! Managing your students' contacts has never been easier with our desktop app
+that is optimised for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI).
+
+
+TutorTrack simplifies the consolidation and retrieval of student information, freeing you to concentrate on what you do
+best: teaching. This User Guide provides comprehensive details to help you utilise TutorTrack to its full potential,
+ensuring a smooth and efficient experience. Enjoy a hassle-free administration and focus more on your educational goals!
 
 <!-- * Table of Contents -->
 <page-nav-print />
@@ -17,7 +23,7 @@ TutorTrack is a **desktop app for managing contacts, optimized for use via a  Li
 
 1. Ensure you have Java `11` or above installed in your Computer.
 
-1. Download the latest `addressbook.jar` from [here](https://github.com/AY2324S2-CS2103-F08-4/tp/releases).
+1. Download the latest `tutorTrack.jar` from [here](https://github.com/AY2324S2-CS2103-F08-4/tp/releases).
 
 1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.
 
@@ -41,6 +47,16 @@ TutorTrack is a **desktop app for managing contacts, optimized for use via a  Li
 1. Refer to the [Features](#features) below for details of each command.
 
 --------------------------------------------------------------------------------------------------------------------
+## User Interface
+![Ui](images/UiAnnotated.png)
+
+- The `taskbar` presents you with the option to access help and exit the programme. 
+- The `Commmand Box` would be where you can input your commands.
+- The `Result Display` is where TutorTrack displays the command results, either with a success message or an error message
+informing you of what requires fixing.
+- The `Student Panel` is where you view your students' contact information. A more detailed look into each student card is shown below.
+
+![Ui](images/StudentCardAnnotated.png)
 
 ## Features
 

diff --git a/docs/images/StudentCardAnnotated.png b/docs/images/StudentCardAnnotated.png
diff --git a/docs/images/Ui.png b/docs/images/Ui.png
diff --git a/docs/images/UiAnnotated.png b/docs/images/UiAnnotated.png
diff --git a/docs/team/joelgoh.md b/docs/team/joelgoh.md
diff --git a/docs/team/joelgoh1.md b/docs/team/joelgoh1.md
@@ -0,0 +1,38 @@
+---
+  layout: default.md
+  title: "Joel Goh's Project Portfolio Page"
+---
+
+### Project: Tutor Track
+
+
+Given below are my contributions to the project.
+
+* **New Feature**: Added the grade parameter.
+  * What it does: allows the user to save and track grades for students.
+  * Justification: This feature improves the product significantly because a user can track their students' performance in various tests using the app
+
+* **Updated Feature**: Changed tag parameter to timeslot.
+  * What it does: allows the user to save information regarding what time their students' classes is.
+  * Justification: This feature improves the product significantly because a user can keep track of when they would need to teach what student, a pivotal piece of information a tutor would need.
+
+* **New Feature**: Added the ability to filter students by timeslot.
+    * What it does: allows the user to filter through their students by timeslot
+    * Justification: This feature improves the product because a user can quickly filter through the timings that they would need to teach a student, providing much needed convenience for the tutor
+
+
+
+* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s2.github.io/tp-dashboard/?search=&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2024-02-23&tabOpen=true&tabType=authorship&tabAuthor=joelgoh1&tabRepo=AY2324S2-CS2103-F08-4%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=docs~functional-code~test-code~other&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)
+
+* **Project management**:
+    * Managed releases `v1.3` - `v1.3.1` (2 releases) on GitHub
+    * Created milestone `v1.1` - `v1.3b` (4 milestone) on Github
+    * Created and assigned many Github Issues 
+
+
+* **Documentation**:
+    * User Guide:
+        * Added documentation for the features `filter`
+    * Developer Guide:
+        * Added implementation details of the `filter` feature.
+