Skip to content

Commit

Permalink
Merge pull request #221 from Jolonauh/user-guide
Browse files Browse the repository at this point in the history 
Update signposting in UG
  • Loading branch information
@Rishit02
Rishit02 authored Apr 15, 2024
2 parents 53e7962 + dba10b3 commit 8aaf7b0
Showing 1 changed file with 22 additions and 32 deletions.
54 changes: 22 additions & 32 deletions docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,13 @@ Important warnings that you should keep in mind while using this User Guide.
**Warning:** If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.
</box>

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

---

Now that you have a brief idea of what ConnectCare is and whether it is for you, let's move on to using ConnectCare! Read further in our [Quick Start Section](#quick-start) to find out about how to start using ConnectCare!

---

# Quick start
<IMPROVE BY ADDING SCREENSHOTS AND LINKS>
Expand Down Expand Up @@ -177,8 +183,14 @@ It will help you [install](#installation-instructions) and [start](#startup-inst
6. Double-click on the `connectcare.jar` file to start the application.
- If you are facing issues, you can consult [this guide](https://www.wikihow.com/Run-a-.Jar-Java-File).
- **macOS** users might experience a pop-up that says "connectcar.jar cannot be opened because it is from an unidentified developer." To solve this issue, please consult [this Apple guide](https://support.apple.com/en-sg/guide/mac-help/mh40616/mac)
___

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

---

You're now onboarded to our app! Read further in our [CLI Guide Section](#cli-guide) to find out about all the various features and commands that the ConnectCare application offers!

---
# CLI guide
Our application uses a [CLI](#cli) and primarily, running commands is how users interact with the application.

Expand Down Expand Up @@ -224,6 +236,8 @@ To enter a command:
- Extraneous parameters for commands that do not take in parameters (such as `help`, `list`, `exit` and `clear`) will be ignored.
e.g. if the command specifies `help 123`, it will be interpreted as `help`.

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

---

You're all set to use the CLI to its full potential! Read further in our [Features Section](#features) to find out about all the various features and commands that the ConnectCare application offers!
Expand Down Expand Up @@ -327,8 +341,6 @@ 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 **add** command let's move on to the **delete** command!

---

### Deleting a client: `delete`
Expand Down Expand Up @@ -388,8 +400,6 @@ 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 @@ -473,8 +483,6 @@ 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 @@ -500,8 +508,6 @@ 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 @@ -579,8 +585,6 @@ After searching for clients, you can use the `list` command to view your full li

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 @@ -631,8 +635,6 @@ 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 @@ -649,15 +651,17 @@ Accidentally cleared your client list? Worry not, the `undo` feature might be ab

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!
---

You are now an expert in managing your clients! 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 @@ -701,8 +705,6 @@ 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 @@ -754,8 +756,6 @@ Once the command is entered, the event should be added to the events panel on th

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 @@ -766,8 +766,6 @@ 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 @@ -803,8 +801,6 @@ 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 @@ -842,8 +838,6 @@ 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 @@ -872,7 +866,7 @@ _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**!
Now that we are better able to navigate our application, let's move on to explore the **Miscellaneous commands**!

---

Expand All @@ -893,8 +887,6 @@ 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 @@ -911,8 +903,6 @@ 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 8aaf7b0

Please sign in to comment.