Update User Guide #170

HanB1n · 2024-10-29T06:54:06Z

Update Help Message to WedLinker's user guide.
Update AB3 and AddressBook to reflect WedLinker.
Update Jar File link.
Update Ui example image.
Update Quick Start guide to fit the target audience. Fix hyperlinks to accurately reflect its target.

Update Help Message to WedLinker's user guide. Update AB3 and AddressBook to reflect WedLinker. Update Jar File link. Update Ui example image. Update Quick Start guide to fit the target audience. Fix hyperlinks to accurately reflect its target.

codecov · 2024-10-29T06:55:20Z

Codecov Report

All modified and coverable lines are covered by tests ✅

dasha3412

LGTM, some nits and also a concern about the name of the json file we save the data in

dasha3412 · 2024-10-29T07:23:47Z

docs/UserGuide.md

@@ -6,7 +6,8 @@

 # WedLinker User Guide

-WedLinker is a **desktop app for managing contacts, optimized for use via a  Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps.
+WedLinker is a **desktop app for managing contacts, optimized for use via a Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). </br>


I think I remember prof saying something like the benefits of GUI being a bit vague, maybe we should expand on this?

dasha3412 · 2024-10-29T07:24:28Z

docs/UserGuide.md


-1. Download the latest `.jar` file from [here](https://github.com/se-edu/addressbook-level3/releases).
+2. Download the latest version of WedLinker from [here](https://github.com/AY2425S1-CS2103T-F15-4/tp/releases/). Select `WedLinker.jar` to begin the download.
+![release.png](images/release.png)


I like that you added an image of the release page so that the user knows if it's right.

dasha3412 · 2024-10-29T07:25:55Z

docs/UserGuide.md


-1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.<br>
+4. Open WedLinker by double clicking the program file, `WedLinker.jar`.<br>


Maybe can also have alternative opening instructions for cding into the file, I think sometimes if JAR does not work then user needs to use cd method - can have a troubleshooting section ?

Is the recommended way even for everyday users to double-click? I'm not too sure about it, correct me if I'm wrong!

dasha3412 · 2024-10-29T07:29:00Z

docs/UserGuide.md

@@ -58,37 +62,47 @@ WedLinker is a **desktop app for managing contacts, optimized for use via a  Lin
 * Items with `…` after them can be used multiple times including zero times.<br>
  e.g. `[t/TAG]…` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc.

+* Commands in WedLinker uses prefix to specify the parameters, the prefixes are stated as such:


Maybe typo, "Commands in WedLinker use prefixes to..."

dasha3412 · 2024-10-29T07:30:07Z

docs/UserGuide.md

 ![help message](images/helpMessage.png)

 Format: `help`

 ### Listing all Persons : `list`

-Shows a list of all saved [Persons](#adding-a-person-add) in the WedLinker.
+Shows a list of all saved [Persons](#person-features) in the WedLinker.


I like how you linked this to the Person features section

dasha3412 · 2024-10-29T07:31:45Z

docs/UserGuide.md


 ### Editing the data file

-AddressBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file.
+WedLinker data are saved automatically as a JSON file `[JAR file location]/data/WedLinker.json`. Advanced users are welcome to update data directly by editing that data file.


...Is this true? Did we change it to be saved as WedLinker.json?

I believe this is still addressbook.json

dasha3412

More comments on parts from previous UG changes

dasha3412 · 2024-10-29T07:37:53Z

docs/UserGuide.md

@@ -287,7 +294,7 @@ Format: `delete-wedding w/WEDDINGNAME [f/]`
 * The no contacts should be assigned to the `Wedding` before it is deleted.


Missed in previous review but should this line just say "No contacts should be ..."

dasha3412 · 2024-10-29T07:39:38Z

docs/UserGuide.md

@@ -233,7 +240,7 @@ Format: `delete-tag t/TAGNAME [f/]`
 * The `Tag` cannot be assigned to any contacts.
 * If the `Tag` is in used, you can use `f/` to force the deletion of the `Tag` and unassign this tag from all contacts.

-### Wedding Features
+## Wedding Features

 ### Adding a Wedding : `create-wedding`



In line 252, maybe should be "... there should not be/there cannot be any duplicated Weddings."

dasha3412 · 2024-10-29T07:42:02Z

docs/UserGuide.md


-### Tag Features
+## Tag Features

 ### Adding a tag : `create-tag`



On line 216 below, maybe should be "Tag a specified contact based on their INDEX with a Tag" just to make sure it's clear what index is referring to

dasha3412 · 2024-10-29T07:46:00Z

docs/UserGuide.md

@@ -287,7 +294,7 @@ Format: `delete-wedding w/WEDDINGNAME [f/]`
 * The no contacts should be assigned to the `Wedding` before it is deleted.


In line 273 above, maybe should have "Edits the specific Wedding at the INDEX in the view that lists weddings", because 'list-weddings' view might be too close to the actual command and too technical? Not sure about this

tingxuanp · 2024-10-29T07:08:42Z

docs/UserGuide.md

@@ -6,7 +6,8 @@

 # WedLinker User Guide

-WedLinker is a **desktop app for managing contacts, optimized for use via a  Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact management tasks done faster than traditional GUI apps.
+WedLinker is a **desktop app for managing contacts, optimized for use via a Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). </br>
+If you can type fast, WedLinker can get your contact management tasks done faster than traditional GUI apps.


I feel like this can still be more user-centric and targeted towards wedding planners, right now it still seems a bit generic? Maybe can talk about how its designed specifically for wedding planners to efficiently plan weddings

tingxuanp · 2024-10-29T07:37:35Z

docs/UserGuide.md

+![result for 'find n/alex david'](images/findCommandName.png)
+* `find t/friends` returns all Contacts tagged with Friends <br>
+![result for `find t/friends](images/findCommandTag.png)
+* `find w/Amy's Wedding` returns all Contacts involved with Amy's Wedding <br>


should we change this to Casey instead to match the image?

tingxuanp · 2024-10-29T07:43:42Z

docs/UserGuide.md

@@ -233,7 +240,7 @@ Format: `delete-tag t/TAGNAME [f/]`
 * The `Tag` cannot be assigned to any contacts.
 * If the `Tag` is in used, you can use `f/` to force the deletion of the `Tag` and unassign this tag from all contacts.

-### Wedding Features
+## Wedding Features

 ### Adding a Wedding : `create-wedding`


This is for line 265 since I can't add a comment there - should we give an example of how the force tag is used?

Line 251 - maybe can change to "the weddingname should be alphanumeric" rather than "is alphanumeric"?

tingxuanp · 2024-10-29T07:44:49Z

docs/UserGuide.md

@@ -287,7 +294,7 @@ Format: `delete-wedding w/WEDDINGNAME [f/]`
 * The no contacts should be assigned to the `Wedding` before it is deleted.


Typo/ grammar error here - "There should not be contacts assigned to.."/"There should be no"?

tingxuanp · 2024-10-29T07:45:57Z

docs/UserGuide.md

@@ -287,7 +294,7 @@ Format: `delete-wedding w/WEDDINGNAME [f/]`
 * The no contacts should be assigned to the `Wedding` before it is deleted.
 * If there are still contacts assigned, you can use `f/` to force the deletion of the `Wedding` and unassign all contacts.

-### Task Features
+## Task Features

 ### Creating a Task : `create-task`



I think we will need to specify the different task types and their respective commands/ keywords

riccoljy

LGTM!

riccoljy · 2024-10-29T09:43:03Z

docs/UserGuide.md


 ### Editing the data file

-AddressBook data are saved automatically as a JSON file `[JAR file location]/data/addressbook.json`. Advanced users are welcome to update data directly by editing that data file.
+WedLinker data are saved automatically as a JSON file `[JAR file location]/data/WedLinker.json`. Advanced users are welcome to update data directly by editing that data file.


I believe this is still addressbook.json

riccoljy · 2024-10-29T09:44:16Z

docs/UserGuide.md

@@ -15,17 +16,21 @@ WedLinker is a **desktop app for managing contacts, optimized for use via a  Lin

 ## Quick start

-1. Ensure you have Java `17` or above installed in your Computer.
+1. Ensure you have `Java 17` or above installed in your Computer. If you do not have Java 17 installed, or you are unsure, refer to the guide below.


I remember Dr. Wee asking "How can users know whether they have Java 17?" -- Maybe can add instruction to "Open terminal and run java -version, or something similar?

riccoljy · 2024-10-29T09:45:26Z

docs/UserGuide.md


-1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.<br>
+4. Open WedLinker by double clicking the program file, `WedLinker.jar`.<br>


Is the recommended way even for everyday users to double-click? I'm not too sure about it, correct me if I'm wrong!

Update User Guide

7d638f2

Update Help Message to WedLinker's user guide. Update AB3 and AddressBook to reflect WedLinker. Update Jar File link. Update Ui example image. Update Quick Start guide to fit the target audience. Fix hyperlinks to accurately reflect its target.

HanB1n requested review from dasha3412 and riccoljy October 29, 2024 06:54

HanB1n self-assigned this Oct 29, 2024

HanB1n added the type.Task Something that needs to be done, but not a story, bug, or an epic label Oct 29, 2024

HanB1n linked an issue Oct 29, 2024 that may be closed by this pull request

UG Guide Improvements #131

Closed

dasha3412 reviewed Oct 29, 2024

View reviewed changes

tingxuanp reviewed Oct 29, 2024

View reviewed changes

riccoljy approved these changes Oct 29, 2024

View reviewed changes

dasha3412 mentioned this pull request Oct 30, 2024

Add to UG command summary #191

Merged

dasha3412 marked this pull request as ready for review October 31, 2024 09:10

dasha3412 merged commit dc29aa4 into AY2425S1-CS2103T-F15-4:master Oct 31, 2024
4 checks passed

HanB1n added this to the v1.5 milestone Oct 31, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update User Guide #170

Update User Guide #170

HanB1n commented Oct 29, 2024

codecov bot commented Oct 29, 2024

dasha3412 left a comment

dasha3412 Oct 29, 2024

dasha3412 Oct 29, 2024

dasha3412 Oct 29, 2024

riccoljy Oct 29, 2024

dasha3412 Oct 29, 2024

dasha3412 Oct 29, 2024

dasha3412 Oct 29, 2024

riccoljy Oct 29, 2024

dasha3412 left a comment

dasha3412 Oct 29, 2024

dasha3412 Oct 29, 2024

dasha3412 Oct 29, 2024

dasha3412 Oct 29, 2024

tingxuanp Oct 29, 2024

tingxuanp Oct 29, 2024

tingxuanp Oct 29, 2024

tingxuanp Oct 29, 2024

tingxuanp Oct 29, 2024

tingxuanp Oct 29, 2024

riccoljy left a comment

riccoljy Oct 29, 2024

riccoljy Oct 29, 2024

riccoljy Oct 29, 2024


		1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar addressbook.jar` command to run the application.<br>
		4. Open WedLinker by double clicking the program file, `WedLinker.jar`.<br>

		@@ -287,7 +294,7 @@ Format: `delete-wedding w/WEDDINGNAME [f/]`
		* The no contacts should be assigned to the `Wedding` before it is deleted.

Update User Guide #170

Update User Guide #170

Conversation

HanB1n commented Oct 29, 2024

codecov bot commented Oct 29, 2024

Codecov Report

dasha3412 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dasha3412 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

riccoljy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment