Date: Sat, 19 Oct 2024 17:32:53 +0800
Subject: [PATCH 3/6] Correct mistakes
---
docs/UserGuide.md | 5 -----
1 file changed, 5 deletions(-)
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index 5582ba39a54..a00dccd4596 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -1,8 +1,3 @@
----
-layout: page
-title: User Guide
----
-
Murphy's List is a **desktop app for managing patient contact info for institutes providing palliative care, optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI).
If you can type fast, Murphy's List can get your healthcare administrative tasks done faster than other traditional GUI apps.
From 9b0cea9e9da09da807903db208b36ea94b36fe6f Mon Sep 17 00:00:00 2001
From: volleyballkickedme
<89293409+volleyballkickedme@users.noreply.github.com>
Date: Sat, 19 Oct 2024 17:38:31 +0800
Subject: [PATCH 4/6] Add link to user Guide
---
docs/index.md | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/index.md b/docs/index.md
index bee78ef85ee..2b505c81178 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -21,6 +21,7 @@ This project is based on the AddressBook-Level3 project created by the [SE-EDU i
* It is **well-designed and documented**.
* It is named `Murphy's List` (`ML` for short) because it was named after the medical prodigy `Sean Murphy` from the popular show `The Good Doctor`
* For the detailed documentation of this project, see our **[Developer Guide](https://github.com/AY2425S1-CS2103T-W11-1a/tp/blob/master/docs/DeveloperGuide.md)**.
+* For a comprehensive list of instructions on how to use the app, see our **[User Guide](docs/UserGuide.md)**
**Acknowledgements**
From 28491a3c97a4a89853492775e0ba1a5c9d56d823 Mon Sep 17 00:00:00 2001
From: volleyballkickedme
<89293409+volleyballkickedme@users.noreply.github.com>
Date: Sat, 19 Oct 2024 17:52:44 +0800
Subject: [PATCH 5/6] Update table of contents to include all commands
---
docs/UserGuide.md | 20 +++++++++++++-------
1 file changed, 13 insertions(+), 7 deletions(-)
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index a00dccd4596..c6c86b89f6b 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -5,9 +5,15 @@ If you can type fast, Murphy's List can get your healthcare administrative tasks
1. [Quick Start](#quick-start)
2. [Features](#features)
1. [Viewing Help](#viewing-help--help)
- 2. [Adding a Person](#adding-a-person--add)
+ 2. [Adding a Patient Profile](#adding-a-patient-profile--add)
3. [Adding a Remark](#adding-a-remark--remark)
4. [Adding an Appointment](#adding-an-appointment--appointment)
+ 5. [Listing all profiles](#listing-all-patient-profiles--list)
+ 6. [Editing a patient profile](#editing-a-patient-profile--edit)
+ 7. [Locating patients by name](#locating-patients-by-name-find)
+ 8. [Deleting patient profile](#deleting-a-patient-profile--delete)
+ 9. [Clear all entries](#clearing-all-entries--clear)
+ 10. [Exiting the program](#exiting-the-program--exit)
3. [Command Summary](#command-summary)
4. [FAQ](#faq)
5. [Known Issues](#known-issues)
@@ -78,14 +84,14 @@ Displays a list of accepted commands.
Format: `help`
-### Adding a person : `add`
+### Adding a patient profile : `add`
Adds a patient profile to the database.
Format: `add n/NAME p/PHONE_NUMBER e/EMAIL i/NRIC a/ADDRESS [t/TAG]…`
:bulb: **Tip:**
-A person can have any number of tags (including 0)
+A patient profile can have any number of tags (including 0)
Examples:
@@ -108,13 +114,13 @@ Adds the appointment date of a patient to the patient profile. Note that appoint
Format: `appointment NRIC app/APPOINTMENT`
-### Listing all persons : `list`
+### Listing all patient profiles : `list`
Shows a list of all patient profiles in the database.
Format: `list`
-### Editing a person : `edit`
+### Editing a patient profile : `edit`
Edits the details of the patient identified by the index number used in the displayed patient profile list. **Existing information will be overwritten by the input values**
@@ -129,7 +135,7 @@ Format: `edit INDEX(must be positive integer) [n/NAME] [p/PHONE] [e/EMAIL] [i/NR
Examples:
* `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st patient to be `91234567` and `johndoe@example.com` respectively.
-* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
+* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd patient profile displayed to be `Betsy Crower` and clears all existing tags.
### Locating patients by name: `find`
@@ -141,7 +147,7 @@ Format: `find KEYWORD [MORE_KEYWORDS]`
* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
* Only the name is searched.
* Only full words will be matched e.g. `Han` will not match `Hans`
-* Persons matching at least one keyword will be returned (i.e. `OR` search).
+* Profiles matching at least one keyword will be returned (i.e. `OR` search).
e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`
Examples:
From 406240a334b52d6628235c933617237568d4f829 Mon Sep 17 00:00:00 2001
From: Zhang Yuan <89293409+volleyballkickedme@users.noreply.github.com>
Date: Sat, 19 Oct 2024 17:53:27 +0800
Subject: [PATCH 6/6] Update UserGuide.md
---
docs/UserGuide.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index c6c86b89f6b..d87121d0ac6 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -17,7 +17,7 @@ If you can type fast, Murphy's List can get your healthcare administrative tasks
3. [Command Summary](#command-summary)
4. [FAQ](#faq)
5. [Known Issues](#known-issues)
-6. [Commannd Summary](#command-summary)
+6. [Command Summary](#command-summary)
--------------------------------------------------------------------------------------------------------------------
@@ -225,4 +225,4 @@ Action | Format, Examples
**Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake`
**List** | `list`
**Help** | `help`
-**Exit** | `exit`
\ No newline at end of file
+**Exit** | `exit`