Skip to content

Commit

Permalink
Merge pull request #190 from ReganChoy/branch-UG_v1.4b
Browse files Browse the repository at this point in the history 
Update UG
  • Loading branch information
@solomonng2001
solomonng2001 authored Apr 13, 2024
2 parents a6f17de + a97927e commit 98823f4
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This guide walks you through all the features of ClientCare and can be used as a

Ready to use ClientCare? You can check out our [Features](#features) section. For ease of reference, the
[Features](#features) section is divided into subsections corresponding to each main feature:
[Clients](#client-related-commands), [Schedules](#schedule-related-commands) and [Policies](#schedule-related-commands). Feel free to jump around as you explore ClientCare's amazing features!
[Clients](#client-related-commands), [Schedules](#schedule-related-commands) and [Policies](#policy-related-commands). Feel free to jump around as you explore ClientCare's amazing features!

Need a quick refresher? You can head to the [Command Summary](#command-summary) for a quick recap!

Expand Down Expand Up @@ -204,7 +204,7 @@ Let's learn the language that ClientCare speaks in.

<br/>

### ClientCare Commands
### ClientCare commands
A ClientCare command has the following parts:

![Command Structure](images/ug/commandStructure.png =450x)
Expand Down Expand Up @@ -240,7 +240,7 @@ Alternatively, [Command Summary](#command-summary) has all of them under one pag

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

### Handling ClientCare Error Messages
### Handling ClientCare error messages
While using ClientCare, you may encounter errors when you mistype or missed something out in your commands.
Not to worry, you will learn how to handle these error messages with ease in this section.

Expand Down Expand Up @@ -299,7 +299,7 @@ ClientCare will be with you to correct each error!
--------------------------------------------------------------------------------------------------------------------
<div style="page-break-after: always;"></div>

## Quick Tutorial
## Quick tutorial
Excited to play around with ClientCare?
Let’s run you through some simple commands to get you warmed up before you dive right into ClientCare’s full feature list!

Expand Down Expand Up @@ -402,7 +402,7 @@ ClientCare offers the following commands to help you manage your clients:
* [Listing all clients: `list`](#listing-all-clients-list)
* [Viewing a client: `view`](#viewing-a-client-view)
* [Finding a client: `find`](#finding-client-by-name-find)
* [Adding notes to a client: `remark`](#adding-notes-to-clients-remark)
* [Adding notes to a client: `remark`](#adding-notes-to-a-client-remark)
* [Clearing all clients: `clear`](#clearing-all-entries-clear)
* [Sorting your clients: `sort`](#sorting-the-client-list-sort)
<br/>
Expand Down Expand Up @@ -634,7 +634,7 @@ ClientCare shows a success message in the Feedback Display too.

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

### Adding notes to clients: `remark`
### Adding notes to a client: `remark`
Need to remember certain information about a client such as his preference or health conditions?
You can add notes to each client with `remark`. If a current remark exists, it will be replaced with the new remark.

Expand Down Expand Up @@ -759,8 +759,8 @@ of your clients' birthday!
ClientCare offers the following commands to help you manage your schedule:
* [Updating last met: `met`](#updating-last-met-met)
* [Setting last met overdue period: `set`](#setting-last-met-overdue-period-set)
* [Scheduling an appointment: `schedule`](#scheduling-appointments-schedule)
* [Marking an appointment: `mark`](#marking-appointments-mark)
* [Scheduling appointments: `schedule`](#scheduling-appointments-schedule)
* [Marking appointments: `mark`](#marking-appointments-mark)

<br/>
<br/>
Expand Down Expand Up @@ -988,7 +988,7 @@ numbering schemes.
<box type="info">

**Note:** Although most policy IDs will be up to 25 digits,
ClientCare allows you to put up to about 40 digits long before values are truncated in fullscreen. The limit might vary depending on your screen size, so do check if the remark is fully displayed.
ClientCare allows you to put up to about 40 digits long before values are truncated in fullscreen. The limit might vary depending on your screen size, so do check if the policy ID is fully displayed.
</box>

**Before Command:**
Expand Down Expand Up @@ -1287,7 +1287,7 @@ If a text is truncated in the display, this means that the full text has been sh
| [**List**](#listing-all-clients-list) | `list` |
| [**View**](#viewing-a-client-view) | `view INDEX`<br/> e.g, `view 1` |
| [**Find**](#finding-client-by-name-find) | `find KEYWORD [MORE_KEYWORDS]`<br/> e.g. `find James Jake` |
| [**Remark**](#adding-notes-to-clients-remark) | `remark INDEX [r/REMARK]`<br/> e.g. `remark 3 r/Has 2 school-age children and 1 elderly dependent` |
| [**Remark**](#adding-notes-to-a-client-remark) | `remark INDEX [r/REMARK]`<br/> e.g. `remark 3 r/Has 2 school-age children and 1 elderly dependent` |
| [**Clear**](#clearing-all-entries-clear) | `clear` |
| [**Sort**](#sorting-the-client-list-sort) | `sort CRITERIA o/ORDER` <br/> e.g. `sort priority o/desc` |
| [**LastMet**](#updating-last-met-met) | `met INDEX d/DATE`<br/> e.g. `met 2 d/2023-05-07` |
Expand Down

0 comments on commit 98823f4

Please sign in to comment.