Merge pull request AY2425S1-CS2103T-F11-2#205 from shizy/branch-Updat…

…eDocs Minor styling fixes and change to DG
yyihaoc · Nov 7, 2024 · 9289531 · 9289531
2 parents e46599d + 29a3912
commit 9289531
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 39 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -5,6 +5,10 @@ title: Developer Guide
 
 ## Overview
 
+CCAConnect is a desktop application that aims to **assist NUS CCA leaders** in **managing and collating relevant CCA personnel’s contact details**, as well as help to **track attendance details for CCA sessions**.
+Equipped with features like **attendance marking**, **contact management**, **contact filtering** and **profile switching**, CCAConnect helps to reduce the headaches of personnel tracking.
+
+--------------------------------------------------------------------------------------------------------------------
 
 ## Table of Contents
 * Table of Contents
@@ -14,7 +18,8 @@ title: Developer Guide
 
 ## **Acknowledgements**
 
-* {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).
+* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -209,7 +214,6 @@ The following activity diagram summarizes what happens when a user executes a ne
 
 <img src="images/CommitActivityDiagram.png" width="250" />
 
-
 ### Switch Profile Feature
 
 The `switch` command allows users to manage separate profiles within the application, each storing independent data in an isolated session. This feature enables users to work on different datasets without interference, as if each profile represented a unique instance of the application.
@@ -234,12 +238,6 @@ Consider these test cases for `switch` command validation:
    - **Single Profile Scenario:** If no other profiles are available to be swapped (i.e., only one profile exists), the application should display a help message to guide the user.
    - **Multiple Profiles Scenario:** If multiple profiles are available, the application should list the available profiles, showing the options that can be switched to.
 
-
-### \[Proposed\] Data archiving
-
-_{Explain here how the data archiving feature will be implemented}_
-
-
 --------------------------------------------------------------------------------------------------------------------
 
 ## **Documentation, logging, testing, configuration, dev-ops**
@@ -314,15 +312,15 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli
 | `*`      | user          | set privacy levels for each contact's information                           | protect sensitive details                                               |
 | `*`      | user          | see a profile picture for each contact                                      | recall the person from the picture                                      |
 
-*{More to be added}*
+ 
 
 ### Use cases
 
 **Notes**: _For all use cases below, the **System** is  `CCAConnect` and the **Actor** is the `user`, unless specified otherwise_
 <br>
 
-**Use Case: UC01 - View John Doe’s Contact Information**
-**Actor: User**
+**Use Case: UC01 - View John Doe’s Contact Information**<br/>
+**Actor: User**<br/>
 **MSS**
 
 1. User enters appropriate ‘view’ command to search for ‘John Doe’s contact information.
@@ -339,8 +337,8 @@ Use Case ends.
 
 <br>
 
-**Use Case: UC02 - Delete a contact**
-**Actor: User**
+**Use Case: UC02 - Delete a contact**<br/>
+**Actor: User**<br/>
 **MSS**
 
 1. User requests to list all contacts.
@@ -361,8 +359,8 @@ Use Case ends.
 
 <br>
 
-**Use Case: UC03 - Add a contact**
-**Actor: User**
+**Use Case: UC03 - Add a contact**<br/>
+**Actor: User**<br/>
 **MSS**
 
 1. User requests to add a contact.
@@ -382,8 +380,8 @@ Use Case ends.
 
 <br>
 
-**Use Case: UC04 - Search for a contact**
-**Actor: User**
+**Use Case: UC04 - Search for a contact**<br/>
+**Actor: User**<br/>
 **MSS**
 
 1. User searches the list of contacts with a query relating to a contact’s name.
@@ -402,8 +400,8 @@ Use Case ends.
 
 <br>
 
-**Use Case: UC05 - List all contacts**
-**Actor: User**
+**Use Case: UC05 - List all contacts**<br/>
+**Actor: User**<br/>
 **MSS**
 
 User enters ‘list’ command to view information of all contacts.
@@ -420,8 +418,8 @@ Use Case ends.
 
 <br>
 
-**Use Case: UC06 - View all commands**
-**Actor: User**
+**Use Case: UC06 - View all commands**<br/>
+**Actor: User**<br/>
 **MSS**
 
 1. User requests to see all the available commands.
@@ -431,8 +429,8 @@ Use Case ends.
 
 <br>
 
-**Use Case: UC07 - View all members**
-**Actor: User**
+**Use Case: UC07 - View all members**<br/>
+**Actor: User**<br/>
 **MSS**
 
 1. User requests to see all members in the contacts.
@@ -443,8 +441,8 @@ Use Case ends.
 
 <br>
 
-**Use Case: UC08 - Mark attendance of members**
-**Actor: User**
+**Use Case: UC08 - Mark attendance of members**<br/>
+**Actor: User**<br/>
 **MSS**
 
 1. User requests to mark the attendance of members.
