Skip to content

Commit

Permalink
Update DG & UG
Browse files Browse the repository at this point in the history
  • Loading branch information
Darren159 committed Nov 13, 2023
1 parent 0a55e18 commit ebc9b5c
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 17 deletions.
4 changes: 0 additions & 4 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,6 @@ Each of the four main components:

For example, the `Logic` component's API is defined in `Logic.java`, and its functionality is implemented in `LogicManager.java`.

#### Detailed Component Descriptions:

[More details about each component are provided in the subsequent sections.](#detailed-component-descriptions)

---

### Detailed Component Descriptions
Expand Down
29 changes: 16 additions & 13 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,10 @@ We're here to make your experience as user-friendly as possible. Let's get start

- Choose a folder where you'd like to manage your patient data.
<box type="tip" seamless>
**Tip**: Create a new folder named `MedBook` for easy organization.
</box>

**Tip**: Create a new folder named `MedBook` for easy organization.

</box>
- Move `medbook.jar` into the folder as shown below.
- **Windows Users**:![Ui](images/WinUserDir.png)
- **Mac Users**:![Ui](images/MacUserDir.png)
Expand Down Expand Up @@ -475,19 +477,19 @@ Format: `search KEYWORD [MOREKEYWORDS]...`

- Patients with detail that are not exactly the same as the `KEYWORD` searched will not appear. e.g. **Han** will not return **Hans**. <br>

<box type="info" seamless>
<box type="info" seamless>

**Note**: The details of the patient's medical records will not be searched.
**Note**: The details of the patient's medical records will not be searched.

</box>
</box>

<box type="tip" seamless>
<box type="tip" seamless>

**Tip**: Maximize the efficiency of the `search` command to quickly locate patients. It's perfect for filtering patient lists - for instance, identifying patients with specific allergies.
**Tip**: Maximize the efficiency of the `search` command to quickly locate patients. It's perfect for filtering patient lists - for instance, identifying patients with specific allergies.

</box>
</box>

Examples:
Examples:

- `search Alex` Will display patients with **Alex** in their details. <br>

Expand Down Expand Up @@ -536,11 +538,11 @@ Format: `list`

- **All** patients will be shown in the **Patient List**.

<box type="tip" seamless>
<box type="tip" seamless>

**Tip**: The `list` command allows you to easily view all the patients in the **Patient List**. For instance, after you've used the `search` command to find specific patients, you can use the `list` command to gather all the patients conveniently!
**Tip**: The `list` command allows you to easily view all the patients in the **Patient List**. For instance, after you've used the `search` command to find specific patients, you can use the `list` command to gather all the patients conveniently!

</box>
</box>

<u>[Back to Table Of Contents](#table-of-contents)</u>

Expand Down Expand Up @@ -630,7 +632,8 @@ Attach local files to a patient's medical record by clicking on the **Attach** b

<box type="warning" seamless>

**Caution**:
**Caution**:

- Refrain from deleting/relocating the local file. If necessary, re-attach the new file after relocation/deletion.
- Ensure that you have selected a default launcher for the selected file type.

Expand Down

0 comments on commit ebc9b5c

Please sign in to comment.