Merge pull request #164 from howenc/Bug_Fix4

Update DG and UG
AY2324S1-CS2103T-F12-4 · Nov 10, 2023 · 16910bc · 16910bc
2 parents 3ee67a5 + 0284d6c
commit 16910bc
Show file tree

Hide file tree

Showing 10 changed files with 145 additions and 51 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/SettingUp.md b/docs/SettingUp.md
@@ -45,11 +45,10 @@ If you plan to use Intellij IDEA (highly recommended):
 
 1. **Learn the design**
 
-   When you are ready to start coding, we recommend that you get some sense of the overall design by reading about [AddressBook’s architecture](DeveloperGuide.md#architecture).
+   When you are ready to start coding, we recommend that you get some sense of the overall design by reading about [OutBook’s architecture](DeveloperGuide.md#architecture).
 
 1. **Do the tutorials**
    These tutorials will help you get acquainted with the codebase.
 
    * [Tracing code](tutorials/TracingCode.md)
-   * [Adding a new command](tutorials/AddRemark.md)
    * [Removing fields](tutorials/RemovingFields.md)
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -63,6 +63,7 @@ Managing clients and a busy schedule have never been easier. With OutBook, all y
 4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar OutBook.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)
+<br><br><br><br><br><br>
 5. Type a 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:
 
@@ -82,6 +83,7 @@ Managing clients and a busy schedule have never been easier. With OutBook, all y
 
 Return to the [Table of Contents](#table-of-contents)
 
+<div style="page-break-after: always;"></div>
 ---
 
 # Navigating OutBook
@@ -193,6 +195,8 @@ Examples:
 - `listc` followed by `delete 2` deletes the 2nd person in the results of the `listc` command.
 - `findc Betsy` followed by `delete 1` deletes the 1st person in the results of the `findc` command.
 
+<div style="page-break-after: always;"></div>
+
 ### Editing a contact : `editc`
 
 Edits an existing contact in OutBook.
@@ -211,9 +215,6 @@ Examples:
 - `editc 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
 
 
-<div style="page-break-after: always;"></div>
-
-
 ### Viewing detailed contact information : `viewc`
 
 Views detailed information of a contact in OutBook.
@@ -230,6 +231,7 @@ Format: `viewc INDEX`
 Examples:
 - `viewc 2` Displays detailed information related to the 2nd contact on the list.
 
+<div style="page-break-after: always;"></div>
 
 ### Finding persons using contact fields: `findc`
 Find persons whose contact details match the keywords specified for at least 1 of these fields: `NAME`, `PHONE_NUMBER`, `EMAIL`, `STATUS`, `TAG`.
@@ -249,6 +251,8 @@ Format: `findc [n/KEYWORDS] [p/KEYWORDS] [e/KEYWORDS] [lc/DATETIME] [s/KEYWORDS]
   - e.g. `n/John Doe s/active` will return `Name: John Lee, Status: Active` but not `Name: James Doe, Status: Claimant`.
 * This command clears the contact that is currently displayed via the `viewc` command.
 
+<div style="page-break-after: always;"></div>
+
 Examples:
 - `findc n/alice` returns `Alice` and `alice tan`
 - `findc p/51` returns `95163890` and `40351`
@@ -285,6 +289,7 @@ Format: `listm`
 
 * This command may change the Meeting that is currently displayed via the `viewm` command, as detailed in the description for `viewm`.
 
+<div style="page-break-after: always;"></div>
 
 ### Deleting a meeting : `deletem`
 
@@ -318,6 +323,8 @@ Examples:
 - `editm 1 a/Hawker Centre s/15.09.2023 1500` Edits the location and start of the 1st meeting to be `Hawker Centre` and `15.09.2023 1500` respectively.
 - `editm 2 m/Zoom meeting t/` Edits the title of the 2nd meeting to be `Zoom meeting` and clears all existing tags.
 
+<div style="page-break-after: always;"></div>
+
 ### Viewing detailed meeting information : `viewm`
 
 Views detailed information of a meeting in OutBook.
@@ -362,7 +369,7 @@ Examples:
 
 <div style="page-break-after: always;"></div>
 
-![result for 'findAlexMeeting'](images/findJohnMeetingResult.png)
+![result for 'findJohnMeeting'](images/findJohnMeetingResult.png)
 
 <div style="page-break-after: always;"></div>
 
@@ -397,6 +404,8 @@ Format: `rmmc MEETING_INDEX ATTENDEE_INDEX`
 Examples:
 - `rmmc 3 2` removes the 2nd attendee from the 3rd meeting in OutBook.
 
+<div style="page-break-after: always;"></div>
+
 ### Marking a meeting as complete : `mark`
 
 Marks a meeting in OutBook as complete. All attendees of the meeting will have their LC (last contacted) field updated to the end time of the meeting.

diff --git a/docs/images/Ui.png b/docs/images/Ui.png
diff --git a/docs/images/findAlexDavidResult.png b/docs/images/findAlexDavidResult.png
diff --git a/docs/images/findContactResult.png b/docs/images/findContactResult.png
diff --git a/docs/images/findJohnMeetingResult.png b/docs/images/findJohnMeetingResult.png
diff --git a/docs/images/helpMessage.png b/docs/images/helpMessage.png
diff --git a/docs/index.md b/docs/index.md
@@ -8,7 +8,7 @@ title: OutBook
 
 ![Ui](images/Ui.png)
 
-**OutBook is a desktop application that can help professionals to manage and schedule meetings.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
+**OutBook is a desktop app that allows freelance insurance agents to manage their numerous contacts and meeting schedule.** Users can link their contacts to their meetings, to keep track of the personnel attending these meetings.
 
 * If you are interested in using OutBook, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
 * If you are interested about developing OutBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.

diff --git a/src/main/java/seedu/address/model/util/SampleDataUtil.java b/src/main/java/seedu/address/model/util/SampleDataUtil.java
@@ -37,8 +37,8 @@ public static Person[] getSamplePersons() {
                         DateTimeUtil.parse("02.10.2023 1500"), new Status(""), new Remark(""),
                         getTagSet("neighbours")),
             new Person(new Name("David Li"), new Phone("91031282"), new Email("lidavid@example.com"),
-                        DateTimeUtil.parse("02.10.2023 1700"), new Status(""), new Remark(""),
-                        getTagSet("family")),
+                        DateTimeUtil.parse("02.10.2023 1000"), new Status(""), new Remark(""),
+                        getTagSet("colleagues")),
             new Person(new Name("Irfan Ibrahim"), new Phone("92492021"), new Email("irfan@example.com"),
                         DateTimeUtil.parse("02.10.2023 1900"), new Status(""), new Remark(""),
                         getTagSet("classmates")),
@@ -50,14 +50,14 @@ public static Person[] getSamplePersons() {
 
     public static Meeting[] getSampleMeetings() {
         return new Meeting[] {
-            new Meeting(new Title("Test Meeting 1"), new Location("Room 1"),
+            new Meeting(new Title("Meeting with Alex"), new Location("Starbucks"),
                     DateTimeUtil.parse("02.10.2023 1000"),
-                    DateTimeUtil.parse("03.10.2023 1000"),
+                    DateTimeUtil.parse("02.10.2023 1200"),
                     getAttendeeSet("Alex Yeoh"), getTagSet("work"), new MeetingStatus(false)),
-            new Meeting(new Title("Test Meeting 2"), new Location("Room 2"),
-                    DateTimeUtil.parse("02.10.2023 1000"),
+            new Meeting(new Title("Meet with team"), new Location("Office meeting room"),
                     DateTimeUtil.parse("02.10.2023 1000"),
-                    getAttendeeSet(), getTagSet(), new MeetingStatus(false)),
+                    DateTimeUtil.parse("03.10.2023 1200"),
+                    getAttendeeSet("Bernice Yu", "David Li"), getTagSet("work"), new MeetingStatus(false)),
         };
     }