Skip to content

Commit

Permalink
Update UG
Browse files Browse the repository at this point in the history
  • Loading branch information
Rishit02 committed Apr 15, 2024
1 parent 9cbc645 commit b3cc77e
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
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 @@ -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 @@ -619,6 +631,8 @@ If you would like to resume entering commands, press the ENTER key in the descri
&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 @@ -632,13 +646,18 @@ Accidentally cleared your client list? Worry not, the `undo` feature might be ab
</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 @@ -682,6 +701,8 @@ 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 Appointment : `schedule delete`
Expand Down Expand Up @@ -724,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 @@ -737,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 @@ -772,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 @@ -809,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 @@ -837,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 @@ -856,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 @@ -872,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

0 comments on commit b3cc77e

Please sign in to comment.