Skip to content

Commit

Permalink
Merge pull request #222 from officialchengyud/branch-user-guide
Browse files Browse the repository at this point in the history
Update UG and Jekyll site
  • Loading branch information
alfaloo authored Apr 12, 2024
2 parents 58afefa + 4bbf8b8 commit d6fa661
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 4 deletions.
27 changes: 24 additions & 3 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: page
title: User Guide
title: MediCLI User Guide
---

## Welcome to MediCLI!
Expand Down Expand Up @@ -68,7 +68,9 @@ the command-line interface (CLI).]

1. Refer to the [Features](#features) below for details of each command.

--------------------------------------------------------------------------------------------------------------------
<div markdown="span" class="alert alert-success">:bulb: **TIP**: Tip call-outs give you helpful pointers in MediCLI!</div>
<div markdown="span" class="alert alert-info">:information_source: **INFO**: Info call-outs give you information about MediCLI that you can take note of!</div>
<div markdown="span" class="alert alert-danger">:exclamation: **DANGER**: Danger call-outs like this contain dangerous actions you should remember when using MediCLI to avoid errors!</div>

## Features

Expand Down Expand Up @@ -217,7 +219,26 @@ Examples:

![add_appointment_result](images/editAppointment.png)

### Querying persons by name : `patient`
### Finding both doctor and patient by name: `find`

Finds `Patient`(s) or `Doctor`(s) whose details contain any of the given keywords.

Format for querying patients or doctors: `find KEYWORD [MORE_KEYWORDS]`

Command Constraints:

* The search is case-insensitive. e.g `hans` will match `Hans`
* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
* Only the name field is searched.
* Both full words and substrings will be matched e.g. `Han` will match `Hans`
* Patients and Doctors matching at least one keyword will be returned (i.e. logical 'OR' search).
e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`

Examples:
* `find John` returns `john` and `John Doe`
* `find alex david` returns `Alex Yeoh`, `David Li`<br>

### Querying persons by name: `patient`

Finds `Patient`(s) whose details contain any of the given keywords.

Expand Down
2 changes: 1 addition & 1 deletion docs/_layouts/page.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
---
<article class="post">

<img id="logo" src="images/medicli_logo.png" alt="MediCLI Logo" width="100">
<header class="post-header">
<h1 class="post-title">{{ page.title | escape }}</h1>
</header>
Expand Down
14 changes: 14 additions & 0 deletions docs/assets/css/style.scss
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,17 @@
height: 21px;
width: 21px
}

h2, h3 {
font-weight: bold;
color: #257ec7;
}

.post-title {
color: #257ec7;
font-weight: bold;
}

#logo {
margin-bottom: 15px;
}
Binary file added docs/images/medicli_logo.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 d6fa661

Please sign in to comment.