Skip to content

Commit

Permalink
Merge pull request #228 from tanboonkhong/branch-user-guide
Browse files Browse the repository at this point in the history
[CS2101] User Guide - Add Navigation
  • Loading branch information
tanboonkhong authored Nov 15, 2023
2 parents 8a8efa9 + 12d0247 commit 60d6a56
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ title: User Guide
</div>

# 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.
Expand All @@ -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
<div style="background-color: #f9f9f9; border-left: 5px solid #d9534f; padding: 5px; margin-bottom: 10px; border-radius: 5px; box-shadow: 0 2px 4px rgba(0,0,0,0.1);">
<p style="color: #d9534f;"><strong>❗Warning:</strong> This is a warning, information in this box is <strong>extremely important</strong>. Ignoring the warnings may result in <strong>irreversible error</strong> of the application.</p>
</div>

#### 2.2.4.2. Things to Note

<div style="background-color: #ffffcc; padding: 10px; border-left: 3px solid #ffeb3b; margin-bottom: 10px;">
<strong>:warning: Things To Note <br></strong>
Things that you should take note before using the respective command will be displayed in this format.
</div>

#### 2.2.4.3. Additional Info
<div style="background-color: #cce7ff; padding: 10px; margin-bottom: 10px; border-left: 5px solid #3385ff;">
<strong>:scroll: Additional Info<br></strong>
Things that are good to know but not compulsory, but might come in handy in using the feature will be displayed in this format.
</div>

#### 2.2.7. Notes from developers

<div style="background-color: #fff3e0; padding: 5px; border-left: 5px solid #ffa726;">
📝<strong> Notes from developers<br></strong>
These are notes from the developers to explain the rationale of implementation of certain features.
</div>


<div style="background-color: #E3F2FD; padding: 10px; margin-top: 10px; border-left: 5px solid #64B5F6;">
🌟<strong> Congratulations on starting with CareCentral!</strong> The next sections will guide you through more features to fully utilize the app.
</div>
Expand Down
Binary file added docs/images/UG_tableOfContents.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/img.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 60d6a56

Please sign in to comment.