Merge pull request #108 from AY2324S1-CS2103T-T10-2/docs/v1.3-ug

docs: Update v1.3 User Guide
AY2324S1-CS2103T-T10-2 · Nov 2, 2023 · d493c54 · d493c54
2 parents a7b9721 + be86229
commit d493c54
Show file tree

Hide file tree

Showing 96 changed files with 843 additions and 285 deletions.
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
diff --git a/docs/_sass/admonition.scss b/docs/_sass/admonition.scss
@@ -7,9 +7,9 @@ $primary-color: #eab308; // yellow-500
 $primary-bgcolor: #fef9c3; // yellow-100
 $admonitions:
     //class (type), icon filename, icon/border color, title bg color
-    ('note', 'pen-solid.svg', '#2563eb', '#dbeafe') // blue-600; blue-100
+    ('note', 'pen-solid.svg', '#0ea5e9', '#e0f2fe') // sky-500; sky-100
     ('abstract', 'align-left-solid.svg', '#65a30d', '#ecfccb') // lime-600; lime-100
-    ('info', 'info-circle-solid.svg', '#0ea5e9', '#e0f2fe') // sky-500; sky-100
+    // ('info', 'info-circle-solid.svg', '#0ea5e9', '#e0f2fe') // sky-500; sky-100
     ('tip', 'fire-solid.svg', '#14b8a6', '#cafdf8') // teal-500; turquoise-100?
     ('success', 'check-circle-solid.svg', '#059669', '#d1fae5') // emerald-600; emerald-100
     ('question', 'question-circle-solid.svg', '#4f46e5', '#e0e7ff') // indigo-600; indigo-100

