Skip to content

Commit

Permalink
Merge pull request #212 from Rishit02/ug
Browse files Browse the repository at this point in the history
Update user guide
  • Loading branch information
pjanthony2001 authored Apr 15, 2024
2 parents 36900c9 + 7116379 commit be2de23
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ _This page is for ConnectCare users. If you're a developer, see also the
+ [Clearing all entries](#clearing-all-entries-clear)
+ [Appointment Management](#appointment-management)
+ [Adding an Appointment](#adding-an-appointment-schedule-add)
+ [Deleting an Appointment](#deleting-appointments-schedule-delete)
+ [Deleting an Appointment](#deleting-appointment-schedule-delete)
+ [Program Controls](#program-controls)
+ [Undoing a Command](#undoing-a-command-undo)
+ [Redoing a Command](#redoing-a-command-redo)
Expand Down Expand Up @@ -254,8 +254,8 @@ _This command adds a new client to your client list._
| Parameter | Description | Remarks |
|----------------|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| n/NAME | Name of client that you want to add | Name must be unique, alphanumeric and case-sensitive. It is also compulsory |
| p/PHONE_NUMBER | Phone Number of client that you want to add | Phone number should only contain numbers and is compulsory |
| e/EMAIL | Email of client that you want to add | Emails should be of the format local-part@domain and adhere to the following constraints:<br/>1. The local-part should only contain alphanumeric characters and these special characters, excluding the parentheses, (+_.-). The local-part may not start or end with any special characters.<br/>2. This is followed by a '@' and then a domain name. The domain name is made up of one or more domain labels separated by periods.<br/>The domain name must:<br/> - end with a domain label at least 2 characters long<br/> - have each domain label start and end with alphanumeric characters<br/> - have each domain label consist of alphanumeric characters, separated only by hyphens, if any.<br/> - Valid emails include: [email protected], felix@asd, [email protected] |
| p/PHONE_NUMBER | Phone number of client that you want to add | Phone number should only contain numbers and is compulsory |
| e/EMAIL | Email address of client that you want to add | Emails should be of the format local-part@domain and adhere to the following constraints:<br/>1. The local-part should only contain alphanumeric characters and these special characters, excluding the parentheses, (+_.-). The local-part may not start or end with any special characters.<br/>2. This is followed by a '@' and then a domain name. The domain name is made up of one or more domain labels separated by periods.<br/>The domain name must:<br/> - end with a domain label at least 2 characters long<br/> - have each domain label start and end with alphanumeric characters<br/> - have each domain label consist of alphanumeric characters, separated only by hyphens, if any.<br/> - Valid emails include: [email protected], felix@asd, [email protected] |
| a/ADDRESS | Address of client that you want to add | - |
| k/NEXT_OF_KIN | Next of Kin details of client that you want to add | Name must be alphanumeric |
| d/DESCRIPTION | Description of client that you want to add | Description should not be blank |
Expand Down Expand Up @@ -428,11 +428,11 @@ _This command helps update existing client's information in the client list in t
&nbsp;

**Example:**
- `update u/Jane Doe n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-011` updates the information of Jane Doe's information to be
name: John Doe
phone no: 98765432
email: [[email protected]](mailto:[email protected])
address: John street, block 123, #01-011
- `update u/Jane Doe n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-011` This command updates Jane Doe's information to be as follows: </br>
- name: John Doe
- phone no: 98765432
- email: [[email protected]](mailto:[email protected])
- address: John street, block 123, #01-011

**Walkthrough:**

Expand Down Expand Up @@ -506,7 +506,7 @@ Now that we are done with the **list** command let's move on to the **find** com

### Finding clients: `find`

_This command allows you to find clients in your client list by specifying client parameters that you are interested in. _
_This command allows you to find clients in your client list by specifying client parameters that you are interested in._

**Format:** `find [n/NAME]… [a/KEYWORD]… [e/KEYWORD]… [t/KEYWORD]… [k/KEYWORD]… [d/KEYWORD]… [p/KEYWORD]…`

Expand Down
Binary file modified docs/images/quickstart/jar-file.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/quickstart/latest-release.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit be2de23

Please sign in to comment.