Merge pull request #198 from AnnabelTing/master

AY2324S1-CS2103T-F10-1 · Nov 3, 2023 · 5eb755b · 5eb755b
2 parents 8c5d839 + fb99a1d
commit 5eb755b
Show file tree

Hide file tree

Showing 13 changed files with 78 additions and 21 deletions.
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -25,9 +25,12 @@ CheckMate is a **desktop app for streamlining the process of room bookings for h
 
 4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar checkmate.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)
+   ![LandingGUI](images/LandingGUI.png)
 
-5. 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>
+5. Clicking on a booking will allow you to see its details.
+   ![ClickBooking.png](images%2FClickBooking.png)
+
+6. 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 bookings.
@@ -102,11 +105,14 @@ Format: `help`
 Adds a booking to the bookings book.
 
 Format: `add r/ROOM d/BOOKING_PERIOD n/NAME p/PHONE_NUMBER e/EMAIL rm/REMARK`
+![AddCommand.png](images%2FAddCommand.png)
 
 <div markdown="span" class="alert alert-primary">:bulb: **Note:**
-The room number is used to assign the room type
+The room number is used to assign the room type.
 </div>
 
+* Image above shows result of command `add r/1 d/2023-01-01 08:00 to 2023-01-02 12:00 n/John Doe p/98765432 e/[email protected]`
+
 Examples:
 * `add r/1 d/2023-01-01 08:00 to 2023-01-02 12:00 n/John Doe p/98765432 e/[email protected]`
 * `add r/256 d/2023-02-01 15:00 to 2023-02-02 23:59 n/Betsy Crowe p/99990000 e/[email protected]`
@@ -117,12 +123,19 @@ Shows a list of all bookings in the bookings book.
 
 Format: `list`
 
+![ListCommand.png](images%2FListCommand.png)
+
+* Example image above shows result of command `list`
+
 ### Editing a booking : `edit`
 
 Edits an existing booking in the bookings book.
 
 Format: `edit INDEX [r/ROOM] [d/BOOKING_PERIOD] [n/NAME] [p/PHONE] [e/EMAIL]`
 
+![EditCommand.png](images%2FEditCommand.png)
+
+* Example image above shows result of command `edit 1 p/91234567 e/[email protected]`
 * Edits the booking at the specified `INDEX`. The index refers to the index number shown in the displayed booking list. The index **must be a positive integer** 1, 2, 3, …
 * At least one of the optional fields must be provided.
 * Existing values will be updated to the input values.
@@ -137,6 +150,9 @@ Finds bookings whose bookings contain the room, name, or both.
 
 Format: `find KEYWORD [MORE_KEYWORDS]`
 
+![FindCommand.png](images%2FFindCommand.png)
+
+* Example image above shows result of command `find 1`
 * The search is case-insensitive. e.g `hans` will match `Hans`
 * The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
 * Only the name and room is searched.
@@ -155,6 +171,9 @@ Deletes the specified booking from the bookings book.
 
 Format: `delete INDEX ...`
 
+![DeleteCommand.png](images%2FDeleteCommand.png)
+
+* Example image above shows result of command `delete 2`
 * Deletes the booking at the specified `INDEX`.
 * The index refers to the index number shown in the displayed booking list.
 * The index **must be a positive integer** 1, 2, 3, …
@@ -170,20 +189,57 @@ Reverts the most recent deletion.
 
 Format: `undo`
 
+![UndoCommand.png](images%2FUndoCommand.png)
+
+* Example image above shows the result of command `undo`
 * Adds the most recently deleted booking back to the system.
 
+### Flagging an entry: `flag`
+
+Flags a booking that requires attention.
+
+Format: `flag INDEX`
+
+![FlagCommand.png](images%2FFlagCommand.png)
+
+* Example image above shows the result of command `flag 3`
+* Flagged booking will move to the top portion of the list.
+* The index refers to the index number shown in the displayed booking list.
+* Index must be a positive integer.
+* Only one entry can be flagged at a time.
+
+### Unflagging an entry: `unflag`
+
+Unflags a booking that no longer requires attentiobn.
+
+Format `unflag INDEX`
+
+* Example image above shows the result of command `unflag 1`
+* Unflagged booking will move to the bottom portion of the list.
+* The index refers to the index number shown in the displayed booking list.
+* Index must be a positive integer.
+* Only one entry can be unflagged at a time.
+
+![UnflagCommand.png](images%2FUnflagCommand.png)
+
 ### Clearing all entries : `clear`
 
 Clears all entries from the bookingPeriod book.
 
 Format: `clear`
 
+![ClearCommand.png](images%2FClearCommand.png)
+
+* Example image above shows the result of command `clear`
+
 ### Exiting the program : `exit`
 
 Exits the program.
 
 Format: `exit`
 
