Merge branch 'master' into testing-instruct

AY2425S1-CS2103T-F14a-4 · Nov 7, 2024 · 00f05d4 · 00f05d4
2 parents 0d711c9 + 1cb5bf3
commit 00f05d4
Show file tree

Hide file tree

Showing 15 changed files with 40 additions and 77 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -250,23 +250,15 @@ The following activity diagram summarizes what happens when a user executes a ne
 
 #### Design considerations:
 
-**Aspect: How undo & redo executes:**
+**Aspect: How undo & redo executes**
 
 * **Alternative 1 (current choice):** Saves the entire CampusConnect.
   * Pros: Easy to implement.
   * Cons: May have performance issues in terms of memory usage.
 
-* **Alternative 2:** Individual command knows how to undo/redo by
-  itself.
+* **Alternative 2:** Each command that changes the state stores the change that it has made.
   * Pros: Will use less memory (e.g. for `delete`, just save the person being deleted).
-  * Cons: We must ensure that the implementation of each individual command are correct.
-
-_{more aspects and alternatives to be added}_
-
-### \[Proposed\] Data archiving
-
-_{Explain here how the data archiving feature will be implemented}_
-
+  * Cons: Difficult and tedious to implement.
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -284,7 +276,7 @@ _{Explain here how the data archiving feature will be implemented}_
 
 ### Product scope
 
-**Target user profile**:  university students   
+**Target user profile**:  NUS undergraduate students
 
 * has a need to manage a significant number of contacts  
 * prefer desktop apps over other types   
@@ -548,8 +540,6 @@ testers are expected to do more *exploratory* testing.
    1. Re-launch the app by double-clicking the jar file.<br>
        Expected: The most recent window size and location is retained.
 
-1. _{ more test cases … }_
-
 ### Deleting a person
 
 1. Deleting a person while all persons are being shown
@@ -575,23 +565,22 @@ testers are expected to do more *exploratory* testing.
    1. Test case: undo immediately after starting the application (with no operations performed)
    Expected: No undo operation is performed. An error message appears in the status message, indicating there is no action to undo. The status bar remains unchanged.
 
-
 --------------------------------------------------------------------------------------------------------------------
-## **Future features**
+## **Appendix: Future features**
 Below is a list of features that we feel would further enhance the user experience.
 
