Skip to content

Commit 4bd4fbc

Browse files
committed
UG: Remove image hyperlinks
The images have hyperlinks that will link to 127.0.0.1:8080 if the UG is printed using `npm run serve`. Let's use the pic component to prevent the pictures from having hyperlinks.
1 parent ecd0b15 commit 4bd4fbc

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/UserGuide.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ If you would like a detailed look into each of the features WedLog has to offer,
144144

145145
<br>
146146

147-
![Ui](images/Ui.png)
147+
<pic src="images/Ui.png" alt="Screenshot of the user interface"> <br>
148148

149149
Once you have set up WedLog on your computer, take a quick tour of the WedLog interface in the next section.
150150

@@ -158,15 +158,15 @@ Once you have set up WedLog on your computer, take a quick tour of the WedLog in
158158

159159
In this section, we give a comprehensive breakdown of the WedLog interface, offering insights into its intuitive design and functionality. Explore the components below to gain a comprehensive understanding of how WedLog simplifies wedding planning.
160160

161-
![ui-overview.png](images%2Funderstanding-interface%2Fui-overview.png)
161+
<pic src="images/understanding-interface/ui-overview.png" alt="Screenshot of the user interface overview"> <br>
162162

163163
--------------------------------------------------------------------------------------------------------------------
164164

165165
### 3.1. User Input and Feedback
166166

167167
WedLog is optimised for keyboard-based interaction to enhance the efficiency of your wedding planning process. This interaction is facilitated by the command box and result display boxes.
168168

169-
![input-output.png](images%2Funderstanding-interface%2Finput-output.png)
169+
<pic src="images/understanding-interface/input-output.png" alt="Screenshot of the command box and result display"> <br>
170170

171171
--------------------------------------------------------------------------------------------------------------------
172172

@@ -196,23 +196,23 @@ At the top of each list, you'll find a number indicating the total entries for t
196196

197197
To navigate through your extensive lists, a user-friendly scroll bar is provided.
198198

199-
![lists.png](images%2Funderstanding-interface%2Flists.png)
199+
<pic src="images/understanding-interface/lists.png" alt="Screenshot of the guest and vendor lists"> <br>
200200

201201
<div style="page-break-after: always;"></div>
202202

203203
#### 3.2.1. Guest list
204204

205205
The guest list allows you to meticulously manage and track all information related to your guests.
206206

207-
![guest-card.png](images%2Funderstanding-interface%2Fguest-card.png)
207+
<pic src="images/understanding-interface/guest-card.png" alt="Screenshot of a guest card"> <br>
208208

209209
Individualized guest cards present comprehensive details, including tags, dietary requirements, RSVP status, phone numbers, addresses, emails, and assigned table numbers. This organized representation ensures that each guest's information is easily accessible and manageable.
210210

211211
#### 3.2.2. Vendor list
212212

213213
Similar to the guest list, the vendor list serves as a dedicated space for managing the vendors you are liaising with.
214214

215-
![vendor-card.png](images%2Funderstanding-interface%2Fvendor-card.png)
215+
<pic src="images/understanding-interface/vendor-card.png" alt="Screenshot of a vendor card"> <br>
216216

217217
Vendor cards encapsulate key information such as tags, phone numbers, addresses, and emails, providing you with a comprehensive snapshot of each vendor's essential details.
218218

@@ -228,7 +228,7 @@ Vendor cards encapsulate key information such as tags, phone numbers, addresses,
228228

229229
The Quick View panel allows you to see an overview of your guests at a glance. It is located on the left side of the window.
230230

231-
<img src="images/understanding-interface/quick-view-panel.png" alt="WedLog's Quick View panel" height="350"> <br />
231+
<pic src="images/understanding-interface/quick-view-panel.png" alt="WedLog's Quick View panel" height="350"> <br />
232232

233233
The Quick View panel consists of 2 sections: the RSVP Status panel and the Dietary Requirements panel.
234234

@@ -240,7 +240,7 @@ The RSVP Status panel is designed to help you keep track of the proportion of RS
240240
represented using a pie chart, with labels indicating the number of guests with each RSVP status. The pie chart is updated automatically
241241
whenever you add, delete or edit a guest.
242242

243-
<img src="images/understanding-interface/rsvp-status-panel.png" alt="RSVP Status panel" width="300" height="150"> <br />
243+
<pic src="images/understanding-interface/rsvp-status-panel.png" alt="RSVP Status panel"> <br />
244244

245245
The pie chart slices are colour-coded as follows:
246246
- `Yes`: Green
@@ -292,7 +292,7 @@ Type `clear` into the command box and press the `Enter` key. This will delete al
292292

293293
Your app should now look like this:
294294

295-
![clear.png](images%2Ftutorial%2Fclear.png)
295+
<pic src="images/tutorial/clear.png" alt="Screenshot after clear command"> <br>
296296

297297
<br />
298298

@@ -309,7 +309,7 @@ To add a guest named `John Doe` with the details provided, type the following co
309309

310310
Congratulations! You have successfully added your first guest to your guest list. Your app should now look like this:
311311

312-
![guest-add.png](images%2Ftutorial%2Fguest-add.png)
312+
<pic src="images/tutorial/guest-add.png" alt="Screenshot after guest add command"> <br>
313313

314314
<box type="tip">
315315

@@ -333,7 +333,7 @@ Type the following command and press `Enter`:
333333

334334
Your app should now look like this:
335335

336-
![guest-edit.png](images%2Ftutorial%2Fguest-edit.png)
336+
<pic src="images/tutorial/guest-edit.png" alt="Screenshot after guest edit command"> <br>
337337

338338
<box type="tip">
339339

@@ -369,7 +369,7 @@ Notice that parameters can be placed in any order. (e.g. Lily Mae's name is spec
369369

370370
Your app should now look like this:
371371

372-
![guest-filter-0.png](images%2Ftutorial%2Fguest-filter-0.png)
372+
<pic src="images/tutorial/guest-filter-0.png" alt="Screenshot after adding guests"> <br>
373373

374374
Now that we have a few guests on our list, let's begin filtering.
375375

@@ -381,7 +381,7 @@ First, let's filter for all guests who are friends. The following command will r
381381

382382
Your guest list should now look like this:
383383

384-
![guest-filter-1.png](images%2Ftutorial%2Fguest-filter-1.png)
384+
<pic src="images/tutorial/guest-filter-1.png" alt="Screenshot after guest filter t/friends"> <br>
385385

386386
<box type="tip">
387387

@@ -397,7 +397,7 @@ Next, let's narrow down our search to filter for all guests who are friends from
397397

398398
Your guest list should now look like this:
399399

400-
![guest-filter-2.png](images%2Ftutorial%2Fguest-filter-2.png)
400+
<pic src="images/tutorial/guest-filter-2.png" alt="Screenshot after guest filter t/friends t/university"> <br>
401401

402402
<box type="tip">
403403

@@ -413,7 +413,7 @@ Finally, let's filter for all guests who have not been assigned to any table yet
413413

414414
Your guest list should now look like this:
415415

416-
![guest-filter-3.png](images%2Ftutorial%2Fguest-filter-3.png)
416+
<pic src="images/tutorial/guest-filter-3.png" alt="Screenshot after guest filter tn/"> <br>
417417

418418
<box type="tip">
419419

0 commit comments

Comments
 (0)