diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
index 950af7635df..36cb150fb35 100644
--- a/docs/DeveloperGuide.md
+++ b/docs/DeveloperGuide.md
@@ -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`:
+
+
```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" : "",
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
index ed950a81126..2c95e31db99 100644
--- a/docs/UserGuide.md
+++ b/docs/UserGuide.md
@@ -8,6 +8,7 @@ title: User Guide
--------------------------------------------------------------------------------------------------------------------
+
# Table of Contents
* [Introduction](#introduction)
@@ -47,6 +48,8 @@ title: User Guide
--------------------------------------------------------------------------------------------------------------------
+
+
# Introduction
Welcome to the *Fish Ahoy! User Guide*!
@@ -145,6 +148,9 @@ A GUI similar to the below should appear in a few seconds. Note how the app cont
--------------------------------------------------------------------------------------------------------------------
+
+
+
# About the Interface
The *Fish Ahoy!* interface consists of three main components, the **Command Line**, **Alerts**, and **Panels**,
@@ -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!
+
+
## Fish Interface
A sample Fish item is shown below. Each Fish you add in *Fish Ahoy!* has multiple [parameters](#parameters-br), such as
@@ -196,6 +204,8 @@ The **Fish Icon** is matched to the [Species](#species-sspecies) of the fish!
--------------------------------------------------------------------------------------------------------------------
+
+
# *Fish Ahoy!* Commands
In general, the command format is as follows:
@@ -330,6 +340,8 @@ In general, the command format is as follows:
--------------------------------------------------------------------------------------------------------------------
+
+
# Features
## Tanks
@@ -512,6 +524,8 @@ Example:
* Temperature: 40 degrees celsius
* Date and time associated with each reading: 06/04/2023 1433
+(continued next page)
+
### Deleting the most recent set of readings: `tank delLastReadings`
@@ -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)
+
+
+
* 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.
@@ -594,6 +613,8 @@ Example:
* Feeding interval: 2 days 0 hours
* Tank: Tank with index 1
+
+
### Deleting a fish: `fish delete`
You can delete a fish from *Fish Ahoy!* with the `fish delete` command.
@@ -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)
+
### Viewing a fish: `fish view`
@@ -802,6 +825,8 @@ Parameters:
Example:
* `task delete 1` deletes the first task listed in the [tasks panel](#about-the-interface)
+
+
### Editing a task: `task edit`
You can edit the details of an existing task with the `task edit` command.
@@ -886,6 +911,11 @@ Example:
+--------------------------------------------------------------------------------------------------------------------
+
+
+
+
## Storage
### Saving the data
@@ -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!*
+
+
## Help
### Viewing help : `help`
@@ -918,6 +950,8 @@ Format: `help`
--------------------------------------------------------------------------------------------------------------------
+
+
## FAQ
**Q**: How do I add my fish to *Fish Ahoy!*
@@ -940,6 +974,8 @@ Format: `help`
--------------------------------------------------------------------------------------------------------------------
+
+
## Command summary
| Action | Format, Examples |
@@ -951,6 +987,7 @@ Format: `help`
| **List** | `list tasks` `list fishes` |
| **Help** | `help` |
+--------------------------------------------------------------------------------------------------------------------
## Command prefix summary
@@ -968,3 +1005,5 @@ Format: `help`
| **Tank** | **Temperature reading** | **tp/** |
| **Task** | **Priority** | **p/** |
| **All** | **Tank** | **tk/** |
+
+--------------------------------------------------------------------------------------------------------------------