Merge branch 'AY2122S1-CS2103T-W08-1:master' into v1.2_RefactorCommands

HalphasX · Oct 11, 2021 · 019a4e0 · 019a4e0
2 parents b35970e + 6fbeca4
commit 019a4e0
Show file tree

Hide file tree

Showing 40 changed files with 206 additions and 238 deletions.
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -1,5 +1,6 @@
 ---
-layout: page title: About Us
+layout: page
+title: About Us
 ---
 
 We are a team based in the [School of Computing, National University of Singapore](http://www.comp.nus.edu.sg).
@@ -32,7 +33,7 @@ You can reach us at the email `e0588244.nus.edu.sg`
 
 <img src="images/eltongohjh.png" width="200px">
 
-[[github](http://github.com/eltongohjh)] 
+[[github](http://github.com/eltongohjh)]
 [[portfolio](team/eltongohjh.md)]
 
 * Role: Developer
@@ -50,7 +51,7 @@ You can reach us at the email `e0588244.nus.edu.sg`
 
 ### Jonathan Kwok
 
-<img src="images/halphasx.jpg" width="200px">
+<img src="2103t/tp/docs/images/halphasx.png" width="200px">
 
 [[github](http://github.com/HalphasX)]
 [[portfolio](team/halphasx.md)]

diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -1,5 +1,6 @@
 ---
-layout: page title: Configuration guide
+layout: page
+title: Configuration guide
 ---
 
 Certain properties of the application can be controlled (e.g user preferences file location, logging level) through the

diff --git a/docs/DevOps.md b/docs/DevOps.md
@@ -1,5 +1,6 @@
 ---
-layout: page title: DevOps guide
+layout: page
+title: DevOps guide
 ---
 
 * Table of Contents {:toc}

diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/Documentation.md b/docs/Documentation.md
@@ -1,5 +1,6 @@
 ---
-layout: page title: Documentation guide
+layout: page
+title: Documentation guide
 ---
 
 **Setting up and maintaining the project website:**

diff --git a/docs/Logging.md b/docs/Logging.md
@@ -1,5 +1,6 @@
 ---
-layout: page title: Logging guide
+layout: page
+title: Logging guide
 ---
 
 * We are using `java.util.logging` package for logging.

diff --git a/docs/SettingUp.md b/docs/SettingUp.md
@@ -1,5 +1,6 @@
 ---
-layout: page title: Setting up and getting started
+layout: page
+title: Setting up and getting started
 ---
 
 * Table of Contents {:toc}
@@ -54,11 +55,9 @@ If you plan to use Intellij IDEA (highly recommended):
 1. **Learn the design**
 
    When you are ready to start coding, we recommend that you get some sense of the overall design by reading
-   about [AddressBook’s architecture](DeveloperGuide.md#architecture).
+   about [Notor’s architecture](DeveloperGuide.md#architecture).
 
 1. **Do the tutorials**
    These tutorials will help you get acquainted with the codebase.
 
     * [Tracing code](tutorials/TracingCode.md)
-    * [Adding a new command](tutorials/AddRemark.md)
-    * [Removing fields](tutorials/RemovingFields.md)
diff --git a/docs/Testing.md b/docs/Testing.md
@@ -1,5 +1,6 @@
 ---
-layout: page title: Testing guide
+layout: page
+title: Testing guide
 ---
 
 * Table of Contents {:toc}

diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -1,10 +1,9 @@
 ---
-layout: page title: User Guide
+layout: page
+title: User Guide
 ---
 
-AddressBook Level 3 (AB3) is a **desktop app for managing contacts, optimized for use via a Command Line Interface** (
-CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, AB3 can get your contact
-management tasks done faster than traditional GUI apps.
+Notor is a desktop app for mentors to keep tabs on their mentees, **optimized for use via a Command Line Interface** (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Notor allows you to take notes quickly and efficiently, and keeping them in an easy to reference format, which is vital if you are taking notes during meetings with mentees.
 
 * Table of Contents {:toc}
 
@@ -16,7 +15,7 @@ management tasks done faster than traditional GUI apps.
 
 2. Download the latest `notor.jar`.
 
-3. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.
+3. Copy the file to the folder you want to use as the _home folder_ for your Notor.
 
 4. Double-click the file to start the app. The GUI similar to the below should appear in a few seconds. Note how the app
    contains some sample data.<br>
@@ -79,7 +78,7 @@ Format: `help`
 
 #### Clearing all entries : `clear`
 
-Clears all entries from the address book.
+Clears all entries from Notor.
 
 Format: `clear`
 
@@ -374,7 +373,7 @@ Notor data are saved as a JSON file `[JAR file location]/data/Notor.json`. Advan
 directly by editing that data file.
 
 <div markdown="span" class="alert alert-warning">:exclamation: **Caution:**
-If your changes to the data file makes its format invalid, AddressBook will discard all data and start with an empty data file at the next run.
+If your changes to the data file makes its format invalid, Notor will discard all data and start with an empty data file at the next run.
 </div>
 
 ### Archiving data files `[coming in v2.0]`
@@ -387,7 +386,7 @@ _Details coming soon ..._
 
 **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.
+the data of your previous Notor home folder.
 
 --------------------------------------------------------------------------------------------------------------------
 
@@ -412,8 +411,7 @@ Action | Format |  Advanced Format
 **Delete** | `group g:GROUP_NAME /delete g:GROUP_NAME` | `g g:GROUP_NAME /d g:GROUP_NAME`
 **Note** | `group g:GROUP_NAME /note` | `g g:GROUP_NAME /n g:GROUP_NAME`
 **Create subgroup** | `group GROUP_NAME /create sg:SUB_GROUP_NAME` | `g g:GROUP_NAME /c sg:SUB_GROUP_NAME`
-**Edit
-subgroup** | `group GROUP_NAME:SUB_GROUP_NAME /edit sg:SUB_GROUP_NAME` | `g g:GROUP_NAME:SUB_GROUP_NAME /e sg:SUB_GROUP_NAME`
+**Edit subgroup** | `group GROUP_NAME:SUB_GROUP_NAME /edit sg:SUB_GROUP_NAME` | `g g:GROUP_NAME:SUB_GROUP_NAME /e sg:SUB_GROUP_NAME`
 **Delete subgroup** | `group GROUP_NAME /delete sg:SUB_GROUP_NAME` | `g GROUP_NAME /d sg:SUB_GROUP_NAME`
 **Note subgroup** |  `group GROUP_NAME /note sg:SUB_GROUP_NAME` | `g GROUP_NAME /n sg:SUB_GROUP_NAME`
 

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,4 +1,4 @@
-title: "AB-3"
+title: "Notor"
 theme: minima
 
 header_pages:
@@ -8,7 +8,7 @@ header_pages:
 
 markdown: kramdown
 
-repository: "se-edu/addressbook-level3"
+repository: "AY2122S1-CS2103T-W08-1/tp"
 github_icon: "images/github-icon.png"
 
 plugins:

diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss
@@ -1,16 +1,10 @@
 ---
-
-#
-Only the main Sass file needs front matter
-
-(
-the dashes are enough
-
-)
+# Only the main Sass file needs front matter (the dashes are enough)
 ---
 
-@import "minima/skins/{{ site.minima.skin | default: 'classic' }}",
-"minima/initialize";
+@import
+  "minima/skins/{{ site.minima.skin | default: 'classic' }}",
+  "minima/initialize";
 
 .icon {
   height: 21px;

diff --git a/docs/diagrams/BetterModelClassDiagram.puml b/docs/diagrams/BetterModelClassDiagram.puml
@@ -4,18 +4,21 @@ skinparam arrowThickness 1.1
 skinparam arrowColor MODEL_COLOR
 skinparam classBackgroundColor MODEL_COLOR
 
+'class Trie<T>
+'class "Trie<Tag>" as Trie_Tag_List
+
 AddressBook *-right-> "1" UniquePersonList
-AddressBook *-right-> "1" UniqueTagList
-UniqueTagList -[hidden]down- UniquePersonList
-UniqueTagList -[hidden]down- UniquePersonList
+AddressBook *-right-> "1" Trie
+Trie -[hidden]down- UniquePersonList
+Trie -[hidden]down- UniquePersonList
 
-UniqueTagList *-right-> "*" Tag
+Trie *-right-> "*" String
 UniquePersonList -right-> Person
 
-Person -up-> "*" Tag
+Person -up-> "*" String
 
 Person *--> Name
 Person *--> Phone
 Person *--> Email
-Person *--> Address
+Person *--> Note
 @enduml
diff --git a/docs/diagrams/ModelClassDiagram.puml b/docs/diagrams/ModelClassDiagram.puml
@@ -18,11 +18,11 @@ Class ReadOnlyUserPrefs
 
 Class UniquePersonList
 Class Person
-Class Address
 Class Email
 Class Name
 Class Phone
 Class Tag
+Class Note
 
 }
 
@@ -43,12 +43,10 @@ UniquePersonList --> "~* all" Person
 Person *--> Name
 Person *--> Phone
 Person *--> Email
-Person *--> Address
+Person *--> Note
 Person *--> "*" Tag
 
 Name -[hidden]right-> Phone
-Phone -[hidden]right-> Address
-Address -[hidden]right-> Email
 
 ModelManager -->"~* filtered" Person
 @enduml
diff --git a/docs/diagrams/StorageClassDiagram.puml b/docs/diagrams/StorageClassDiagram.puml
@@ -18,26 +18,37 @@ package "AddressBook Storage" #F4F6F6{
 Interface AddressBookStorage <<Interface>>
 Class JsonAddressBookStorage
 Class JsonSerializableAddressBook
-Class JsonAdaptedPerson
-Class JsonAdaptedTag
 }
 
+package "Archive Storage" #F4F6F6{
+Interface ArchiveStorage <<Interface>>
+Class JsonArchiveStorage
+Class JsonSerializableArchive
+}
+
+Class JsonAdaptedPerson
+Class JsonAdaptedTag
 }
 
 Class HiddenOutside #FFFFFF
 HiddenOutside ..> Storage
 
 StorageManager .up.|> Storage
-StorageManager -up-> "1" UserPrefsStorage
 StorageManager -up-> "1" AddressBookStorage
+StorageManager -up-> "1" ArchiveStorage
+StorageManager -up-> "1" UserPrefsStorage
 
-Storage -left-|> UserPrefsStorage
-Storage -right-|> AddressBookStorage
+Storage -left-|> AddressBookStorage
+Storage -left-|> ArchiveStorage
+Storage -right-|> UserPrefsStorage
 
-JsonUserPrefsStorage .up.|> UserPrefsStorage
 JsonAddressBookStorage .up.|> AddressBookStorage
+JsonArchiveStorage .up.|> ArchiveStorage
+JsonUserPrefsStorage .up.|> UserPrefsStorage
 JsonAddressBookStorage ..> JsonSerializableAddressBook
+JsonArchiveStorage ..> JsonSerializableArchive
 JsonSerializableAddressBook --> "*" JsonAdaptedPerson
+JsonSerializableArchive --> "*" JsonAdaptedPerson
 JsonAdaptedPerson --> "*" JsonAdaptedTag
 
 @enduml
diff --git a/docs/images/BetterModelClassDiagram.png b/docs/images/BetterModelClassDiagram.png
diff --git a/docs/images/ModelClassDiagram.png b/docs/images/ModelClassDiagram.png
diff --git a/docs/images/StorageClassDiagram.png b/docs/images/StorageClassDiagram.png
diff --git a/docs/images/add-remark/$Remark.png b/docs/images/add-remark/$Remark.png
diff --git a/docs/images/add-remark/CommandInterface.png b/docs/images/add-remark/CommandInterface.png
diff --git a/docs/images/add-remark/ContextMenu.png b/docs/images/add-remark/ContextMenu.png
diff --git a/docs/images/add-remark/CreateTest.png b/docs/images/add-remark/CreateTest.png
diff --git a/docs/images/add-remark/GradleRun.png b/docs/images/add-remark/GradleRun.png
diff --git a/docs/images/add-remark/ParserInterface.png b/docs/images/add-remark/ParserInterface.png
diff --git a/docs/images/add-remark/RemarkBound.png b/docs/images/add-remark/RemarkBound.png
diff --git a/docs/images/add-remark/RemarkComplete.png b/docs/images/add-remark/RemarkComplete.png
diff --git a/docs/images/add-remark/RemarkFailureOutput.png b/docs/images/add-remark/RemarkFailureOutput.png
diff --git a/docs/images/add-remark/RemarkHello.png b/docs/images/add-remark/RemarkHello.png
diff --git a/docs/images/add-remark/RemarkNotImplemented.png b/docs/images/add-remark/RemarkNotImplemented.png
diff --git a/docs/images/halphasx.jpg → docs/images/halphasx.png b/docs/images/halphasx.jpg → docs/images/halphasx.png
diff --git a/docs/images/remove/$address.png b/docs/images/remove/$address.png
diff --git a/docs/images/remove/SafeDeleteConflicts.png b/docs/images/remove/SafeDeleteConflicts.png
diff --git a/docs/images/remove/UnsafeDelete.png b/docs/images/remove/UnsafeDelete.png
diff --git a/docs/images/remove/UnsafeDeleteOnField.png b/docs/images/remove/UnsafeDeleteOnField.png
diff --git a/docs/index.md b/docs/index.md
@@ -1,18 +1,19 @@
 ---
-layout: page title: AddressBook Level-3
+layout: page
+title: Notor
 ---
 
-[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
+[![CI Status](https://github.com/AY2122S1-CS2103T-W08-1/tp/actions/workflows/gradle.yml/badge.svg)](https://github.com/AY2122S1-CS2103T-W08-1/tp/actions)
 [![codecov](https://codecov.io/gh/AY2122S1-CS2103T-W08-1/tp/branch/master/graph/badge.svg?token=2I1HSRYBDN)](https://codecov.io/gh/AY2122S1-CS2103T-W08-1/tp)
 
 ![Ui](images/Ui.png)
 
-**AddressBook is a desktop application for managing your contact details.** While it has a GUI, most of the user
+**Notor** aims to help **mentors** who wish to keep tabs on their mentees, by providing **a quick way to take notes and mantain records on their mentees**. While it has a GUI, most of the user
 interactions happen using a CLI (Command Line Interface).
 
-* If you are interested in using AddressBook, head over to the [_Quick Start_ section of the **User
+* If you are interested in using Notor, head over to the [_Quick Start_ section of the **User
   Guide**](UserGuide.html#quick-start).
-* If you are interested about developing AddressBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to
+* If you are interested about developing Notor, the [**Developer Guide**](DeveloperGuide.html) is a good place to
   start.
 
 **Acknowledgements**

diff --git a/docs/team/elroygohjy.md b/docs/team/elroygohjy.md
@@ -1,5 +1,6 @@
 ---
-layout: page title: Elroy's Project Portfolio Page
+layout: page
+title: Elroy's Project Portfolio Page
 ---
 
 ### Project: Notor

diff --git a/docs/team/eltongohjh.md b/docs/team/eltongohjh.md
@@ -1,5 +1,6 @@
 ---
-layout: page title: Elton's Project Portfolio Page
+layout: page
+title: Elton's Project Portfolio Page
 ---
 
 ### Project: Notor

diff --git a/docs/team/halphasx.md b/docs/team/halphasx.md
@@ -1,5 +1,6 @@
 ---
-layout: page title: Jonathan's Project Portfolio Page
+layout: page
+title: Jonathan's Project Portfolio Page
 ---
 
 ### Project: Notor

diff --git a/docs/team/johndoe.md b/docs/team/johndoe.md
@@ -1,5 +1,6 @@
 ---
-layout: page title: John Doe's Project Portfolio Page
+layout: page
+title: John Doe's Project Portfolio Page
 ---
 
 ### Project: AddressBook Level 3

diff --git a/docs/team/kaixin-hc.md b/docs/team/kaixin-hc.md
@@ -1,5 +1,6 @@
 ---
-layout: page title: Hannah's Project Portfolio Page
+layout: page
+title: Hannah's Project Portfolio Page
 ---
 
 ### Project: Notor
@@ -16,15 +17,13 @@ Given below are my contributions to the project.
 
 * **Project management**:
 
-
 * **Enhancements to existing features**:
 
 * **Documentation**:
-    * Readme
+    * ReadMe
     * Setting up AboutUs page + portfolios
 * **Community**:
 
 * **Tools**:
 
-
 * _{you can add/remove categories in the list above}_
diff --git a/docs/team/yukun99.md b/docs/team/yukun99.md
@@ -1,5 +1,6 @@
 ---
-layout: page title: Yukun's Project Portfolio Page
+layout: page
+title: Yukun's Project Portfolio Page
 ---
 
 ### Project: Notor