From e527c6b4c7444de37b4e9473fd8592d96179e893 Mon Sep 17 00:00:00 2001 From: Alexander Setyawan Date: Mon, 15 Apr 2024 20:52:44 +0800 Subject: [PATCH] UG enhancements again --- docs/UserGuide.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 07dd03cff44..5b67e87d146 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -71,7 +71,20 @@ The table of contents just before this section breaks down the guide into its co Navigating a complex document can be time-consuming, and we understand. That's why we've placed hyperlinks throughout this article (like [this one](#command-summary), to the command summary), so that any information you need is truly at your fingertips. -Sometimes, certain instructions might sound very new or contain too many technical terms, which is why we also positioned a few "**TIP**" snippets below them, so that you'll never have to fret about the intricacies of ImmuniMate. +Before engaging with ImmuniMate, there are some things that are so important that they have to catch your eye. +That's why we made these nice blue note boxes to capture your attention, to plug gaps in your understanding before proceeding with ImmuniMate. +
+ +**:information_source: Notes**
+This is what a note box looks like. +
+ +Sometimes, certain instructions might sound very new or contain too many technical terms, which is why we also positioned a few tip snippets below them, so that you'll never have to fret about the intricacies of ImmuniMate. +
+ +**:bulb: Tip:**
+This is what a tip snippet looks like +

@@ -253,7 +266,7 @@ Find retyping commands a hassle? Use your 'Up' and 'Down' arrow keys to access y
-**:information_source: Notes about the command format:**
+**:information_source: Notes**
* Words in `UPPERCASE` are the parameters to be supplied by the user.
e.g. in `update /CONTENT`, `CONTENT` is a parameter which can be used as `update S0123456A hp/87654321`. @@ -297,11 +310,7 @@ Format: `list` **Creates a patient profile in ImmuniMate.** -
- -**:information_source: Notes**
-A patient profile refers to a record of a patient with a set of relevant information. For the complete field of information, refer to the [Field summary](#field-summary) at the end of this User Guide. -
+pro Format: `create ic/ n/ hp/ a/
dob/ s/ st/ [e/Email] [c/Country_of_Nationality] [doa/Date_of_Admission] [bt/Blood type] [al/Allergies] [con/Condition] [sym/Symptom] [d/diagnosis]`