Skip to content

Commit ecd0b15

Browse files
committed
UG: Add clear part of tutorial
1 parent 6a84f8b commit ecd0b15

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

docs/UserGuide.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,11 @@ Here's a quick summary of what WedLog can do for you:
3535
&emsp; 3.3.1. [RSVP Status panel](#3-3-1-rsvp-status-panel)<br>
3636
&emsp; 3.3.2. [Dietary Requirements panel](#3-3-2-dietary-requirements-panel)<br>
3737
4. [WedLog Tutorial](#4-wedlog-tutorial)<br>
38-
4.1. [Adding a guest](#4-1-adding-a-guest)<br>
39-
4.2. [Editing a guest](#4-2-editing-a-guest)<br>
40-
4.3. [Filtering guests](#4-3-filtering-guests)<br>
41-
4.4. [What's next?](#4-4-what-s-next)<br>
38+
4.1. [Clearing guests and vendors](#4-1-clearing-guests-and-vendors)<br>
39+
4.2. [Adding a guest](#4-2-adding-a-guest)<br>
40+
4.3. [Editing a guest](#4-3-editing-a-guest)<br>
41+
4.4. [Filtering guests](#4-4-filtering-guests)<br>
42+
4.5. [What's next?](#4-5-what-s-next)<br>
4243
5. [Features](#5-features)<br>
4344
5.1. [Add Command](#5-1-add-command)<br>
4445
&emsp; 5.1.1. [Adding a guest: `guest add`](#5-1-1-adding-a-guest-guest-add)<br>
@@ -139,7 +140,7 @@ If you would like a detailed look into each of the features WedLog has to offer,
139140

140141
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.
141142

142-
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.
143+
5. A window similar to the one below should appear in a few seconds. Note how the app contains some sample data.
143144

144145
<br>
145146

@@ -283,7 +284,22 @@ Welcome to the WedLog Tutorial! In this section, we'll guide you through the bas
283284

284285
--------------------------------------------------------------------------------------------------------------------
285286

286-
### 4.1. Adding a guest
287+
### 4.1. Clearing guests and vendors
288+
289+
When you first open WedLog, the app contains some sample data. Let's reset the app using the `clear` command.
290+
291+
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.
292+
293+
Your app should now look like this:
294+
295+
![clear.png](images%2Ftutorial%2Fclear.png)
296+
297+
<br />
298+
299+
> [Back to top](#user-guide)
300+
--------------------------------------------------------------------------------------------------------------------
301+
302+
### 4.2. Adding a guest
287303

288304
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.
289305

@@ -307,7 +323,7 @@ Notice how the default RSVP status for a guest is 'Unknown'. We'll learn how to
307323
308324
--------------------------------------------------------------------------------------------------------------------
309325

310-
### 4.2. Editing a guest
326+
### 4.3. Editing a guest
311327

312328
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`.
313329

@@ -335,7 +351,7 @@ This ensures that the tallies on the dietary requirements panel reflect only gue
335351

336352
<div style="page-break-after: always;"></div>
337353

338-
### 4.3. Filtering guests
354+
### 4.4. Filtering guests
339355

340356
Let's narrow down the guest list based on specific criteria using the `guest filter` command.
341357

@@ -413,7 +429,7 @@ Notice that John Doe is not included on this list, since we have previously assi
413429

414430
<div style="page-break-after: always;"></div>
415431

416-
### 4.4. What's next?
432+
### 4.5. What's next?
417433

418434
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.
419435

0 commit comments

Comments
 (0)