+* The window will close automatically on command `exit`
+
 ### Saving the data
 
 AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
@@ -223,14 +279,14 @@ Example:
 
 ## Commands Summary
 
-Action | Format, Examples
---------|------------------
-**Add** | `add r/ROOM d/BOOKING_PERIOD n/NAME p/PHONE_NUMBER e/EMAIL rm/REMARK` <br> e.g., `add r/1 d/2023-01-01 to 2023-01-02 n/James Ho p/22224444 e/[email protected] rm/Extra Towels`
-**Clear** | `clear`
-**Delete** | `delete INDEX`<br> e.g., `delete 3`
-**Undo** | `undo`
-**Edit** | `edit INDEX [r/ROOM] [d/BOOKING _PERIOD] [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [rm/REMARK] [t/TAG]…`<br> e.g.,`edit 2 r/2 d/2023-01-01 to 2023-01-02 n/James Lee e/[email protected]`
-**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find 1`
-**List** | `list`
-**Help** | `help`
-**Exit** | `exit`
+| Action     | Format, Examples                                                                                                                                                                        |
+|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Add**    | `add r/ROOM d/BOOKING_PERIOD n/NAME p/PHONE_NUMBER e/EMAIL rm/REMARK` <br> e.g., `add r/1 d/2023-01-01 to 2023-01-02 n/James Ho p/22224444 e/[email protected] rm/Extra Towels`       |
+| **Clear**  | `clear`                                                                                                                                                                                 |
+| **Delete** | `delete INDEX`<br> e.g., `delete 3`                                                                                                                                                     |
+| **Undo**   | `undo`                                                                                                                                                                                  |
+| **Edit**   | `edit INDEX [r/ROOM] [d/BOOKING _PERIOD] [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [rm/REMARK] [t/TAG]…`<br> e.g.,`edit 2 r/2 d/2023-01-01 to 2023-01-02 n/James Lee e/[email protected]` |
+| **Find**   | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find 1`                                                                                                                                       |
+| **List**   | `list`                                                                                                                                                                                  |
+| **Help**   | `help`                                                                                                                                                                                  |
+| **Exit**   | `exit`                                                                                                                                                                                  |
diff --git a/docs/images/AddCommand.png b/docs/images/AddCommand.png
diff --git a/docs/images/ClearCommand.png b/docs/images/ClearCommand.png
diff --git a/docs/images/ClickBooking.png b/docs/images/ClickBooking.png
diff --git a/docs/images/DeleteCommand.png b/docs/images/DeleteCommand.png
diff --git a/docs/images/EditCommand.png b/docs/images/EditCommand.png
diff --git a/docs/images/FindCommand.png b/docs/images/FindCommand.png
diff --git a/docs/images/FlagCommand.png b/docs/images/FlagCommand.png
diff --git a/docs/images/LandingGUI.png b/docs/images/LandingGUI.png
diff --git a/docs/images/ListCommand.png b/docs/images/ListCommand.png
diff --git a/docs/images/UndoCommand.png b/docs/images/UndoCommand.png
diff --git a/docs/images/UnflagCommand.png b/docs/images/UnflagCommand.png
diff --git a/docs/team/annabelting.md b/docs/team/annabelting.md
@@ -9,16 +9,17 @@ CheckMate is designed to streamline the process of room bookings for hotel emplo
 
 Given below are my contributions to the project.
 
-* **New Feature**:
+* **New Feature**: (Coming Soon) Set-up command to allow users to customise the app to their infrastructure.
 
-* **Code contributed**:
+* **Code contributed**: [Reposense Link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=Annabel&sort=groupTitle&sortWithin=title&timeframe=commit&mergegroup=&groupSelect=groupByRepos&breakdown=true&checkedFileTypes=docs~functional-code~test-code~other&since=2023-09-22&tabOpen=true&tabType=authorship&zFR=false&tabAuthor=AnnabelTing&tabRepo=AY2324S1-CS2103T-F10-1%2Ftp%5Bmaster%5D&authorshipIsMergeGroup=false&authorshipFileTypes=functional-code~test-code&authorshipIsBinaryFileTypeChecked=false&authorshipIsIgnoredFilesChecked=false)
 
-* **Project management**:
+* **Project management**: Managed issues and tested out release.
 
-* **Enhancements to existing features**:
+* **Enhancements to existing features**: Added a method to compare booking and ensure that all bookings are unique.
 
-* **Documentation**:
+* **Documentation**: 
+* Added descriptions for some features in the developer guide
+* Added in new features and updated screenshots in the user guide
 
-* **Community**:
+* **Community**: Looked through peer's code and provided feedback.
 
-* **Tools**: