Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example of a person and appointment #325

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,13 @@ A **person** is a patient with several fields. The fields and their correspondin
| **Tag(s)** | `t/` | Yes | Yes |

You can identify these patients uniquely by their **patient ID (PID)** for easy reference.
The PID can be seen at the top of their information card.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we make it more specific to say "top right" of their information card?


<br><sbr>

<img src="images/personexample.png" width="500">

<br><sbr>

<br>

Expand Down Expand Up @@ -532,6 +539,18 @@ An **appointment** is defined by several fields. The fields and their correspond
| **Sickness** | `s/` | Yes | No |
| **Medicine** | `m/` | Yes | No |

You can identify these appointments uniquely by their **Appointment ID (AID)** for easy reference.
The AID can be seen at the top of their information card.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we specify top right as well?


<br><sbr>

<img src="images/appointmentexample.png" width="500">

<br><sbr>

The number indicated beside the appointment name is the PID of the person who has the appointment.


You can manage the appointments through different commands, which can be seen in the table below:

<br>
Expand Down
Binary file added docs/images/appointmentexample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/personexample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.