Skip to content

Commit

Permalink
Merge pull request #205 from Rishit02/update-docs
Browse files Browse the repository at this point in the history
Update UG
  • Loading branch information
pjanthony2001 authored Apr 15, 2024
2 parents 302d19f + b3cc77e commit c25b5ce
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 7 deletions.
54 changes: 47 additions & 7 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ _This page is for ConnectCare users. If you're a developer, see also the
+ [Updating a Client](#updating-a-client-update)
+ [Listing all Clients](#listing-all-clients-list)
+ [Finding Clients](#finding-clients-find)
+ [Displaying a Client's Information](#displaying-a-clients-information-display)
+ [Displaying a client's information](#displaying-a-client-s-information-display)
+ [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)
+ [Adding an Appointment](#adding-an-appointment-schedule-add)
+ [Deleting an Appointment](#deleting-appointments-schedule-delete)
+ [Program Controls](#program-controls)
+ [Undoing a Command](#undoing-a-command-undo)
+ [Redoing a Command](#redoing-a-command-redo)
Expand Down Expand Up @@ -322,10 +322,13 @@ As the commands given were invalid, there would be no changes to the client list
</pic>
</div>


&nbsp;

Click [here](#table-of-contents) to return to the table of contents!

Now that we are done with the **add** command let's move on to the **delete** command!

---

### Deleting a client: `delete`
Expand Down Expand Up @@ -385,6 +388,8 @@ As the commands given were invalid, there would be no changes to the client list

Click [here](#table-of-contents) to return to the table of contents!

Now that we are done with the **delete** command let's move on to the **update** command!

---

### Updating a client: `update`
Expand Down Expand Up @@ -468,6 +473,8 @@ As the commands given were invalid, there would be no changes to the client list

Click [here](#table-of-contents) to return to the table of contents!

Now that we are done with the **update** command let's move on to the **list** command!

---

### Listing all clients: `list`
Expand All @@ -493,6 +500,8 @@ only `Peter Crow` was shown in the list. Thereafter, the `list` command was used

Click [here](#table-of-contents) to return to the table of contents!

Now that we are done with the **list** command let's move on to the **find** command!

---

### Finding clients: `find`
Expand Down Expand Up @@ -537,9 +546,9 @@ _This command allows you to find clients in your client list by specifying clien

Let's say your client list contains the following clients:

<div class="image-container" style="display: block;max-width: 40%;margin: auto;">
<div class="image-container" style="display: block;max-width: 60%;margin: auto;">
<pic src="images/user-guide/ExampleClientList.png" alt="clientlist">
<markdown> Figure 1.1: _An example client list in ConnectCare (appointments list is cropped)_ </markdown>
<markdown> Figure 1.1: _An example client list in ConnectCare (as indicated by the red box)_ </markdown>
</pic>
</div>

Expand Down Expand Up @@ -567,8 +576,11 @@ After searching for clients, you can use the `list` command to view your full li
</box>

&nbsp;

Click [here](#table-of-contents) to return to the table of contents!

Now that we are done with the **find** command let's move on to the **display** command!

---

### Displaying a client's information: `display`
Expand Down Expand Up @@ -616,6 +628,11 @@ Any changes you make to description by reverting to the list view using this met
If you would like to resume entering commands, press the ENTER key in the description box (which will save your changes) to return to the list view.
</box>

&nbsp;
Click [here](#table-of-contents) to return to the table of contents!

Now that we are done with the **display** command let's move on to the **clear** command!

### Clearing all entries : `clear`

_This command allows you to purge your client list, removing **ALL** clients in your client list._
Expand All @@ -628,11 +645,19 @@ Format: `clear`
Accidentally cleared your client list? Worry not, the `undo` feature might be able to help you get it back!
</box>

&nbsp;

Click [here](#table-of-contents) to return to the table of contents!

Now that we are done with the **Client management** features let's move on to the **Appointment management** features!

## Appointment Management
ConnectCare provides the following commands to help you manage your appointments:
* Adding an appointment: `schedule add`
* Deleting an appointment: `schedule delete`

Let's talk about the different **Appointment management** features, starting with **schedule add** command

### Adding an appointment: `schedule add`

_This command allows you to add an appointment with the specified parameters._
Expand Down Expand Up @@ -676,9 +701,11 @@ Once the command is entered, the event should be deleted on the events panel on

Click [here](#table-of-contents) to return to the table of contents!

Now that we are done with the **schedule add** command let's move on to the **schedule delete** command!

---

### Deleting Appointments : `schedule delete`
### Deleting Appointment : `schedule delete`

_This command allows you to remove an appointment with the specified parameters._

Expand Down Expand Up @@ -718,9 +745,10 @@ Once the command is entered, the event should be added to the events panel on th

&nbsp;


Click [here](#table-of-contents) to return to the table of contents!

Now that we are done with the **Appointment management** features let's move on to the **Program controls**!

---

## Program Controls
Expand All @@ -731,6 +759,8 @@ ConnectCare provides the following commands for navigating the application:
* `up` arrow
* `down` arrow

Let's talk about the different **Program controls**, starting with the **undo** command

### Undoing a command : `undo`

_This command allows you to undo your last command, restoring the ConnectCare application to its previous state._
Expand Down Expand Up @@ -766,6 +796,8 @@ For a comprehensive deep-dive into the undo command, please refer to the [Implem

Click [here](#table-of-contents) to return to the table of contents!

Now that we are done with the **undo** command let's move on to the **redo** command!

---

### Redoing a command : `redo`
Expand Down Expand Up @@ -803,6 +835,8 @@ For a comprehensive deep-dive into the redo command, please refer to the [Implem

Click [here](#table-of-contents) to return to the table of contents!

Now that we are done with the **redo** command let's move on to see some command **shortcuts**!

---

### Shortcuts
Expand Down Expand Up @@ -831,6 +865,8 @@ _These are a list of keyboard actions to better navigate our application_

Click [here](#table-of-contents) to return to the table of contents!

Now that we are done with the **shortcuts** let's move on to explore the **Miscellaneous commands**!

---

## Miscellaneous Commands
Expand All @@ -850,6 +886,8 @@ Format: `help`

Click [here](#table-of-contents) to return to the table of contents!

Now that we are done with the **help** command let's move on to the **exit** command!

---

### Exiting the program : `exit`
Expand All @@ -866,6 +904,8 @@ You can simply close the window using the X button too!

Click [here](#table-of-contents) to return to the table of contents!

Let's now understand how data is saved and managed in the application.

---

## Saving the data
Expand Down
Binary file modified docs/images/user-guide/ExampleClientList.png
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 c25b5ce

Please sign in to comment.