diff --git a/docs/AboutUs.md b/docs/AboutUs.md index 1b0635b3a74..81ed39f047d 100644 --- 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` -[[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 index da8c5133b7e..fe118c75b24 100644 --- 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 index 61d9c7dfceb..03d7812d0da 100644 --- 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 index 8d3fb50f432..9bf333600f8 100644 --- 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 index 1c2dfdbea76..f44acbd4d56 100644 --- 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 index 638eecdeaf8..26cbbb7d981 100644 --- 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 index 62373bf6950..0dfce54a21d 100644 --- 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 index 011acfeda35..63ad1cc2c57 100644 --- 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 index c1c518515a9..08c91f87539 100644 --- 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 index 89c20b7c939..b88a6789278 100644 --- 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 deleted file mode 100644 index 959c634406d..00000000000 Binary files a/docs/images/add-remark/$Remark.png and /dev/null differ diff --git a/docs/images/add-remark/CommandInterface.png b/docs/images/add-remark/CommandInterface.png deleted file mode 100644 index b52e7811c52..00000000000 Binary files a/docs/images/add-remark/CommandInterface.png and /dev/null differ diff --git a/docs/images/add-remark/ContextMenu.png b/docs/images/add-remark/ContextMenu.png deleted file mode 100644 index 77536724e45..00000000000 Binary files a/docs/images/add-remark/ContextMenu.png and /dev/null differ diff --git a/docs/images/add-remark/CreateTest.png b/docs/images/add-remark/CreateTest.png deleted file mode 100644 index 6b7d6dcafec..00000000000 Binary files a/docs/images/add-remark/CreateTest.png and /dev/null differ diff --git a/docs/images/add-remark/GradleRun.png b/docs/images/add-remark/GradleRun.png deleted file mode 100644 index 281cc45f098..00000000000 Binary files a/docs/images/add-remark/GradleRun.png and /dev/null differ diff --git a/docs/images/add-remark/ParserInterface.png b/docs/images/add-remark/ParserInterface.png deleted file mode 100644 index 60c7892a534..00000000000 Binary files a/docs/images/add-remark/ParserInterface.png and /dev/null differ diff --git a/docs/images/add-remark/RemarkBound.png b/docs/images/add-remark/RemarkBound.png deleted file mode 100644 index d335382b286..00000000000 Binary files a/docs/images/add-remark/RemarkBound.png and /dev/null differ diff --git a/docs/images/add-remark/RemarkComplete.png b/docs/images/add-remark/RemarkComplete.png deleted file mode 100644 index 124ced2c752..00000000000 Binary files a/docs/images/add-remark/RemarkComplete.png and /dev/null differ diff --git a/docs/images/add-remark/RemarkFailureOutput.png b/docs/images/add-remark/RemarkFailureOutput.png deleted file mode 100644 index 351257ea332..00000000000 Binary files a/docs/images/add-remark/RemarkFailureOutput.png and /dev/null differ diff --git a/docs/images/add-remark/RemarkHello.png b/docs/images/add-remark/RemarkHello.png deleted file mode 100644 index aad48d02f8f..00000000000 Binary files a/docs/images/add-remark/RemarkHello.png and /dev/null differ diff --git a/docs/images/add-remark/RemarkNotImplemented.png b/docs/images/add-remark/RemarkNotImplemented.png deleted file mode 100644 index 1d187f39403..00000000000 Binary files a/docs/images/add-remark/RemarkNotImplemented.png and /dev/null differ diff --git a/docs/images/remove/$address.png b/docs/images/remove/$address.png deleted file mode 100644 index cf0434e0e83..00000000000 Binary files a/docs/images/remove/$address.png and /dev/null differ diff --git a/docs/images/remove/SafeDeleteConflicts.png b/docs/images/remove/SafeDeleteConflicts.png deleted file mode 100644 index 8f0abeffd4d..00000000000 Binary files a/docs/images/remove/SafeDeleteConflicts.png and /dev/null differ diff --git a/docs/images/remove/UnsafeDelete.png b/docs/images/remove/UnsafeDelete.png deleted file mode 100644 index 9e376d02a0c..00000000000 Binary files a/docs/images/remove/UnsafeDelete.png and /dev/null differ diff --git a/docs/images/remove/UnsafeDeleteOnField.png b/docs/images/remove/UnsafeDeleteOnField.png deleted file mode 100644 index 44d5bb0a442..00000000000 Binary files a/docs/images/remove/UnsafeDeleteOnField.png and /dev/null differ diff --git a/docs/img.png b/docs/img.png deleted file mode 100644 index da2f22ff8d9..00000000000 Binary files a/docs/img.png and /dev/null differ diff --git a/docs/index.md b/docs/index.md index c29f262d13e..c40b68fa325 100644 --- 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 index a110c1725fa..fd79d37186a 100644 --- 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 index 75e598f1664..fd45357ae59 100644 --- 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 index 8871fbff085..b9e8fe19c71 100644 --- 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 index 32040486cc6..918d8f91fa3 100644 --- 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 index 92c650322e5..8ee929f4245 100644 --- 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 index fc10cdf821a..9af32c21857 100644 --- a/docs/team/yukun99.md +++ b/docs/team/yukun99.md @@ -1,5 +1,5 @@ --- -layout: page +layout: page title: Yukun's Project Portfolio Page ---