Merge pull request nus-cs2103-AY2324S1#4 from AY2324S1-CS2103T-F10-4/…

…master Pull request from team repo
AY2324S1-CS2103T-F10-4 · Oct 12, 2023 · 3ed2664 · 3ed2664
2 parents 9e9f496 + 1e296e7
commit 3ed2664
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 34 deletions.
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -48,10 +48,10 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ### Winston Leonard Prayonggo
 
-<img src="images/Winston.png" width="200px">
+<img src="images/winstonleonard.png" width="200px">
 
 [[github](http://github.com/WinstonLeonard)]
-[[portfolio](team/johndoe.md)]
+[[portfolio](team/winstonleonard.md)]
 
 * Role: Developer
 * Responsibilities: UI
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -255,29 +255,30 @@ _{Explain here how the data archiving feature will be implemented}_
 
 ### Product scope
 
-**Target user profile**:
+**Target user profile**: Private tutors not affiliated to any tuition organisations
 
-* has a need to manage a significant number of contacts
+* has a need to manage multiple tutees
+* has a need for managing personal tutoring schedule 
 * prefer desktop apps over other types
 * can type fast
 * prefers typing to mouse interactions
 * is reasonably comfortable using CLI apps
 
-**Value proposition**: manage contacts faster than a typical mouse/GUI driven app
+**Value proposition**: It is tedious for tutors to keep track of multiple students and this is done conventionally through calendar applications. Simplify tutoring business with TuitionConnect. Effortlessly manage students, schedules and progress tracking while ensuring financial organization in an all in one product at a faster rate than non CLI applications.
+
 
 
 ### User stories
 
 Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unlikely to have) - `*`
 
-| Priority | As a …                                    | I want to …                     | So that I can…                                                        |
-| -------- | ------------------------------------------ | ------------------------------ | ---------------------------------------------------------------------- |
-| `* * *`  | new user                                   | see usage instructions         | refer to instructions when I forget how to use the App                 |
-| `* * *`  | user                                       | add a new person               |                                                                        |
-| `* * *`  | user                                       | delete a person                | remove entries that I no longer need                                   |
-| `* * *`  | user                                       | find a person by name          | locate details of persons without having to go through the entire list |
-| `* *`    | user                                       | hide private contact details   | minimize chance of someone else seeing them by accident                |
-| `*`      | user with many persons in the address book | sort persons by name           | locate a person easily                                                 |
+| Priority | As a …                                    | I want to …                                | So that I can…                                                 |
+| -------- |--------------------------------------------|---------------------------------------------|-----------------------------------------------------------------|
+| `* * *`  | tutor                                      | view a list of all tutees                   |                                                                 |
+| `* * *`  | tutor                                      | view the specific details of a single tutee |                                                                 |
+| `* * *`  | tutor                                      | add a new tutee                             |                                                                 |
+| `* * *`  | tutor                                      | edit their details                          | account for changes in their information e.g. change in address |
+| `* *`    | tutor                                      | remove tutees from the list                 | keep track of tutees that I have stopped teaching               |
 
 *{More to be added}*
 
@@ -359,9 +360,10 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 
 ### Glossary
 
-* **Mainstream OS**: Windows, Linux, Unix, OS-X
-* **Private contact detail**: A contact detail that is not meant to be shared with others
-
+* Calendar Applications: Digital tools for organizing and managing schedules, events, and tasks.
+* Shortcut Commands:  Quick combinations of keystrokes that trigger specific actions in a software application.
+* Participation Grade: The grade used to assess a student's active involvement and engagement during academic activities.
+* Academic Performance: It represents a student's achievements and results in the study, including grades, exam scores, projects and so on.
 --------------------------------------------------------------------------------------------------------------------
 
 ## **Appendix: Instructions for manual testing**

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -14,26 +14,22 @@ Tuition connect is a desktop app that helps tutors keep track of their tutees an
 
 1. Ensure you have Java `11` or above installed in your Computer.
 
-1. Download the latest `addressbook.jar` from [here](https://github.com/se-edu/addressbook-level3/releases).
+1. Download the latest `TuitionConnect.jar` from [here](https://github.com/AY2324S1-CS2103T-F10-4/tp/releases).
 
-1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.
+1. Copy the file to the folder you want to use as the _home folder_ for your TuitionConnect.
 
-1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.<br>
+1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar TuitionConnect.jar` command to run the application.<br>
    A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
    ![Ui](images/Ui.png)
 
 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:
 
-    * `list` : Lists all contacts.
+    * `list` : Lists all tutees.
 
-    * `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book.
+    * `add n/John Doe p/98765432 a/John street, block 123, #01-01 sb/Primary 4 Math d/wed b/1500 e/1600` : Adds a tutee named `John Doe` to the list.
 
-    * `delete 3` : Deletes the 3rd contact shown in the current list.
-
-    * `clear` : Deletes all contacts.
-
-    * `exit` : Exits the app.
+    * `delete 3` : Deletes the 3rd tutee shown in the current list.
 
 1. Refer to the [Features](#features) below for details of each command.
 
@@ -124,7 +120,7 @@ To edit name and address of your tutee:
 **Expected Output when the command fails**: Please input a valid index
 
 Examples:
-* `list` followed by `delete 2` deletes the 2nd person in the address book.
+* `list` followed by `delete 2` deletes the 2nd person in the list.
 
 
 --------------------------------------------------------------------------------------------------------------------

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,4 +1,4 @@
-title: "AB-3"
+title: "TuitionConnect"
 theme: minima
 
 header_pages:
@@ -8,7 +8,7 @@ header_pages:
 
 markdown: kramdown
 
-repository: "se-edu/addressbook-level3"
+repository: "AY2324S1-CS2103T-F10-4/tp"
 github_icon: "images/github-icon.png"
 
 plugins:

diff --git a/docs/images/jovkusuma.png b/docs/images/jovkusuma.png
diff --git a/docs/images/Winston.png → docs/images/winstonleonard.png b/docs/images/Winston.png → docs/images/winstonleonard.png
diff --git a/docs/team/heran9.md b/docs/team/heran9.md
@@ -9,7 +9,7 @@ to be added soon
 
 Given below are my contributions to the project.
 
-* **New Feature**: 
+* **New Feature**:
   * to be added soon
 
 * **Code contributed**:

diff --git a/docs/team/WinstonLeonard.md → docs/team/winstonleonard.md b/docs/team/WinstonLeonard.md → docs/team/winstonleonard.md
@@ -9,7 +9,7 @@ To be Added Soon
 
 Given below are my contributions to the project:
 
-* **New Feature**: 
+* **New Feature**:
     * To be added soon
     * To be added soon
 
@@ -32,8 +32,8 @@ Given below are my contributions to the project:
 
 
 * **Community**:
-    * To be added soon 
-  
+    * To be added soon
+
 
 * **Tools**:
-    * To be added soon
+    * To be added soon