diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 26b673aeb1a..eafd9be7586 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -38,11 +38,10 @@ Here's a quick summary of what WedLog can do for you:   3.3.1. [RSVP Status panel](#3-3-1-rsvp-status-panel)
  3.3.2. [Dietary Requirements panel](#3-3-2-dietary-requirements-panel)
4. [WedLog Tutorial](#4-wedlog-tutorial)
- 4.1. [Clearing guests and vendors](#4-1-clearing-guests-and-vendors)
- 4.2. [Adding a guest](#4-2-adding-a-guest)
- 4.3. [Editing a guest](#4-3-editing-a-guest)
- 4.4. [Filtering guests](#4-4-filtering-guests)
- 4.5. [What's next?](#4-5-what-s-next)
+ 4.1. [Adding a guest](#4-1-adding-a-guest)
+ 4.2. [Editing a guest](#4-2-editing-a-guest)
+ 4.3. [Filtering guests](#4-3-filtering-guests)
+ 4.4. [What's next?](#4-4-what-s-next)
5. [Features](#5-features)
5.1. [Add Command](#5-1-add-command)
  5.1.1. [Adding a guest: `guest add`](#5-1-1-adding-a-guest-guest-add)
@@ -132,8 +131,9 @@ If you would like a detailed look into each of the features WedLog has to offer, 1. Ensure you have Java version `11` or above installed in your Computer. - You may refer to [this guide](https://blog.hubspot.com/website/check-java-verison) to check the Java version running on your computer. - If your computer is not running Java version `11` or above, you may refer to these guides ([Windows](https://www.codejava.net/java-se/download-and-install-java-11-openjdk-and-oracle-jdk), [Mac](https://java.tutorials24x7.com/blog/how-to-install-java-11-on-mac)) - for instructions on how to install Jave version `11` on your computer. - + for instructions on how to install Java version `11` on your computer. + +
2. Download the latest `wedlog.jar` file by clicking [here](https://github.com/AY2324S1-CS2103T-F11-2/tp/releases/download/v1.4/wedlog.jar). @@ -141,7 +141,7 @@ If you would like a detailed look into each of the features WedLog has to offer, 4. Open the WedLog application by double-clicking on the `wedlog.jar` file. If this does not work, [open your computer's terminal](https://towardsdatascience.com/a-quick-guide-to-using-command-line-terminal-96815b97b955), [navigate to the folder](https://tutorials.codebar.io/command-line/introduction/tutorial.html) containing `wedlog.jar`, and type `java -jar wedlog.jar` to start the application. -5. A window similar to the one below should appear in a few seconds. Note how the app contains some sample data. +5. A window similar to the one below should appear in a few seconds. Note that the app does not come pre-loaded with any data.
@@ -277,23 +277,7 @@ Welcome to the WedLog Tutorial! In this section, we'll guide you through the bas -------------------------------------------------------------------------------------------------------------------- -### 4.1. Clearing guests and vendors - -When you first open WedLog, the app contains some sample data. Let's reset the app using the `clear` command. - -Type `clear` into the command box and press the `Enter` key. This will delete all the data from both the guest and vendor lists, so that you have a clean slate to work with. - -Your app should now look like this: - -![clear.png](images%2Ftutorial%2Fclear.png) - -
- -> [Back to top](#user-guide) - --------------------------------------------------------------------------------------------------------------------- - -### 4.2. Adding a guest +### 4.1. Adding a guest Let's add your first guest to WedLog with the `guest add` command. Every guest must have a name, and you have the option to include additional details such as a phone number, address, email, and table number. Furthermore, a guest can be associated with multiple tags. @@ -317,7 +301,7 @@ Notice how the default RSVP status for a guest is 'Unknown'. We'll learn how to -------------------------------------------------------------------------------------------------------------------- -### 4.3. Editing a guest +### 4.2. Editing a guest Let's make adjustments to the details of a guest with the `guest edit` command. Suppose John Doe has responded to your invite and confirms that he will be attending your wedding. To reflect this, we'll update the `RSVP status` for John Doe to `Yes`. @@ -343,7 +327,7 @@ This ensures that the tallies on the dietary requirements panel reflect only gue -------------------------------------------------------------------------------------------------------------------- -### 4.4. Filtering guests +### 4.3. Filtering guests Let's narrow down the guest list based on specific criteria using the `guest filter` command. @@ -413,7 +397,7 @@ Notice that John Doe is not included on this list, since we have previously assi -------------------------------------------------------------------------------------------------------------------- -### 4.5. What's next? +### 4.4. What's next? Congratulations! You've completed the essential steps of the WedLog Tutorial, setting the stage for seamless and organized wedding planning. Armed with the knowledge of adding guests, editing details, and filtering, you're well-equipped to make the most of WedLog.