Skip to content

Commit

Permalink
Fix remaining box issues
Browse files Browse the repository at this point in the history
  • Loading branch information
ravern committed Nov 12, 2023
1 parent 9004df8 commit 7098db3
Showing 1 changed file with 21 additions and 32 deletions.
53 changes: 21 additions & 32 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -627,66 +627,56 @@ Index out of range:<br>

---

#### Clearing all applicants: **`clear`**

<box type="definition">
#### Clearing all applicants: `clear`

Clears your entire list of applicants.

</box>

**Format:**

<div markdown="block" class="alert alert-info">

**`clear`**

</div>

Following the example above, if you entered everything correctly, you should see the following:


| Before | After |
|:-----------------------------------------------:|:----------------------------------------------:|
| ![clear function UI](images/clear_beforeUI.png) | ![clear function UI](images/clear_afterUI.png) |



<box no-icon type="success">

**Expected Outputs:**

<box type="success" light>
<div markdown="block" class="alert alert-success">

Successfully clearing all applicants.<br>
**`"Applicant list has been cleared!"`**

</box>

</box>
</div>


---

#### Exiting the application **`exit`**

<box type="definition">
#### Exiting the application: `exit`

Exits the application, while ensuring all your changes are saved.

</box>

**Format:**

<div markdown="block" class="alert alert-info">

**`exit`**

<box no-icon type="success">
</div>

**Expected Outputs:**

<box type="success" light>
<div markdown="block" class="alert alert-success">

- Application closes.

</box>

</box>
</div>

---

Expand Down Expand Up @@ -793,7 +783,7 @@ Comparing the same applicant:<br>

---

#### Bookmarking/Unbookmarking applicants: `bookmark/unbookmark`
#### Bookmarking applicants: `bookmark`/`unbookmark`

Bookmarks/Unbookmarks a specific applicant.

Expand Down Expand Up @@ -827,12 +817,15 @@ Following the example above, if you entered everything correctly, you should see
**`unbookmark 2`**
- Unbookmarks the second applicant.

</div>

Following the example above, if you entered everything correctly, you should see the following:

| Before | After |
|:---------------------------------------------------------:|:--------------------------------------------------------:|
| ![unbookmark function UI](images/unbookmark_beforeUI.png) | ![unbookmark function UI](images/unbookmark_afterUI.png) |


**Expected Outputs:**

<div markdown="block" class="alert alert-success">
Expand Down Expand Up @@ -864,7 +857,7 @@ Index out of range:<br>

---

#### Commenting on TA applicant: **`comment`**
#### Commenting on applicant: `comment`

One of yours TAs is unable to make it for the interview.
You want to make a comment on the applicant to remind yourself to follow up with him/her.
Expand Down Expand Up @@ -933,12 +926,8 @@ Index out of range:<br>

#### Importing applicants from spreadsheet: `import`

<box type="definition">

Imports an entire list of applicants along with their details from a CSV file.

</box>

| Sample .csv | After import |
|:----------------------------------:|:------------------------------------------:|
| ![sampleCSV](images/samplecsv.png) | ![importUI](images/import_afterUI.png) |
Expand Down Expand Up @@ -1053,13 +1042,13 @@ TAfinder data are saved in the hard disk automatically after any command that ch

TAfinder data are saved automatically as a JSON file `[JAR file location]/data/tafinder.json`. Advanced users are welcome to update data directly by editing that data file.

<box type="warning">

**Warning:**

<div markdown="block" type="alert alert-warning">

If your changes to the data file makes its format invalid, TAfinder will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.

</box>
</div>

--------------------------------------------------------------------------------------------------------------------
## Upcoming Features [coming in a future update!]
Expand Down

0 comments on commit 7098db3

Please sign in to comment.