Merge remote-tracking branch 'upstream/master'

woodenclock · Nov 8, 2023 · b5eb9bc · b5eb9bc
2 parents 771a1b2 + 704a2c9
commit b5eb9bc
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 23 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -1,4 +1,4 @@
-# WildWatch Developer Guide 🦣
+# WildWatch Developer Guide 🦒
 
 ## Table of Contents  
 - [Introduction](#introduction-)
@@ -55,7 +55,14 @@ Head to the [Glossary](#glossary-) page for its meaning.
 | ✏ Note   | These are important details that you should take note of.   |
 | ⬆ Back to top  | Click to scroll back up to the `Table of Contents`.         |
 | 🐵 🦊 🦁      | Animals indicate you have reached a new section.            |
-
+
+> ❗ IMPORTANT     
+> * Capitalized words between angle brackets `< >` are information to be filled up appropriately by the user.    
+>     * E.g., `delete <INDEX>` should be `delete 2`    
+> * Anything between curly brackets `{ }` are optional [blocks](#glossary-) that may or may not be filled up by the user.    
+>     * E.g., `summary {<SPECIES>}` could be `summary lion` or `summary`.   
+> * Do be mindful that <DATE> cannot be a date in the future   
+    
 [⬆ Back to top](#table-of-contents)
 
 --------------------------------------------------------------------------------------------------------------------------------------
@@ -66,7 +73,7 @@ Head to the [Glossary](#glossary-) page for its meaning.
 
 2. Download the latest `WildWatch.jar` from [here](https://github.com/AY2324S1-CS2113T-W11-2/tp/releases).
 
-3. Copy the file to the folder you want to use as the home folder for your WildWatch.
+3. Move the file to the folder you want to use as the [home folder](#glossary-) for your WildWatch.
 
 4. Open a command terminal, `cd` into the folder you put the jar file in, and run the following command: `java -jar WildWatch.jar`.
 You should see the welcome screen as the diagram below.
@@ -209,7 +216,7 @@ Since clerks are already accustomed to typing and working with a computer, this
 |v1.0|zoo clerk|add an animal entry|record the animals in the zoo, and refer to them afterwards|
 |v1.0|zoo clerk|delete an animal entry|remove redundant or invalid animal entry|
 |v1.0|zoo clerk|list all the entries|see what entries I have entered previously, and refer to them|
-|v1.0|zoo clerk|have a exit command|close the program safely|
+|v1.0|zoo clerk|have an exit command|close the program safely|
 |v2.0|zoo clerk|find an entry item by name|locate the entry I want, without having to go through the entire list|
 |v2.0|zoo clerk|edit a command|change the entry contents to reflect the changes in the zoo|
 |v2.0|zoo clerk|see a summary of all entries|have an idea of the entries at a glance|
@@ -232,8 +239,7 @@ Since clerks are already accustomed to typing and working with a computer, this
 ## Manual Testing 🐼
 
 ### Launching the App
-1. Download the latest JAR file from our release page [here](https://github.com/AY2324S1-CS2113T-W11-2/tp/releases)
-2. Double-click the JAR file to run the app
+1. Refer to the [Quick Start](#quick-start-) section to get WildWatch set up and running.
 
 ### Getting help
 1. Run the `help` command by typing `help` and hitting the `Enter` key on your keyboard
@@ -251,17 +257,16 @@ Expected: No new recorded added.
 1. Run the following command `list`
 
 Expected: All wildlife records shown
-
-
+  
+  
 ### Editing a Wildlife Entry
 1. Run the following command `edit I/1 D/02-03-2023 S/Annam Leaf Turtle N/Ariel R/looks healthy`
-
 Expected: Successfully edited the wildlife record
-3. Run the following command `edit I/-1 D/02-03-2023 S/Annam Leaf Turtle N/Ariel R/looks healthy`
 
+3. Run the following command `edit I/-1 D/02-03-2023 S/Annam Leaf Turtle N/Ariel R/looks healthy`
 Expected: Failed to edit as -1 is not a valid index
-
-
+  
+  
 ### Deleting a Wildlife Entry
 1. Run the following command `delete 1`
 
@@ -270,21 +275,25 @@ Expected: Successfully deleted the first record
 2. Run the following command `delete 0`
 
 Expected: Failed to delete a record as 0 is an invalid record
-
+
+
 ### Getting a summary of the wildlife data
 1. Run the following command `summary`
 
 Expected: A summary of the wildlife record is displayed
-
+
+
 ### Exporting wildlife data to a local file
 1. Run the following command `export myobservations.csv`
 
 Expected: You will be prompted with further questions
-
+
+
 ### Exiting the app
 1. Run the `bye` command
 
-Expected: The app stops
+Expected: The app stops  
+
 [⬆ Back to top](#table-of-contents)
 
 --------------------------------------------------------------------------------------------------------------------------------------
@@ -314,6 +323,7 @@ We are here to help you with terminologies used in the user guide, that may not
 | Terminology    | Meaning                                                     |
 | -------------- |------------------------------------------------------------|
 | Command Line Interface   | A way to communicate with your computer using texts. |
+| Home Folder | Folder in which your program resides |
 
 [⬆ Back to top](#table-of-contents)
 

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -63,7 +63,7 @@ Head to the [Glossary](#glossary-) page for its meaning.
 
 2. Download the latest `WildWatch.jar` from [here](https://github.com/AY2324S1-CS2113T-W11-2/tp/releases).
 
-3. Copy the file to the folder you want to use as the home folder for your WildWatch.
+3. Copy the file to the folder you want to use as the [home folder](#glossary-) for your WildWatch.
 
 4. Open a command terminal, `cd` into the folder you put the jar file in, and run the following command: `java -jar WildWatch.jar`.
 You should see the welcome screen as the diagram below.
@@ -217,17 +217,13 @@ Shows the user how to use all the commands. Additionally, users can also specify
 Format: `help` `help add` `help delete`
 
 Example:  
-![image](https://github.com/AY2324S1-CS2113T-W11-2/tp/assets/69474977/2e76abd5-64bc-4739-ab6e-cc57b243900b)
-
-[⬆ Back to top](#table-of-contents)
+![image](https://github.com/AY2324S1-CS2113T-W11-2/tp/assets/69474977/2e76abd5-64bc-4739-ab6e-cc57b243900b)  
 
 
 ### 9. Exit : `bye`
 To close and save the program.
 
 Format: `bye`
-
-[⬆ Back to top](#table-of-contents)
 
 
 ### 10. Saving the Entries
@@ -309,10 +305,10 @@ Thank you for contributing to the improvement of our program. Your feedback is h
 | Adding Entries               | `add D/<DATE> S/<SPECIES> N/<NAME> {R/<REMARKS>}`                  |
 | Adding Entries (interactive) | `add i/`                                                           |
 | Deleting Entries            | `delete <INDEX>`                                                   |
+| Listing Entries              | `list`                                                             |
 | Finding Entries            | `find <SEARCH>`
 | Editing Entries              | `edit I/<INDEX> {D/<DATE>} {S/<SPECIES>} {N/<NAME>} {R/<REMARKS>}` |
 | Summarizing Entries       | `summary {<SPECIES>}`                                              |
-| Listing Entries              | `list`                                                             |
 | Exporting Entries            | `export {<FILENAME>}`                                              |
 | Getting Help              | `help`                                                             |
 | Exit                      | `bye`                                                              |
@@ -327,6 +323,7 @@ We are here to help you with terminologies used in the user guide, that may not
 | Terminology    | Meaning                                                     |
 | -------------- |------------------------------------------------------------|
 | Command Line Interface   | A way to communicate with your computer using texts. |
+| Home Folder | Folder in which your program resides |
 | Block | A section of a command. |
 
 [⬆ Back to top](#table-of-contents)