Skip to content

Commit

Permalink
Merge pull request #257 from bokuanT/branch-UGpagebreak
Browse files Browse the repository at this point in the history 
Try fix UG page breaks and DG code block
  • Loading branch information
@ryanchua00
ryanchua00 authored Apr 10, 2023
2 parents 4474296 + 0a85014 commit 662d41c
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 8 deletions.
16 changes: 9 additions & 7 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -611,16 +611,18 @@ testers are expected to do more *exploratory* testing.
1. Checking that graphs of each tank can display readings correctly
1. Prerequisites: The tanks are the default sample tanks, "freshwater tank" and "saltwater tank"
2. Test case: paste the following test values into `readings.json`: <br>


```json
{
"readingLevels" : [ {
"tankName" : "freshwater tank",
"commaSeperatedValuesAmmonia" : "0.2,0.3,0.0",
"commaSeperatedDatesAmmonia" : "03/04/2023 14:00,04/04/2023 20:01,05/04/2023 14:02",
"commaSeperatedValuesPH" : "7.1,6.8,7.0",
"commaSeperatedDatesPH" : "03/04/2023 14:00,04/04/2023 20:01,05/04/2023 14:02",
"commaSeperatedValuesTemp" : "26.0,25.0,26.2",
"commaSeperatedDatesTemp" : "03/04/2023 14:00,04/04/2023 20:01,05/04/2023 14:02"
"tankName" : "freshwater tank",
"commaSeperatedValuesAmmonia" : "0.2,0.3,0.0",
"commaSeperatedDatesAmmonia":"03/04/2023 14:00,04/04/2023 20:01,05/04/2023 14:02",
"commaSeperatedValuesPH": "7.1,6.8,7.0",
"commaSeperatedDatesPH" : "03/04/2023 14:00,04/04/2023 20:01,05/04/2023 14:02",
"commaSeperatedValuesTemp" : "26.0,25.0,26.2",
"commaSeperatedDatesTemp":"03/04/2023 14:00,04/04/2023 20:01,05/04/2023 14:02"
}, {
"tankName" : "saltwater tank",
"commaSeperatedValuesAmmonia" : "",
Expand Down
41 changes: 40 additions & 1 deletion docs/UserGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ title: User Guide

--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>

# Table of Contents
* [Introduction](#introduction)
Expand Down Expand Up @@ -47,6 +48,8 @@ title: User Guide

--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>

# Introduction

Welcome to the *Fish Ahoy! User Guide*! <br>
Expand Down Expand Up @@ -145,6 +148,9 @@ A GUI similar to the below should appear in a few seconds. Note how the app cont

--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>


# About the Interface

The *Fish Ahoy!* interface consists of three main components, the **Command Line**, **Alerts**, and **Panels**,
Expand Down Expand Up @@ -183,6 +189,8 @@ The [Ammonia](#tank-ammonia-level-reading-alammonia_level), [Temperature](#tank-
> :bulb: Tip: Fluctuations in tank conditions can lead to a lot of stress for your fish. The handy charts displayed for [Ammonia](#tank-ammonia-level-reading-alammonia_level), [Temperature](#tank-temperature-reading-tptemperature) and
[pH](#tank-ph-reading-phph) can let you know at a glance if your levels are stable!

<div style="page-break-after: always;"></div>

## Fish Interface

A sample Fish item is shown below. Each Fish you add in *Fish Ahoy!* has multiple [parameters](#parameters-br), such as
Expand All @@ -196,6 +204,8 @@ The **Fish Icon** is matched to the [Species](#species-sspecies) of the fish!

--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>

# *Fish Ahoy!* Commands

In general, the command format is as follows:<br>
Expand Down Expand Up @@ -330,6 +340,8 @@ In general, the command format is as follows:<br>

--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>

# Features

## Tanks
Expand Down Expand Up @@ -512,6 +524,8 @@ Example:
* Temperature: 40 degrees celsius
* Date and time associated with each reading: 06/04/2023 1433

(continued next page)

![AddReadingDemo](images/UiAddReadingsDemo.png)

### Deleting the most recent set of readings: `tank delLastReadings`
Expand All @@ -532,8 +546,13 @@ Parameters:
Example:
* Scenario 1: You have one tank, 'Freshwater tank' of index 1, with 2 sets of readings. One set made at 12pm and one set made at 3pm. `tank delLastReadings 1`
deletes the most recent readings, the set made at 3pm.

(continued next page)

<div style="page-break-after: always;"></div>

* Scenario 2 (Screenshot below) : You mistakenly add a set of readings to 'Freshwater tank' of index 1.
`tank delLastReadings 1` deletes the most recent set of readings.
`tank delLastReadings 1` deletes the most recent set of readings.

![AddReadingDemo](images/UiDelLastReadingsDemo.png)

Expand Down Expand Up @@ -594,6 +613,8 @@ Example:
* Feeding interval: 2 days 0 hours
* Tank: Tank with index 1

<div style="page-break-after: always;"></div>

### Deleting a fish: `fish delete`

You can delete a fish from *Fish Ahoy!* with the `fish delete` command.
Expand Down Expand Up @@ -702,6 +723,8 @@ Using `fish sort by/n tk/1` will result in the following fishes from tank 1 bein
* 2 - 'Marlin'
* 3 - 'Nemo'

(continued next page)

![AddReadingDemo](images/UiSortNameDemo.png)

### Viewing a fish: `fish view`
Expand Down Expand Up @@ -802,6 +825,8 @@ Parameters:
Example:
* `task delete 1` deletes the first task listed in the [tasks panel](#about-the-interface)

<div style="page-break-after: always;"></div>

### Editing a task: `task edit`

You can edit the details of an existing task with the `task edit` command.
Expand Down Expand Up @@ -886,6 +911,11 @@ Example:

![UiFeedingReminder](images/UiTankFeed1.png)

--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>


## Storage
### Saving the data

Expand All @@ -904,6 +934,8 @@ you might want to insert it directly in the `readings.json` file!
> This will result in a completely empty interface. Delete your `data` folder, containing `addressbook.json` and so on
> to revert back to the default *Fish Ahoy!*
<div style="page-break-after: always;"></div>

## Help
### Viewing help : `help`

Expand All @@ -918,6 +950,8 @@ Format: `help`

--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>

## FAQ

**Q**: How do I add my fish to *Fish Ahoy!*<br>
Expand All @@ -940,6 +974,8 @@ Format: `help`

--------------------------------------------------------------------------------------------------------------------

<div style="page-break-after: always;"></div>

## Command summary

| Action | Format, Examples |
Expand All @@ -951,6 +987,7 @@ Format: `help`
| **List** | `list tasks` `list fishes` |
| **Help** | `help` |

--------------------------------------------------------------------------------------------------------------------

## Command prefix summary

Expand All @@ -968,3 +1005,5 @@ Format: `help`
| **Tank** | **Temperature reading** | **tp/** |
| **Task** | **Priority** | **p/** |
| **All** | **Tank** | **tk/** |

--------------------------------------------------------------------------------------------------------------------

0 comments on commit 662d41c

Please sign in to comment.