@@ -469,8 +467,8 @@ Use Case ends.
 
 <br>
 
-**Use Case: UC09 - Unmark attendance of members**
-**Actor: User**
+**Use Case: UC09 - Unmark attendance of members**<br/>
+**Actor: User**<br/>
 **MSS**
 
 1. User requests to unmark the attendance of members.

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -10,6 +10,8 @@ title: User Guide
 CCAConnect is a desktop application that aims to **assist NUS CCA leaders** in **managing and collating relevant CCA personnel’s contact details**, as well as help to **track attendance details for CCA sessions**.
 Equipped with features like **attendance marking**, **contact management**, **contact filtering** and **profile switching**, CCAConnect helps to reduce the headaches of personnel tracking.
 
+--------------------------------------------------------------------------------------------------------------------
+
 <!-- Table of Content -->
 ## Table of Contents
 * Table of Contents
@@ -59,17 +61,17 @@ Equipped with features like **attendance marking**, **contact management**, **co
 <details>
   <summary style="font-weight:600;font-size:20px;">Notes about the command format:</summary>
 
-  - Words in <code>UPPER_CASE</code> are the parameters to be supplied by the user.<br>
-     - e.g. in <code>add n/NAME</code>, <code>NAME</code> is a parameter which can be used as <code>add n/John Doe</code>.<br><br>
-  - Items in square brackets are optional.<br>
-     - e.g <code>n/NAME [t/TAG]</code> can be used as <code>n/John Doe t/friend</code> or as <code>n/John Doe</code>.<br><br>
-  - Items in square brackets are optional.<br>
-     - e.g <code>n/NAME [t/TAG]</code> can be used as <code>n/John Doe t/friend</code> or as <code>n/John Doe</code>.<br><br>
-  - Items with <code>…</code> after them can be used multiple times. If the item is optional, e.g. <code>[r/ROLE]…</code>, it can also be used zero times<br>
-     - e.g. <code>[r/ROLE]…</code> can be used as <code> </code> (i.e. 0 times), <code>r/exco</code>, <code>r/member r/exco</code> etc. <br><br>
-  - Parameters can be in any order.<br>
-     - e.g. if the command specifies <code>n/NAME p/PHONE_NUMBER</code>, <code>p/PHONE_NUMBER n/NAME</code> is also acceptable.<br><br>
-  - The parameter prefixes (e.g. <code>n/</code>) with leading spaces are considered restricted keywords, and may not be present within existing parameters. However, for some parameters, using it within the parameter without a leading space (e.g. `n/a` within `ROLE`) is allowed
+* Words in <code>UPPER_CASE</code> are the parameters to be supplied by the user.<br>
+  * e.g. in <code>add n/NAME</code>, <code>NAME</code> is a parameter which can be used as <code>add n/John Doe</code>.<br><br>
+* Items in square brackets are optional.<br>
+  * e.g <code>n/NAME [t/TAG]</code> can be used as <code>n/John Doe t/friend</code> or as <code>n/John Doe</code>.<br><br>
+* Items in square brackets are optional.<br>
+  * e.g <code>n/NAME [t/TAG]</code> can be used as <code>n/John Doe t/friend</code> or as <code>n/John Doe</code>.<br><br>
+* Items with <code>…</code> after them can be used multiple times. If the item is optional, e.g. <code>[r/ROLE]…</code>, it can also be used zero times<br>
+  * e.g. <code>[r/ROLE]…</code> can be used as <code> </code> (i.e. 0 times), <code>r/exco</code>, <code>r/member r/exco</code> etc. <br><br>
+* Parameters can be in any order.<br>
+  * e.g. if the command specifies <code>n/NAME p/PHONE_NUMBER</code>, <code>p/PHONE_NUMBER n/NAME</code> is also acceptable.<br><br>
+* The parameter prefixes (e.g. <code>n/</code>) with leading spaces are considered restricted keywords, and may not be present within existing parameters. However, for some parameters, using it within the parameter without a leading space (e.g. `n/a` within `ROLE`) is allowed
 </details>
 
 <div markdown="span" class="alert alert-warning">:exclamation: **Caution:**<br/>

diff --git a/docs/index.md b/docs/index.md
@@ -6,7 +6,7 @@ title: CCAConnect
 [![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2425S1-CS2103T-F11-2/tp/actions)
 [![codecov](https://codecov.io/gh/AY2425S1-CS2103T-F11-2/tp/graph/badge.svg?token=59BYKYL6CJ)](https://codecov.io/gh/AY2425S1-CS2103T-F11-2/tp)
 
-![Ui](images/mockup.png)
+![Ui](images/Ui.png)
 
 **CCAConnect assists CCA leaders in NUS in managing and collating relevant CCA personnel’s contact details.**
 While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).