-  | Feature                                                                         | Description                                                                         |
-  |---------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|
-  | Clustering of tags                                                              | Group tags of the same categories together in the UI's display of the tags list.    |
-  | Pin contacts                                                                    | Keep selected contacts constantly shown at the top of the contacts list.            |
-  | Customize category colors                                                       | Change the colors of the categories to the user's preference.                       |
-  | Multiple numbers per contact                                                    | Allow more than one number per contact to accommodate multiple contact numbers.     |
-  | Custom fields for contacts                                                      | Add custom fields to the contacts added.                                            |
-  | Custom shortcut commands                                                        | Add custom shortcut commands to streamline actions within the application.          |
-  | Delete tag from all contacts                                                    | Remove a specific tag from all contacts at once.                                    |
-  | Dark mode                                                                       | Include a dark mode theme for easier viewing in low light conditions.               |
-  | Copy contact information                                                        | Enable copying of contact information to reduce errors from manual copying.         |
-  | Export contacts                                                                 | Provide an option to export contact information for easier sharing.                 |
+  |                                    Feature                                     | Description                                                                        |
+  |:------------------------------------------------------------------------------:|------------------------------------------------------------------------------------|
+  |                               Clustering of tags                               | Group tags of the same categories together in the UI's display of the tags list.   |
+  |                                  Pin contacts                                  | Keep selected contacts constantly shown at the top of the contacts list.           |
+  |                           Customize category colors                            | Change the colors of the categories to the user's preference.                      |
+  |                          Multiple numbers per contact                          | Allow more than one number per contact to accommodate multiple contact numbers.    |
+  |                           Custom fields for contacts                           | Add custom fields to the contacts added.                                           |
+  |                            Custom shortcut commands                            | Add custom shortcut commands to streamline actions within the application.         |
+  |                          Delete tag from all contacts                          | Remove a specific tag from all contacts at once.                                   |
+  |                                   Dark mode                                    | Include a dark mode theme for easier viewing in low light conditions.              |
+  |                            Copy contact information                            | Enable copying of contact information to reduce errors from manual copying.        |
+  |                                Export contacts                                 | Provide an option to export contact information for easier sharing.                |
 
 --------------------------------------------------------------------------------------------------------------------
 

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -95,6 +95,7 @@ Action     | Format, Examples
 **[Help](#viewing-help-help)**   | `help` 
 
 --------------------------------------------------------------------------------------------------------------------
+## Commands
 
 ### Viewing help : `help`
 
@@ -308,7 +309,7 @@ _Details coming soon ..._
 
 --------------------------------------------------------------------------------------------------------------------
 
-## Known issues
+## Known Issues
 
 1. **When using multiple screens**, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the `preferences.json` file created by the application before running the application again.
 2. **If you minimize the Help Window** and then run the `help` command (or use the `Help` menu, or the keyboard shortcut `F1`) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window.

diff --git a/docs/_markbind/layouts/default.md b/docs/_markbind/layouts/default.md
@@ -31,7 +31,9 @@
   * [Quick Start]({{ baseUrl }}/UserGuide.html#quick-start)
   * [Features]({{ baseUrl }}/UserGuide.html#features)
   * [Command Summary]({{ baseUrl }}/UserGuide.html#command-summary)
+  * [Commands]({{ baseUrl }}/UserGuide.html#commands)
   * [FAQ]({{ baseUrl }}/UserGuide.html#faq)
+  * [Known Issues]({{ baseUrl }}/UserGuide.html#known-issues)
 * [Developer Guide]({{ baseUrl }}/DeveloperGuide.html) :expanded:
   * [Acknowledgements]({{ baseUrl }}/DeveloperGuide.html#acknowledgements)
   * [Setting Up]({{ baseUrl }}/DeveloperGuide.html#setting-up-getting-started)
@@ -40,6 +42,8 @@
   * [Documentation, logging, testing, configuration, dev-ops]({{ baseUrl }}/DeveloperGuide.html#documentation-logging-testing-configuration-dev-ops)
   * [Appendix: Requirements]({{ baseUrl }}/DeveloperGuide.html#appendix-requirements)
   * [Appendix: Instructions for manual testing]({{ baseUrl }}/DeveloperGuide.html#appendix-instructions-for-manual-testing)
+  * [Appendix: Future features]({{ baseUrl }}/DeveloperGuide.html#appendix-future-features)
+  * [Appendix: Effort]({{ baseUrl }}/DeveloperGuide.html#appendix-effort)
 * [About Us]({{ baseUrl }}/AboutUs.html)
       </site-nav>
     </div>

diff --git a/src/main/resources/images/nus_mascot.png → docs/images/CampusConnectLogo.png b/src/main/resources/images/nus_mascot.png → docs/images/CampusConnectLogo.png
diff --git a/docs/images/SeEduLogo.png b/docs/images/SeEduLogo.png
diff --git a/docs/images/desktop.ini b/docs/images/desktop.ini
diff --git a/docs/site.json b/docs/site.json
@@ -1,8 +1,7 @@
 {
   "baseUrl": "",
   "titlePrefix": "CampusConnect",
-  "titleSuffix": "CampusConnect Level-3",
-  "faviconPath": "images/SeEduLogo.png",
+  "faviconPath": "images/CampusConnectLogo.png",
   "style": {
     "codeTheme": "light"
   },

diff --git a/docs/team/chrisjohntan.md b/docs/team/chrisjohntan.md
@@ -0,0 +1,6 @@
+---
+  layout: default.md
+  title: "Christopher's Project Portfolio Page"
+---
+
+### Project: CampusConnect
diff --git a/docs/team/cyx22222003.md b/docs/team/cyx22222003.md
@@ -0,0 +1,6 @@
+---
+  layout: default.md
+  title: "Yi Xun's Project Portfolio Page"
+---
+
+### Project: CampusConnect
diff --git a/docs/team/krashkart.md b/docs/team/krashkart.md
@@ -1,46 +1,6 @@
 ---
   layout: default.md
-  title: "John Doe's Project Portfolio Page"
+  title: "Zheng Jie's Project Portfolio Page"
 ---
 
 ### Project: CampusConnect
-
-CampusConnect is a desktop address book application used for teaching Software Engineering principles. 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.
-
-Given below are my contributions to the project.
-
-* **New Feature**: Added the ability to undo/redo previous commands.
-  * What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
-  * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
-  * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.
-  * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}*
-
-* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys.
-
-* **Code contributed**: [RepoSense link]()
-
-* **Project management**:
-  * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub
-
-* **Enhancements to existing features**:
-  * Updated the GUI color scheme (Pull requests [\#33](), [\#34]())
-  * Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]())
-
-* **Documentation**:
-  * User Guide:
-    * Added documentation for the features `delete` and `find` [\#72]()
-    * Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]()
-  * Developer Guide:
-    * Added implementation details of the `delete` feature.
-
-* **Community**:
-  * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]()
-  * Contributed to forum discussions (examples: [1](), [2](), [3](), [4]())
-  * Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]())
-  * Some parts of the history feature I added was adopted by several other class mates ([1](), [2]())
-
-* **Tools**:
-  * Integrated a third party library (Natty) to the project ([\#42]())
-  * Integrated a new Github plugin (CircleCI) to the team repo
-
-* _{you can add/remove categories in the list above}_
diff --git a/src/main/java/seedu/address/ui/UiManager.java b/src/main/java/seedu/address/ui/UiManager.java
@@ -20,7 +20,7 @@ public class UiManager implements Ui {
     public static final String ALERT_DIALOG_PANE_FIELD_ID = "alertDialogPane";
 
     private static final Logger logger = LogsCenter.getLogger(UiManager.class);
-    private static final String ICON_APPLICATION = "/images/nus_logo.png";
+    private static final String ICON_APPLICATION = "/images/CampusConnectLogo.png";
 
     private Logic logic;
     private MainWindow mainWindow;

diff --git a/src/main/resources/images/CampusConnectLogo.png b/src/main/resources/images/CampusConnectLogo.png
diff --git a/src/main/resources/images/nus_logo.png b/src/main/resources/images/nus_logo.png
diff --git a/src/main/resources/view/HelpWindow.fxml b/src/main/resources/view/HelpWindow.fxml
@@ -11,7 +11,7 @@
 <?import javafx.scene.control.Hyperlink?>
 <fx:root resizable="false" title="CampusConnect Help" type="javafx.stage.Stage" xmlns="http://javafx.com/javafx/17" xmlns:fx="http://javafx.com/fxml/1">
   <icons>
-    <Image url="@/images/nus_mascot.png" requestedWidth="100"/>
+    <Image url="@/images/CampusConnectLogo.png" requestedWidth="100"/>
   </icons>
   <scene>
     <Scene>

diff --git a/src/main/resources/view/MainWindow.fxml b/src/main/resources/view/MainWindow.fxml
@@ -15,7 +15,7 @@
 <fx:root type="javafx.stage.Stage" xmlns="http://javafx.com/javafx/17" xmlns:fx="http://javafx.com/fxml/1"
          title="CampusConnect" minWidth="640" minHeight="480" onCloseRequest="#handleExit">
   <icons>
-    <Image url="@/images/nus_logo.png" />
+    <Image url="@/images/CampusConnectLogo.png" />
   </icons>
   <scene>
     <Scene>