Skip to content

Commit

Permalink
Merge pull request #287 from Anant1902/branch-updateUG
Browse files Browse the repository at this point in the history
Change some tips to infos and rearranged boxes
  • Loading branch information
tituschewxj authored Apr 12, 2024
2 parents 88cf1a2 + d9de216 commit c86de0f
Showing 1 changed file with 22 additions and 24 deletions.
46 changes: 22 additions & 24 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ TODO: Add a screenshot of the GUI with annotations

1. Ensure you have Java 11 or above installed in your computer.

<box type="tip" light>
<box type="info" light>

<i class="fa-solid fa-download"></i>
**Installing Java:**
Expand Down Expand Up @@ -256,6 +256,15 @@ A new window is opened, so that it does not clutter up your main window. A GUI s

</box>

<box type="info" light>

**More about help's quick reference:**

The quick reference is meant for **fast and reliable** lookup of commands and their usages, without needing an internet connection and opening a browser to get an overview of the commands.

* It is not meant to contain detailed information about each command. To access detailed information about each command, you can refer to our user guide.
</box>

<box type="tip" light>

<i class="fa-solid fa-maximize"></i>
Expand All @@ -275,15 +284,6 @@ The help window is resizable, so you can **easily reposition and resize** it to

</box>

<box type="info" light>

**More about help's quick reference:**

The quick reference is meant for **fast and reliable** lookup of commands and their usages, without needing an internet connection and opening a browser to get an overview of the commands.

* It is not meant to contain detailed information about each command. To access detailed information about each command, you can refer to our user guide.
</box>

<markdown class="d-print-none">---</markdown>
<div style="page-break-after: always;"></div>
<br>
Expand Down Expand Up @@ -312,21 +312,18 @@ Format: `addstu n/NAME nn/NUSNET [p/PHONE] [e/EMAIL] [m/MAJOR] [t/TAG]…​`
* Name cannot be empty or spaces only, contain only alphabets and cannot have double spaces.
* All the remaining fields are optional. If values are not provided to optional fields, they will be set to a placeholder value under the hood (e.g., `Major not provided` for `MAJOR` field).

<box type="tip" light>

<box type="info" light>
**Tip:** A person can have any number of tags (including 0)
</box>

<box type="tip" light>

**Tip:** If a student is undertaking a double degree programme, you can use a comma to separate the disciplines in the `MAJOR` field. (e.g., `m/Computer Science, Mathematics`)
</box>

<box type="info" light>

**Note:** NUSNet ID is case-insensitive, and it will be converted to uppercase automatically upon running the command. (e.g., `e0123456` will be converted to `E0123456`)
</box>

<box type="tip" light>
**Tip:** If a student is undertaking a double degree programme, you can use a comma to separate the disciplines in the `MAJOR` field. (e.g., `m/Computer Science, Mathematics`)
</box>

Examples:
* `addstu n/John Doe nn/E1234567 p/98765432 e/[email protected] m/Computer Science`
* `addstu n/Betsy Crowe nn/E0123456 t/friend e/[email protected] m/Mathematics, Physics p/1234567 t/club`
Expand Down Expand Up @@ -667,6 +664,13 @@ the previous command `mark nn/E0123456`!
scroll back to the more recent commands you have entered.
</box>


<box type="warning" theme="danger" light>

**Warning:**
When retrieving commands, be aware that it will erase the current text in the command input box.
</box>

<box type="warning" light>

**Caution:**
Expand All @@ -682,12 +686,6 @@ Only commands that has succeeded previously will be retrieved. If you enter an i
when attempting to retrieve it.
</box>

<box type="warning" theme="danger" light>

**Warning:**
When retrieving commands, be aware that it will erase the current text in the command input box.
</box>

<markdown class="d-print-none">---</markdown>
<div style="page-break-after: always;"></div>
<br>
Expand Down

0 comments on commit c86de0f

Please sign in to comment.