Merge branch 'master' into update-DG

README.md

@@ -1,7 +1,14 @@
+[![CI Status](https://github.com/AY2324S2-CS2103T-F10-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-F10-1/tp/actions)
+![codecov](https://codecov.io/gh/AY2324S2-CS2103T-F10-1/tp/branch/master/graph/badge.svg)
+
+![Ui](docs/images/Ui.png)
+
 # Nursing Address Book
 
 Target user:
 Our target group is Ward Nurses. This product is for users who prefer typing quickly while having quick access to critical patient information fast.
+
 Value proposition:
+Streamlined text-based commands to manage contacts faster than a typical mouse/GUI driven app
 
-Nurses already familiar with typing at their workstations. With this product, nurses are able to quickly access critical patient information (emergency contacts, drug allergies etc). They could also log their activities, for each patient whenever they administer care.
+_This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org)._

docs/AboutUs.md

@@ -9,50 +9,50 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 
 ## Project team
 
-### John Doe
+### Ong Tze Jet
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/iamtr.png" width="200px">
 
 [[homepage](http://www.comp.nus.edu.sg/~damithch)]
-[[github](https://github.com/johndoe)]
+[[github](https://github.com/iamtr)]
 [[portfolio](team/johndoe.md)]
 
 * Role: Project Advisor
 
-### Jane Doe
+### An Eu Jin
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ejnan.png" width="200px">
 
-[[github](http://github.com/johndoe)]
+[[github](http://github.com/ejnan)]
 [[portfolio](team/johndoe.md)]
 
 * Role: Team Lead
 * Responsibilities: UI
 
-### Johnny Doe
+### Ryan Lim Ding Xuan
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/ryanlimdx.png" width="200px">
 
-[[github](http://github.com/johndoe)] [[portfolio](team/johndoe.md)]
+[[github](http://github.com/ryanlimdx)] [[portfolio](team/johndoe.md)]
 
 * Role: Developer
 * Responsibilities: Data
 
-### Jean Doe
+### Tan Shao Wei
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/swtan346.png" width="200px">
 
-[[github](http://github.com/johndoe)]
+[[github](http://github.com/swtan346)]
 [[portfolio](team/johndoe.md)]
 
 * Role: Developer
 * Responsibilities: Dev Ops + Threading
 
-### James Doe
+### Ervin Teo Jun Xiong
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/erv-teo.png" width="200px">
 
-[[github](http://github.com/johndoe)]
+[[github](http://github.com/erv-teo)]
 [[portfolio](team/johndoe.md)]
 
 * Role: Developer

docs/DeveloperGuide.md

@@ -261,28 +261,28 @@ _{Explain here how the data archiving feature will be implemented}_
 ### Product scope
 
 **Target user profile**:
+Ward nurses
+* manage a significant number of patient contacts with varying details
+* quickly access critical patient information in time-sensitive situations
+* track and log details of care administered to each patient over time
 
-* has a need to manage a significant number of contacts
+**Preferences/ Skills**
 * 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
+* is reasonably comfortable using CLI (command-line interface) apps
 
+**Value proposition**: streamlined text-based commands to manage contacts faster than a typical mouse/GUI driven app
 
 ### 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…​                                         |
+| -------- | -------------------------------------- |-------------------------------|---------------------------------------------------------|
+| `* * *`  | user                                   | add a new patient             | store new patient records                               |
+| `* * *`  | user                                   | view existing patient records | access information on existing patients                 |
+| `* * *`  | user                                   | delete a patient record       | remove outdated or irrelevant patient data              |
 
 *{More to be added}*
 
@@ -423,3 +423,4 @@ testers are expected to do more *exploratory* testing.
    1. _{explain how to simulate a missing/corrupted file, and the expected behavior}_
 
 1. _{ more test cases …​ }_
+

docs/UserGuide.md

@@ -19,7 +19,7 @@ AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized fo
 1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.
 
 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>
-   A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
+   A GUI similar to the below should appear in a few seconds. Note how the app contains some sample input.<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>

docs/_config.yml

@@ -1,4 +1,4 @@
-title: "AB-3"
+title: "Nursing Address Book"
 theme: minima
 
 header_pages:

docs/index.md

@@ -3,7 +3,7 @@ layout: page
 title: AddressBook Level-3
 ---
 
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-F10-1/tp/actions)
 [![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3)
 
 ![Ui](images/Ui.png)
@@ -17,3 +17,4 @@ title: AddressBook Level-3
 **Acknowledgements**
 
 * Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).