diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 1d327653a97..fa1c4e79346 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -17,6 +17,8 @@ title: User Guide # 2. Quick Start Guide ⚡️ + +## 2.1. Getting Started Here's how to get started with CareCentral quickly: 1. Ensure you have [Java 11](https://www.oracle.com/java/technologies/downloads/#java11) installed in your Computer. @@ -35,6 +37,46 @@ Here's how to get started with CareCentral quickly: * `delete-patient 1` * `exit` +## 2.2 Navigating the User Guide +This section will explain the different elements of the user guide and how to navigate it. + +### 2.2.1. Navigation +You can navigate the user guide by clicking on the links in the table of contents on the top of the User Guide. +![UG_tableOfContents](images/UG_tableOfContents.png) + +### 2.2.2. Command Format +`This is the format of a Command in the User Guide` + +### 2.2.3. Links +[Links]() will be displayed in this format. These are clickable links that will bring you to the respective section. + +### 2.2.4. Boxes +#### 2.2.4.1. Warning +
+

❗Warning: This is a warning, information in this box is extremely important. Ignoring the warnings may result in irreversible error of the application.

+
+ +#### 2.2.4.2. Things to Note + +
+ :warning: Things To Note
+ Things that you should take note before using the respective command will be displayed in this format. +
+ +#### 2.2.4.3. Additional Info +
+ :scroll: Additional Info
+ Things that are good to know but not compulsory, but might come in handy in using the feature will be displayed in this format. +
+ +#### 2.2.7. Notes from developers + +
+ 📝 Notes from developers
+ These are notes from the developers to explain the rationale of implementation of certain features. +
+ +
🌟 Congratulations on starting with CareCentral! The next sections will guide you through more features to fully utilize the app.
diff --git a/docs/images/UG_tableOfContents.png b/docs/images/UG_tableOfContents.png new file mode 100644 index 00000000000..f41edc7928d Binary files /dev/null and b/docs/images/UG_tableOfContents.png differ diff --git a/docs/img.png b/docs/img.png new file mode 100644 index 00000000000..f41edc7928d Binary files /dev/null and b/docs/img.png differ