Merge pull request nus-cs2103-AY2122S1#75 from kaixin-hc/remove-AB3

Docs: Remove AB3 - Fix YAML Errors
HalphasX · Oct 9, 2021 · 6fbeca4 · 6fbeca4
2 parents d3be33a + b2a7285
commit 6fbeca4
Show file tree

Hide file tree

Showing 33 changed files with 36 additions and 39 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

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
@@ -1,5 +1,5 @@
 ---
-layout: page 
+layout: page
 title: Developer Guide
 ---
 

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,11 +1,9 @@
 ---
-layout: page 
+layout: page
 title: User Guide
 ---
 
-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.
+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}
 
@@ -413,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/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/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/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/img.png b/docs/img.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,5 @@
 ---
-layout: page 
+layout: page
 title: Elroy's Project Portfolio Page
 ---
 

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

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

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

diff --git a/docs/team/kaixin-hc.md b/docs/team/kaixin-hc.md
@@ -1,5 +1,5 @@
 ---
-layout: page 
+layout: page
 title: Hannah's Project Portfolio Page
 ---
 

diff --git a/docs/team/yukun99.md b/docs/team/yukun99.md
@@ -1,5 +1,5 @@
 ---
-layout: page 
+layout: page
 title: Yukun's Project Portfolio Page
 ---