Skip to content

Commit

Permalink
Merge pull request #202 from Rishit02/ug-schedule
Browse files Browse the repository at this point in the history
Update schedule command docs in UG
  • Loading branch information
pjanthony2001 authored Apr 15, 2024
2 parents 90a4560 + 835d2ba commit 564dd81
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 2 deletions.
49 changes: 47 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,10 +271,10 @@ As the commands given were invalid, there would be no changes to the client list

<div class="image-container" align="middle" style="display: flex;">
<pic src="images/user-guide/add_command/add_command_after_without_all_parameters.png" alt="add">
<markdown> Figure 1.2: After the invalid `add` command without all parameters is executed </markdown>
<markdown> Figure 1.3: After the invalid `add` command without all parameters is executed </markdown>
</pic>
<pic src="images/user-guide/add_command/add_command_after_with_incorrect_parameters.png" alt="add">
<markdown> Figure 1.3: After the invalid `add` command with incorrect parameters is executed </markdown>
<markdown> Figure 1.4: After the invalid `add` command with incorrect parameters is executed </markdown>
</pic>
</div>

Expand Down Expand Up @@ -574,6 +574,28 @@ _This command allows you to add an appointment with the specified parameters._

Once the command is entered, the event should be added to the events panel on the right of the application.


**Examples:**
- `schedule add h/Meeting with Client t/Wednesday, January, 24, 2024 - 09:00 AM d/Discuss project details n/John Doe`
- `schedule add h/Discharge plan meeting t/Wednesday, January, 24, 2024 - 09:00 AM d/Discuss discharge n/Jack Doe`


**Walkthrough:**

The screenshots show what you should expect on your screen while executing this command: `schedule add h/Meeting with Client t/Wednesday, January, 24, 2024 - 09:00 AM d/Discuss project details n/John Doe`.
Once the command is entered, the event should be deleted on the events panel on the right of the application.

<div class="image-container" align="middle" style="display:flex">
<pic src="images/user-guide/schedule_command/schedule-add.png" alt="schedule-add">
<markdown> Figure 1.1: Before the `schedule add` command is executed </markdown>
</pic>
<pic src="images/user-guide/schedule_command/schedule-add-after.png" alt="add">
<markdown> Figure 1.2: After the `schedule add` command is executed </markdown>
</pic>
</div>

&nbsp;

### Deleting Appointments : `schedule delete`

_This command allows you to remove an appointment with the specified parameters._
Expand All @@ -591,6 +613,29 @@ _This command allows you to remove an appointment with the specified parameters.

Once the command is entered, the event should be removed from the events panel on the right of the application.

**Examples:**
- `schedule delete h/Meeting with Client`
- `schedule delete h/Discharge plan meeting`
<box type="info">
It is only possible to delete an event if the heading exists in the events panel on the right of the application.
</box>

**Walkthrough:**

The screenshots show what you should expect on your screen while executing this command: `schedule delete h/Client Checkin`.
Once the command is entered, the event should be added to the events panel on the right of the application.

<div class="image-container" align="middle" style="display:flex">
<pic src="images/user-guide/schedule_command/schedule-add.png" alt="schedule-add">
<markdown> Figure 1.1: Before the `schedule delete` command is executed </markdown>
</pic>
<pic src="images/user-guide/schedule_command/schedule-add-after.png" alt="add">
<markdown> Figure 1.2: After the `schedule delete` command is executed </markdown>
</pic>
</div>

&nbsp;

## Program Controls
ConnectCare provides the following commands for navigating the application:
* Undoing a command: `undo`
Expand Down
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.
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 564dd81

Please sign in to comment.