Merge branch 'master' into update-ppp-reformat

AY2324S1-CS2103T-F11-2 · Nov 13, 2023 · 22d80bf · 22d80bf
2 parents ecc0481 + c07e631
commit 22d80bf
Show file tree

Hide file tree

Showing 5 changed files with 95 additions and 51 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -69,6 +69,7 @@
 ## **1. Acknowledgements**
 - The undo / redo feature was reused with minor modifications from [Address Book(Level 4)](https://github.com/se-edu/addressbook-level4).
 - The function to parse optional values was reused with minor modifications from [Jobby](https://github.com/AY2324S1-CS2103T-W08-3/tp).
+- The FAQ section of the user guide was partially adapted from [AY2324S1-CS2103T-W11-2](https://github.com/AY2324s1-cs2103t-w11-2/tp/).
 
 --------------------------------------------------------------------------------------------------------------------
 

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -129,13 +129,17 @@ If you would like a detailed look into each of the features WedLog has to offer,
 
 ## 2. Getting Started
 
-1. Ensure you have Java `11` or above installed in your Computer.
+1. Ensure you have Java version `11` or above installed in your Computer.
+   - You may refer to [this guide](https://blog.hubspot.com/website/check-java-verison) to check the Java version running on your computer.
+   - If your computer is not running Java version `11` or above, you may refer to these guides ([Windows](https://www.codejava.net/java-se/download-and-install-java-11-openjdk-and-oracle-jdk), [Mac](https://java.tutorials24x7.com/blog/how-to-install-java-11-on-mac))
+   for instructions on how to install Jave version `11` on your computer.
 
-2. Download the latest `wedlog.jar` from [here](https://github.com/AY2324S1-CS2103T-F11-2/tp/releases).
 
-3. Copy the file to the folder you want to use as the _home folder_ for your WedLog.
+2. Download the latest `wedlog.jar` file by clicking [here](https://github.com/AY2324S1-CS2103T-F11-2/tp/releases/download/v1.4/wedlog.jar).
 
-4. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar wedlog.jar` command to run the application.<br>
+3. Move the `wedlog.jar` file to the folder you want to use as the home folder for WedLog. You are encouraged to create a new folder specifically for WedLog and to move the `wedlog.jar` file into that folder. All data created by WedLog will be stored in this folder. 
+
+4. Open the WedLog application by double-clicking on the `wedlog.jar` file. If this does not work, [open your computer's terminal](https://towardsdatascience.com/a-quick-guide-to-using-command-line-terminal-96815b97b955), [navigate to the folder](https://tutorials.codebar.io/command-line/introduction/tutorial.html) containing `wedlog.jar`, and type `java -jar wedlog.jar` to start the application.
 
 5. A window similar to the one below should appear in a few seconds. Note how the app contains some sample data.
 
@@ -974,12 +978,39 @@ Upon exit, the latest data is saved to your computer at `data/addressbook.json`.
 --------------------------------------------------------------------------------------------------------------------
 
 ## 6. FAQ
+<!--@@author p-xp-adapted from https://ay2324s1-cs2103t-w11-2.github.io/tp/UserGuide.html#faq-->
 
 **Q**: How do I transfer my data to another Computer?<br>
-**A**: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous AddressBook home folder.
+**A**: Install WedLog on the other computer and replace the data file it creates with your existing data file. This data file
+can be located in your existing WedLog home folder.
+
+<br />
+
+**Q**: Is there somewhere I can refer to all the commands at one glance?<br>
+**A**: You may refer to our [command summary](#9-command-summary) section for a quick overview of all the commands available in WedLog.
 
 <br />
 
+**Q**: I accidentally deleted my data file. How can I recover my lost data?<br>
+**A**: Please try looking for the deleted file in your computer's recycle bin. Once located, simply move the file from the recycle bin into the same folder as the `wedlog.jar` file. 
+Unfortunately, in the event that you cannot locate the deleted file in your recycle bin, we are 
+unable to help you recover your lost data.
+
+<br />
+
+**Q**: Can I use WedLog without an internet connection?<br>
+**A**: Yes, the WedLog application does not require internet connection to run.
+
+<br />
+
+**Q**: My wedding is over. How can I remove WedLog from my computer?<br>
+**A**: We hope you had a good wedding planning journey with WedLog! If you placed WedLog inside a dedicated folder during the installation process,
+simply delete the entire folder. Otherwise, you will have to find and delete the following files individually: `wedlog.jar`, `addressbook.log.0`, `preferences.json`, `config.json`, alongside the `data` folder.
+
+<br />
+
+> [Back to top](#user-guide)
+
 --------------------------------------------------------------------------------------------------------------------
 
 ## 7. Known Issues

diff --git a/docs/team/keaganpzh.md b/docs/team/keaganpzh.md
@@ -54,7 +54,7 @@ Given below are my contributions to the project.
     * Set up Codecov to track code coverage. [\#1](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/1)
     * Managed releases `v1.2`, `v1.3(trial)`, `v1.3`.
 
-### Contributions beyond the Project Team
+### Community
 * **PE-D**:
     * Identified and published [9 issues](https://github.com/keaganpzh/ped) to another team's repository.
 
diff --git a/docs/team/p-xp.md b/docs/team/p-xp.md
@@ -3,47 +3,58 @@ layout: default.md
 title: "Pan Xinping's Project Portfolio Page"
 ---
 
-# Overview
+### Project: WedLog
 
 WedLog is a desktop application created for partners getting married that helps them manage the guests and vendors involved in the wedding. 
 The user interacts with it using a CLI, and it has a GUI created with JavaFX. 
 It is written in Java, and has about 10 kLoC. This project is based on [AddressBook - Level 3](https://se-education.org/addressbook-level3/).
 
 Given below are my contributions to the project.
 
-* **New Feature**: Added the ability to add guests and vendors.
+### Features
+1. **New Feature**: Added the ability to add guests and vendors.
     * What it does: Allows users to add new guests and vendors with all the associated fields to WedLog.
     * Justification: This feature is central to the product as users cannot manage guests and vendors without being able to add them.
     * Highlights: The implementation was challenging as guests and vendors had optional fields which users could choose not to fill in.
 
-* **New Feature**: Added the ability to edit guests.
+<br>
+
+2. **New Feature**: Added the ability to edit guests.
     * What it does: Allows the user to edit fields of a guest.
     * Justification: This feature improves the product significantly because a user may want to modify guest information and the app should provide an easy way to do so without having to remove and add the guest back.
     * Highlights: The implementation was challenging because guests have optional fields which can be removed by using empty prefixes in the edit command. This required a careful consideration of design alternatives.
 
-* **New Feature**: Added the ability to filter guests by fields that stored information as tags (i.e., Dietary Requirements and Tags fields).
+<br>
+
+3. **New Feature**: Added the ability to filter guests by fields that stored information as tags (i.e., Dietary Requirements and Tags fields).
     * What it does: Allows users to filter all guests using tag fields.
     * Justification: This feature improves the product significantly as users may want to view all users that belong to a certain category (e.g. "vegans", or "classmates") without searching for them individually.
     * Highlights: 
       * The implementation was challenging as unlike non-tag fields, tag fields can store multiple values (e.g. a guest may have two Dietary Requirements tags). Hence, there was a need to carefully consider use cases to decide on the final design where users can filter via multiple tags.
       * Ensured high test effectiveness and efficiency by applying test heuristics like equivalence partitions to test designs (see `TagPredicateTest` and `GuestDietaryPredicateTest`).
 
-* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=p-xp&breakdown=true)
-
-* **Contribution to team tasks**:
-    * Organised team meeting agenda based on weekly deliverables and tracked list of TODOs determined during team discussions.
-    * Allocated issues identified in PED to team members on GitHub.
-
-* **Documentation**:
-    * User Guide:
-        * Added documentation for `guest edit` [\#127](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/127)
-        * Updated documentation for `guest add` [\#105](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/105), `vendor add` [\#106](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/106), and`guest filter` [\#153](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/153)
-    * Developer Guide:
-        * Added implementation details of the `add` feature [\#150](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/150), [\#268](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/268)
-        * Wrote Appendix D: Effort [\#268](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/268)
-
-* **Community**:
-    * PRs reviewed (with non-trivial review comments): [\#41](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/41), [\#142](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/142)
-    * Reported [17 bugs and suggestions](https://github.com/p-xp/ped/issues) for other teams
+### Code Contributed 
+[RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=p-xp&breakdown=true)
+
+### Documentation
+* User Guide:
+    * Added documentation for `guest edit`: [\#127](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/127)
+    * Updated documentation for `guest add`: [\#105](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/105)
+    * Updated documentation for `vendor add`: [\#106](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/106)
+    * Updated documentation for `guest filter`: [\#153](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/153)
+    * Enhanced Quick Start and FAQ sections: [\#276](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/276)
+    * Credits: FAQ section was partially adapted from [AY2324S1-CS2103T-W11-2](https://github.com/AY2324s1-cs2103t-w11-2/tp/).
+* Developer Guide:
+    * Added implementation details of the `add` feature: [\#150](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/150), [\#268](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/268)
+    * Wrote Appendix D Effort: [\#268](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/268)
+
+### Contributions to team tasks
+* Organised team meeting agenda based on weekly deliverables and tracked deadlines determined during team discussions.
+* Allocated issues identified in PED to team members on GitHub.
+* Managed release `v1.4`.
+
+### Community
+* PRs reviewed (with non-trivial review comments): [\#41](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/41), [\#142](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/142)
+* Reported [17 bugs and suggestions](https://github.com/p-xp/ped/issues) for other teams
 
 
diff --git a/docs/team/wasjoe1.md b/docs/team/wasjoe1.md
@@ -9,46 +9,47 @@ WedLog is a desktop application created for partners getting married that helps
 
 Given below are my contributions to the project.
 
-* **New Feature**: Added the ability to parse inputs for all parameters in guest and vendor commands.
+### Features
+1. **New Feature**: Added the ability to parse inputs for all parameters in guest and vendor commands.
     * What it does: Parses the user inputs and returns command to be executed.
     * Justification: This feature improves the product significantly because guest and vendor command inputs can be parsed and commands can be executed accordingly.
     * Highlights: The implementation was challenging because each command had a respective parser class which accepted different types of inputs respectively. This required careful consideration of possible user inputs.
     * Credits: Partially adapted from `Parser` classes in [AY2324S1-CS2103T-W08-3](https://github.com/AY2324S1-CS2103T-W08-3/tp/).
 
-* **New Feature**: Added the ability to display lists of guests and vendors.
+2. **New Feature**: Added the ability to display lists of guests and vendors.
     * What it does: allows the user to view all guests and vendors in a list format.
     * Justification: This feature improves the product significantly because a user may want to have an overarching view of all their guests that will be attending the wedding and the vendors they have in contact.
     * Credits: Partially adapted from `ListCommand` class in [AY2324S1-CS2103T-W08-3](https://github.com/AY2324S1-CS2103T-W08-3/tp/).
 
-* **New Feature**: Added the ability to filter guests and vendors.
+3. **New Feature**: Added the ability to filter guests and vendors.
     * What it does: allows the user to filter guest and vendor lists by all non-tag parameters.
     * Justification: This feature improves the product significantly because a user can now filter the guest and vendor list by more parameters, giving them a more customised filter feature.
     * Highlights: The implementation was challenging because each parameter had a respective predicate class which accepted different types of inputs respectively. This required careful consideration of possible user inputs.* 
       Also employed defensive programming practices in implementation and applied test heuristics in test case design (observed in Predicate classes e.g. `NamePredicate` and `NamePredicateTest`).
     * Credits: Partially adapted from `FindCommand` and `NameContainsKeywordsPredicate` class in [AY2324S1-CS2103T-W08-3](https://github.com/AY2324S1-CS2103T-W08-3/tp/).
 
-* **New Feature**: Modified the guest class to take in Dietary requirement field (initial implementation).
+4. **New Feature**: Modified the guest class to take in Dietary requirement field (initial implementation).
     * What it does: allows the user to add a dietary requirement to guests.
     * Justification: This feature improves the product significantly because a user can now keep track of dietary requirements for guests.
     * Credits: Partially adapted from `Phone` class in [AY2324S1-CS2103T-W08-3](https://github.com/AY2324S1-CS2103T-W08-3/tp/).
 
-* **Code contributed**: [RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=wasjoe1&breakdown=false&sort=groupTitle%20dsc&sortWithin=title&since=2023-09-22&timeframe=commit&mergegroup=&groupSelect=groupByRepos)
-
-* **Project management**:
-    * Managed release [`v1.3`](https://github.com/AY2324S1-CS2103T-F11-2/tp/releases/tag/v1.3) on GitHub.
-
-* **Documentation**:
-    * User Guide:
-        * Added documentation for the features `guest list` and `vendor list`: [\#40](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/40/)
-        * Added documentation for the features `guest filter` and `vendor filter`: [\#121](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/121)
-        * Added documentation for the feature `clear`: [\#121](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/121)
-        * Added documentation for dietary requirements field: [\#98](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/98)
-        * Vetted UG before PED: [\#174](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/174), [\#175](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/175)
-        * Updated Appendix: [\#267](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/267)
-    * Developer Guide:
-        * Added use case section: [\#38](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/38)
-        * Added implementation details for the feature `filter`: [\#145](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/145)
-
-* **Community**:
-    * PRs reviewed (with non-trivial review comments): [#\164](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/164), [#\153](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/153)
-    * Reported [13 bugs and suggestions](https://github.com/wasjoe1/ped/issues) for other teams
+### Code Contributed
+[RepoSense link](https://nus-cs2103-ay2324s1.github.io/tp-dashboard/?search=wasjoe1&breakdown=false&sort=groupTitle%20dsc&sortWithin=title&since=2023-09-22&timeframe=commit&mergegroup=&groupSelect=groupByRepos)
+
+<<<<<<< HEAD
+### Documentation
+* User Guide:
+    * Added documentation for the features `guest list` and `vendor list`: [\#40](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/40/)
+    * Added documentation for the features `guest filter` and `vendor filter`: [\#121](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/121)
+    * Added documentation for dietary requirements field: [\#98](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/98)
+    * Vetted UG before PED: [\#174](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/174), [\#175](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/175)
+* Developer Guide:
+    * Added use case section: [\#38](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/38)
+    * Added implementation details for the feature `filter`: [\#145](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/145)
+
+### Contributions to team tasks
+* Managed release `v1.3` (https://github.com/AY2324S1-CS2103T-F11-2/tp/releases/tag/v1.3) on GitHub.
+
+### Community
+* PRs reviewed (with non-trivial review comments): [#\164](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/164), [#\153](https://github.com/AY2324S1-CS2103T-F11-2/tp/pull/153)
+* Reported [13 bugs and suggestions](https://github.com/wasjoe1/ped/issues) for other teams