diff --git a/docs/images/Ui.png b/docs/images/Ui.png
diff --git a/docs/images/addPerson_success.png b/docs/images/addPerson_success.png
diff --git a/docs/images/deleteAllPerson_success.png b/docs/images/deleteAllPerson_success.png
diff --git a/docs/images/editPerson_success.png b/docs/images/editPerson_success.png
diff --git a/docs/images/error/addPerson_error.png b/docs/images/error/addPerson_error.png
diff --git a/docs/images/error/addTagPerson_error_invalidIndex.jpg b/docs/images/error/addTagPerson_error_invalidIndex.jpg
diff --git a/docs/images/error/addTagPerson_error_invalidIndex.png b/docs/images/error/addTagPerson_error_invalidIndex.png
diff --git a/docs/images/error/addTagPerson_error_noInput.png b/docs/images/error/addTagPerson_error_noInput.png
diff --git a/docs/images/error/addTagPerson_error_noParameters.jpg b/docs/images/error/addTagPerson_error_noParameters.jpg
diff --git a/docs/images/error/addTagPerson_error_noParameters.png b/docs/images/error/addTagPerson_error_noParameters.png
diff --git a/docs/images/error/addTagPerson_error_prefix.jpg b/docs/images/error/addTagPerson_error_prefix.jpg
diff --git a/docs/images/error/addTagPerson_error_validIndex.jpg b/docs/images/error/addTagPerson_error_validIndex.jpg
diff --git a/docs/images/error/addTagPerson_error_validIndex.png b/docs/images/error/addTagPerson_error_validIndex.png
diff --git a/docs/images/error/addTagTask_error_invalidIndex.jpg b/docs/images/error/addTagTask_error_invalidIndex.jpg
diff --git a/docs/images/error/addTagTask_error_invalidIndex.png b/docs/images/error/addTagTask_error_invalidIndex.png
diff --git a/docs/images/error/addTagTask_error_noInput.png b/docs/images/error/addTagTask_error_noInput.png
diff --git a/docs/images/error/addTagTask_error_noParam.jpg b/docs/images/error/addTagTask_error_noParam.jpg
diff --git a/docs/images/error/addTagTask_error_noParameters.png b/docs/images/error/addTagTask_error_noParameters.png
diff --git a/docs/images/error/addTagTask_error_prefix.jpg b/docs/images/error/addTagTask_error_prefix.jpg
diff --git a/docs/images/error/addTagTask_error_validIndex.jpg b/docs/images/error/addTagTask_error_validIndex.jpg
diff --git a/docs/images/error/addTagTask_error_validIndex.png b/docs/images/error/addTagTask_error_validIndex.png
diff --git a/docs/images/error/addTask_error.png b/docs/images/error/addTask_error.png
diff --git a/docs/images/error/deleteAllDone_error.png b/docs/images/error/deleteAllDone_error.png
diff --git a/docs/images/error/deletePerson_error.png b/docs/images/error/deletePerson_error.png
diff --git a/docs/images/error/deletePerson_wrongIndex.png b/docs/images/error/deletePerson_wrongIndex.png
diff --git a/docs/images/error/deleteTask_error.png b/docs/images/error/deleteTask_error.png
diff --git a/docs/images/error/deleteTask_error1.png b/docs/images/error/deleteTask_error1.png
diff --git a/docs/images/error/deleteTask_wrongIndex.png b/docs/images/error/deleteTask_wrongIndex.png
diff --git a/docs/images/error/editPerson_error.png b/docs/images/error/editPerson_error.png
diff --git a/docs/images/error/editPerson_missingFields.png b/docs/images/error/editPerson_missingFields.png
diff --git a/docs/images/error/editPerson_wrongIndex.png b/docs/images/error/editPerson_wrongIndex.png
diff --git a/docs/images/error/editTask_error.png b/docs/images/error/editTask_error.png
diff --git a/docs/images/error/findAllTag_error.png b/docs/images/error/findAllTag_error.png
diff --git a/docs/images/error/findPerson_error.png b/docs/images/error/findPerson_error.png
diff --git a/docs/images/error/findTag_error.png b/docs/images/error/findTag_error.png
diff --git a/docs/images/error/findTask_error.png b/docs/images/error/findTask_error.png
diff --git a/docs/images/error/markTask_error.png b/docs/images/error/markTask_error.png
diff --git a/docs/images/error/markTask_wrongIndex.png b/docs/images/error/markTask_wrongIndex.png
diff --git a/docs/images/error/unmarkTask_error.png b/docs/images/error/unmarkTask_error.png
diff --git a/docs/images/error/unmarkTask_wrongIndex.png b/docs/images/error/unmarkTask_wrongIndex.png
diff --git a/docs/images/findPerson_success.png b/docs/images/findPerson_success.png
diff --git a/docs/images/findPerson_success_zeroResults.png b/docs/images/findPerson_success_zeroResults.png
diff --git a/docs/images/listPerson_success.png b/docs/images/listPerson_success.png
diff --git a/docs/images/output/addPerson_success.png b/docs/images/output/addPerson_success.png
diff --git a/docs/images/output/addTagPerson_success.png b/docs/images/output/addTagPerson_success.png
diff --git a/docs/images/output/addTagPerson_success_oneNew.jpg b/docs/images/output/addTagPerson_success_oneNew.jpg
diff --git a/docs/images/output/addTagPerson_success_oneNewOneOld.jpg b/docs/images/output/addTagPerson_success_oneNewOneOld.jpg
diff --git a/docs/images/output/addTagPerson_success_twoNew.jpg b/docs/images/output/addTagPerson_success_twoNew.jpg
diff --git a/docs/images/output/addTagTask_success.png b/docs/images/output/addTagTask_success.png
diff --git a/docs/images/output/addTagTask_success_oneNewOneOld.jpg b/docs/images/output/addTagTask_success_oneNewOneOld.jpg
diff --git a/docs/images/output/addTask_success.png b/docs/images/output/addTask_success.png
diff --git a/docs/images/output/addTask_success1.png b/docs/images/output/addTask_success1.png
diff --git a/docs/images/output/addTask_success2.png b/docs/images/output/addTask_success2.png
diff --git a/docs/images/output/deleteAllDone_success.png b/docs/images/output/deleteAllDone_success.png
diff --git a/docs/images/output/deleteAllPerson_success.png b/docs/images/output/deleteAllPerson_success.png
diff --git a/docs/images/output/deleteAllTask_success.png b/docs/images/output/deleteAllTask_success.png
diff --git a/docs/images/output/deletePerson_success.png b/docs/images/output/deletePerson_success.png
diff --git a/docs/images/output/deletePerson_success_filteredList.png b/docs/images/output/deletePerson_success_filteredList.png
diff --git a/docs/images/output/deleteTagPerson_success.png b/docs/images/output/deleteTagPerson_success.png
diff --git a/docs/images/output/deleteTagTask_success.png b/docs/images/output/deleteTagTask_success.png
diff --git a/docs/images/output/deleteTask_success.png b/docs/images/output/deleteTask_success.png
diff --git a/docs/images/output/deleteTask_success1.png b/docs/images/output/deleteTask_success1.png
diff --git a/docs/images/output/deleteTask_success_filteredList.png b/docs/images/output/deleteTask_success_filteredList.png
diff --git a/docs/images/output/editPerson_success.png b/docs/images/output/editPerson_success.png
diff --git a/docs/images/output/editPerson_success_clearTag.png b/docs/images/output/editPerson_success_clearTag.png
diff --git a/docs/images/output/editTask_success1.png b/docs/images/output/editTask_success1.png
diff --git a/docs/images/output/editTask_success2.png b/docs/images/output/editTask_success2.png
diff --git a/docs/images/output/findAllTag_success1.png b/docs/images/output/findAllTag_success1.png
diff --git a/docs/images/output/findAllTag_success2.png b/docs/images/output/findAllTag_success2.png
diff --git a/docs/images/output/findDone_noResults.png b/docs/images/output/findDone_noResults.png
diff --git a/docs/images/output/findDone_success.png b/docs/images/output/findDone_success.png
diff --git a/docs/images/output/findNotDone_noResults.png b/docs/images/output/findNotDone_noResults.png
diff --git a/docs/images/output/findNotDone_success.png b/docs/images/output/findNotDone_success.png
diff --git a/docs/images/output/findPerson_noResults.png b/docs/images/output/findPerson_noResults.png
diff --git a/docs/images/output/findPerson_success.png b/docs/images/output/findPerson_success.png
diff --git a/docs/images/output/findTag_success1.png b/docs/images/output/findTag_success1.png
diff --git a/docs/images/output/findTag_success2.png b/docs/images/output/findTag_success2.png
diff --git a/docs/images/output/findTask_noResults.png b/docs/images/output/findTask_noResults.png
diff --git a/docs/images/output/findTask_success.png b/docs/images/output/findTask_success.png
diff --git a/docs/images/output/help_success.png b/docs/images/output/help_success.png
diff --git a/docs/images/output/listAll_success.png b/docs/images/output/listAll_success.png
diff --git a/docs/images/output/listPerson_success.png b/docs/images/output/listPerson_success.png
diff --git a/docs/images/output/listTag_success.png b/docs/images/output/listTag_success.png
diff --git a/docs/images/output/listTask_success.png b/docs/images/output/listTask_success.png
diff --git a/docs/images/output/markTask_success.png b/docs/images/output/markTask_success.png
diff --git a/docs/images/output/markTask_success_filteredList.png b/docs/images/output/markTask_success_filteredList.png
diff --git a/docs/images/output/unmarkTask_success.png b/docs/images/output/unmarkTask_success.png
diff --git a/docs/images/output/unmarkTask_success_filteredList.png b/docs/images/output/unmarkTask_success_filteredList.png
diff --git a/src/main/java/seedu/address/logic/commands/AddPersonCommand.java b/src/main/java/seedu/address/logic/commands/AddPersonCommand.java
@@ -34,8 +34,8 @@ public class AddPersonCommand extends Command {
             + PREFIX_PHONE + "98765432 "
             + PREFIX_EMAIL + "[email protected] "
             + PREFIX_ADDRESS + "311, Clementi Ave 2, #02-25 "
-            + PREFIX_TAG + "friends "
-            + PREFIX_TAG + "owesMoney";
+            + PREFIX_TAG + "Microsoft "
+            + PREFIX_TAG + "guestSpeaker";
 
     public static final String MESSAGE_SUCCESS = "New person added: %1$s";
     public static final String MESSAGE_DUPLICATE_PERSON = "This person already exists in the address book";

diff --git a/src/main/java/seedu/address/logic/commands/AddTaskCommand.java b/src/main/java/seedu/address/logic/commands/AddTaskCommand.java
@@ -26,10 +26,10 @@ public class AddTaskCommand extends Command {
             + PREFIX_TASK_NOTE + "NOTE "
             + "[" + PREFIX_TAG + "TAG]...\n"
             + "Example: " + COMMAND_WORD + " "
-            + PREFIX_TASK_TITLE + "Get flowers "
-            + PREFIX_TASK_NOTE + "Wedding Anniversary "
-            + PREFIX_TAG + "finance "
-            + PREFIX_TAG + "class ";
+            + PREFIX_TASK_TITLE + "Meeting with team "
+            + PREFIX_TASK_NOTE + "Need to finalize event schedule "
+            + PREFIX_TAG + "orientation "
+            + PREFIX_TAG + "activities ";
 
     public static final String MESSAGE_SUCCESS = "New task added: %1$s";
     public static final String MESSAGE_DUPLICATE_TASK = "This task already exists in the address book";

diff --git a/src/main/java/seedu/address/logic/commands/EditTaskCommand.java b/src/main/java/seedu/address/logic/commands/EditTaskCommand.java
@@ -41,8 +41,8 @@ public class EditTaskCommand extends Command {
             + "[" + PREFIX_TASK_TITLE + "TITLE] "
             + "[" + PREFIX_TASK_NOTE + "NOTE] "
             + "[" + PREFIX_TAG + "TAG]...\n"
-            + "Example: " + COMMAND_WORD + " 1 "
-            + PREFIX_TASK_TITLE + "Prepare Agenda "
+            + "Example: " + COMMAND_WORD + " 2 "
+            + PREFIX_TASK_TITLE + "Discuss Agenda and Budget "
             + PREFIX_TASK_NOTE + "To book venue";
 
     public static final String MESSAGE_EDIT_TASK_SUCCESS = "Edited Task: %1$s";

diff --git a/src/main/java/seedu/address/logic/commands/FindPersonCommand.java b/src/main/java/seedu/address/logic/commands/FindPersonCommand.java
@@ -20,7 +20,7 @@ public class FindPersonCommand extends Command {
             + ": Finds all persons whose names contain any of "
             + "the specified keywords (case-insensitive) and displays them as a list with index numbers.\n"
             + "Parameters: KEYWORD [MORE_KEYWORDS]...\n"
-            + "Example: " + COMMAND_WORD + " alice bob charlie";
+            + "Example: " + COMMAND_WORD + " alex bernice charlotte";
 
     private final NameContainsKeywordsPredicate predicate;
 

diff --git a/src/main/java/seedu/address/logic/commands/FindTaskCommand.java b/src/main/java/seedu/address/logic/commands/FindTaskCommand.java
@@ -20,7 +20,7 @@ public class FindTaskCommand extends Command {
             + ": Finds all tasks whose title or note contain any of "
             + "the specified keywords (case-insensitive) and displays them as a list with index numbers.\n"
             + "Parameters: KEYWORD [MORE_KEYWORDS]...\n"
-            + "Example: " + COMMAND_WORD + " agenda budget";
+            + "Example: " + COMMAND_WORD + " budget";
 
     private final TaskContainsKeywordsPredicate predicate;
 

diff --git a/src/main/java/seedu/address/model/util/SampleDataUtil.java b/src/main/java/seedu/address/model/util/SampleDataUtil.java
@@ -24,29 +24,30 @@ public static Person[] getSamplePersons() {
         return new Person[] {
             new Person(new Name("Alex Yeoh"), new Phone("87438807"), new Email("[email protected]"),
                 new Address("Blk 30 Geylang Street 29, #06-40"),
-                getTagSet("friends")),
+                getTagSet("catering", "RilassisCatering")),
             new Person(new Name("Bernice Yu"), new Phone("99272758"), new Email("[email protected]"),
                 new Address("Blk 30 Lorong 3 Serangoon Gardens, #07-18"),
-                getTagSet("colleagues", "friends")),
+                getTagSet("soundSystems", "EragonSounds")),
             new Person(new Name("Charlotte Oliveiro"), new Phone("93210283"), new Email("[email protected]"),
                 new Address("Blk 11 Ang Mo Kio Street 74, #11-04"),
-                getTagSet("neighbours")),
-            new Person(new Name("David Li"), new Phone("91031282"), new Email("lidavid@example.com"),
-                new Address("Blk 436 Serangoon Gardens Street 26, #16-43"),
-                getTagSet("family")),
-            new Person(new Name("Irfan Ibrahim"), new Phone("92492021"), new Email("irfan@example.com"),
-                new Address("Blk 47 Tampines Street 20, #17-35"),
-                getTagSet("classmates")),
-            new Person(new Name("Roy Balakrishnan"), new Phone("92624417"), new Email("[email protected]"),
-                new Address("Blk 45 Aljunied Street 85, #11-31"),
-                getTagSet("colleagues"))
+                getTagSet("flowers", "CharlottesBoutique")),
+            new Person(new Name("Xiangs Catering"), new Phone("62840300"), new Email("sales@xiangscatering.com.sg"),
+                new Address("171 Kampong Ampat 02-02 KA Foodlink, 368330"),
+                getTagSet("378perMeal", "catering")),
+            new Person(new Name("EATZ"), new Phone("67890328"), new Email("sales@eatzcatering.com"),
+                new Address("1550 Bedok North Ave 4, #04-17, 489950"),
+                getTagSet("1000perMeal", "catering")),
+            new Person(new Name("Angels Restaurant"), new Phone("62431802"), new Email("[email protected]"),
+                new Address("3017 Bedok North Street 5, Singapore 486121"),
+                getTagSet("540perMeal", "catering"))
         };
     }
 
     public static Task[] getSampleTasks() {
         return new Task[] {
-            new Task(new Title("Find caterer"), new Note("for 221 students"), getTagSet("caterer")),
-            new Task(new Title("Create budget"), new Note("for CS2102"), getTagSet("finance", "class"))
+            new Task(new Title("Find caterer"), new Note("for 221 students in day 1 of orientation"), getTagSet(
+                    "caterer", "orientation")),
+            new Task(new Title("Create budget"), new Note("for finale night"), getTagSet("finance", "orientation"))
         };
     }