final

build.gradle

@@ -94,26 +94,23 @@ dependencies {
     testImplementation 'org.testfx:openjfx-monocle:jdk-11+26'
 }
 
-test {
-    useJUnitPlatform()
-    testLogging {
-        exceptionFormat = 'full'
-    }
-    testLogging.showStandardStreams = true
-    testLogging {
-        events "passed", "skipped", "failed"
-    }
-
-    systemProperty 'java.awt.headless', 'true'
-    systemProperty 'testfx.robot', 'glass'
-    systemProperty 'testfx.headless', 'true' 
-    systemProperty 'prism.order', 'sw'
-    systemProperty 'prism.text', 't2k'
-    systemProperty 'testfx.setup.timeout', '2500'
-
-
-
-}
+//test {
+//    useJUnitPlatform()
+//    testLogging {
+//        exceptionFormat = 'full'
+//    }
+//    testLogging.showStandardStreams = true
+//    testLogging {
+//        events "passed", "skipped", "failed"
+//    }
+//
+//    systemProperty 'java.awt.headless', 'true'
+//    systemProperty 'testfx.robot', 'glass'
+//    systemProperty 'testfx.headless', 'true'
+//    systemProperty 'prism.order', 'sw'
+//    systemProperty 'prism.text', 't2k'
+//    systemProperty 'testfx.setup.timeout', '2500'
+//}
 
 asciidoctor {
     backends 'html5'

docs/DevOps.adoc

@@ -20,22 +20,25 @@ We use Gradle to automate builds of AlgoSenpai Adventures.
 
 == Continuous Integration
 
-We use https://travis-ci.org/[Travis CI] to perform _Continuous Integration_ on our projects.
+We use https://travis-ci.org/[Travis CI] and https://www.appveyor.com/[AppVeyor] to perform _Continuous Integration_ on our projects.
 
 == Coverage Reporting
 
-We use https://coveralls.io/[Coveralls] to track the code coverage of our projects.
+We use https://coveralls.io/[Coveralls] and _Jacoco_ to track the code coverage of our projects.
 
 == Documentation Previews
 
-When a pull request has changes to asciidoc files, you can use https://www.netlify.com/[Netlify] to see a preview of how the HTML version of those asciidoc files will look like when the pull request is merged.
+When a pull request has changes to the asciidoc files, https://www.netlify.com/[Netlify] is used to preview the HTML version
+of the modified asciidoc files.
 
 == Making a Release
 
 Here are the steps to create a new release.
 
 .  Update the version number in the issue tracker.
-.  Generate a JAR file <<UsingGradle#creating-the-jar-file, using Gradle>>.
+.  Generate a JAR file using Gradle by running the `gradle build` command.
+.  The JAR file can then be found in the `build/libs` folder.
+.  Rename the JAR file to include the version number e.g `AlgoSenpaiAdventures-v1.0`
 .  Tag the repo with the version number. e.g. `v1.0`
 .  https://help.github.com/articles/creating-releases/[Create a new release using GitHub] and upload the JAR file you created.
 

docs/DeveloperGuide.adoc

@@ -28,7 +28,11 @@ Refer to the guide <<SettingUp#, here>>.
 .Architecture Diagram
 image::ArchitectureDiagram.png[]
 
-The *_Architecture Diagram_* given above explains the high-level design of the application. Given below is a quick overview of each component.
+The *_Architecture Diagram_* given above explains the high-level design of AlgSenpai Adventures.
+AlgoSenpai Adventures has an event-driven architecture. We used a Modified Model-View-Controller (MVC) design pattern
+combined with the Command design pattern to create AlgoSenpai Adventures.
+
+Given below is a quick overview of each component.
 
 
 `Main` has two classes called link:https://github.com/AY1920S1-CS2113T-T09-3/main/blob/master/src/main/java/com/algosenpai/app/Launcher.java[`Launcher`]
@@ -44,18 +48,10 @@ The rest of the App consists of four components.
 
 * <<Design-Ui,*`Ui`*>>: The UI of the App.
 * <<Design-Logic,*`Logic`*>>: The command executor and the question generator.
-* <<Design-Model,*`Stats`*>>: Holds the relevant user statistics and settings in memory.
+* <<Design-Model,*`Stats`*>>: Holds the relevant user statistics and settings in the application.
 * <<Design-Storage,*`Storage`*>>: Reads data from, and writes data to, the hard disk.
 
 
-[discrete]
-==== How the architecture components interact with each other
-
-The _Sequence Diagram_ below shows how the components interact with each other for the scenario where the user enters the command `lecture sorting`.
-
-.Component interactions for `help` command
-image::SequenceDiagram.png[]
-
 The sections below give more details of each component.
 
 [[Design-Ui]]
@@ -64,15 +60,20 @@ The sections below give more details of each component.
 .Structure of the UI Component
 image::UiClassDiagram.png[]
 
-*API* : link:https://github.com/AY1920S1-CS2113T-T09-3/main/blob/master/src/main/java/com/algosenpai/app/ui/Ui.java[`Ui.java`]
+*Class* : link:https://github.com/AY1920S1-CS2113T-T09-3/main/blob/master/src/main/java/com/algosenpai/app/ui/Ui.java[`Ui.java`]
 
-The UI consists of a `MainWindow` that is made up of parts e.g.`DialogBox`, `DialogBoxUser`.
+The *_view_* component of the Ui consists of a `MainWindow` that is composed of three parts; `DialogBox`, `DialogBoxUser` and `StatusBox`.
 
-The `UI` component uses JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the link:https://github.com/AY1920S1-CS2113T-T09-3/main/blob/master/src/main/java/com/algosenpai/app/ui/Ui.java[`MainWindow`] is specified in link:https://github.com/AY1920S1-CS2113T-T09-3/main/blob/master/src/main/resources/view/MainWindow.fxml[`MainWindow.fxml`]
+The `UI` component uses the JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the
+`src/main/resources/view` folder. For example, the layout of the `MainWindow` is specified in link:https://github.com/AY1920S1-CS2113T-T09-3/main/blob/master/src/main/resources/view/MainWindow.fxml[`MainWindow.fxml`]
 
-The `UI` component,
+The `Ui.java` class is the controller class for the `.fxml` files. It handles any commands or input that the user has typed
+on the GUI which then passes it on to the `Logic` component to be parsed and executed.
 
-* Executes user commands using the `Logic` component.
+The `MusicController` class handles the playing of the background music as the application is run.
+
+The `AnimationTimerController` class measures how much time the user is idle (e.g not typing any commands or scrolling)
+as the application is run.
 
 [[Design-Logic]]
 === Logic component
@@ -81,30 +82,21 @@ The `UI` component,
 .Structure of the Logic Component
 image::LogicClassDiagram.png[]
 
-*API* :
+*Class* :
 link:https://github.com/AY1920S1-CS2113T-T09-3/main/blob/master/src/main/java/com/algosenpai/app/logic/Logic.java[`Logic.java`]
 
 .  `Logic` uses the `Parser` class to parse the user command.
-.  This results in a `Command` object which is executed by the `Logic`.
+.  This results in a `XYZCommand` object which is executed by the `Logic`.
 .  The command execution will result in the `Ui` to generate a `DialogBox` on the screen.
 .  The quiz is generated by the `QuizGenerator` using the `Chapter` classes in the `chapters` package.
+.  The lecture slides are generated by the `LectureGenerator` using the `Chapter` classes in the `chapters` package.
 
-//Given below is the Sequence Diagram for interactions within the `Logic` component for the `executeCommand("help")` API call.
-//
-//.Interactions Inside the Logic Component for the `help` Command
-//image::DeleteSequenceDiagram.png[]
-
-==== Parser Component
 
-When the user inputs a command, the command will be parsed through by the parser class, checking for the validity of the command by comparing it with the enum of commands.
-
-. If valid, the command will be split by the spaces in between them and stored into an arraylist. (e.g. `select 3` will be split into {select, 3})
-    - The logic class will then call for the first string in the arraylist, in which it will be used to determine which command to call for next.
-. If invalid, the InvalidCommand class will be called for. In the InvalidCommand class, the invalid command entered by the user will be compared to the enum of commands,
-thus returning the closest possible command, if any, to whatever was entered by the user. `OOPS!!! Error occurred. Please input a valid command. Did you mean... <command>`
-Else, the user will be notified to input a valid command: `OOPS!!! Error occurred. Please input a valid command. Enter 'menu' to view our list of commands and 'menu COMMAND' to find out how to use them!`.
+[discrete]
+==== How the architecture components interact with each other
 
-image::ParserandCommandClassDiagram.png[]
+Below are some of the features explained in detail which can give an overview of how the different components interact with
+each other
 
 ==== Lecture Component
 

docs/Documentation.adoc

@@ -25,80 +25,21 @@ You can download the AsciiDoc plugin for IntelliJ, which allows you to preview t
 == Editing Diagrams
 
 We used `draw.io` to create and update the UML diagrams in the developer guide. The `.drawio` files can be found
-in the `diagrams` folder.
+in the `docs/diagrams` folder.
 
 == Publishing Documentation
 
-See <<UsingTravis#deploying-github-pages, UsingTravis.adoc>> to learn how to deploy GitHub Pages using Travis.
+We publish our documentation to this website https://algosenpaiadventures.netlify.com/[AlgoSenpai Adventures]
+using Netlify.
 
 == Converting Documentation to PDF format
 
-We use https://www.google.com/chrome/browser/desktop/[Google Chrome] for converting documentation to PDF format, as Chrome's PDF engine preserves hyperlinks used in webpages.
+We use https://www.google.com/chrome/browser/desktop/[Google Chrome] for converting documentation to PDF format,
+as Chrome's PDF engine preserves the hyperlinks in the documents.
 
 Here are the steps to convert the project documentation files to PDF format.
 
-.  Follow the instructions in <<UsingGradle#rendering-asciidoc-files, UsingGradle.adoc>> to convert the AsciiDoc files in the `docs/` directory to HTML format.
+.  Open a console and type in `gradle asciidoctor` to convert the AsciiDoc files in the `docs/` directory to HTML format.
 .  Go to your generated HTML files in the `build/docs` folder, right click on them and select `Open with` -> `Google Chrome`.
 .  Within Chrome, click on the `Print` option in Chrome's menu.
-.  Set the destination to `Save as PDF`, then click `Save` to save a copy of the file in PDF format. For best results, use the settings indicated in the screenshot below.
-
-.Saving documentation as PDF files in Chrome
-image::chrome_save_as_pdf.png[width="300"]
-
-[[Docs-SiteWideDocSettings]]
-== Site-wide Documentation Settings
-
-The link:{repoURL}/build.gradle[`build.gradle`] file specifies some project-specific https://asciidoctor.org/docs/user-manual/#attributes[asciidoc attributes] which affects how all documentation files within this project are rendered.
-
-[TIP]
-Attributes left unset in the `build.gradle` file will use their *default value*, if any.
-
-[cols="1,2a,1", options="header"]
-.List of site-wide attributes
-|===
-|Attribute name |Description |Default value
-
-|`site-name`
-|The name of the website.
-If set, the name will be displayed near the top of the page.
-|_not set_
-
-|`site-githuburl`
-|URL to the site's repository on https://github.com[GitHub].
-Setting this will add a "View on GitHub" link in the navigation bar.
-|_not set_
-
-|===
-
-[[Docs-PerFileDocSettings]]
-== Per-file Documentation Settings
-
-Each `.adoc` file may also specify some file-specific https://asciidoctor.org/docs/user-manual/#attributes[asciidoc attributes] which affects how the file is rendered.
-
-Asciidoctor's https://asciidoctor.org/docs/user-manual/#builtin-attributes[built-in attributes] may be specified and used as well.
-
-[cols="1,2a,1", options="header"]
-.List of per-file attributes, excluding Asciidoctor's built-in attributes
-|===
-|Attribute name |Description |Default value
-
-|`site-section`
-|Site section that the document belongs to.
-This will cause the associated item in the navigation bar to be highlighted.
-One of: `UserGuide`, `DeveloperGuide`, `AboutUs`, `ContactUs`
-
-|_not set_
-
-|`no-site-header`
-|Set this attribute to remove the site navigation bar.
-|_not set_
-
-|===
-
-== Site Template
-
-The files in link:{repoURL}/docs/stylesheets[`docs/stylesheets`] are the https://developer.mozilla.org/en-US/docs/Web/CSS[CSS stylesheets] of the site.
-You can modify them to change some properties of the site's design.
-
-The files in link:{repoURL}/docs/templates[`docs/templates`] controls the rendering of `.adoc` files into HTML5.
-These template files are written in a mixture of https://www.ruby-lang.org[Ruby] and http://slim-lang.com[Slim].
+.  Set the destination to `Save as PDF`, then click `Save` to save a copy of the file in PDF format.

docs/SettingUp.adoc

@@ -53,15 +53,14 @@ This project follows https://github.com/oss-generic/process/blob/master/docs/Cod
 * For `Class count to use import with '\*'` and `Names count to use static import with '*'`: Set to `999` to prevent IntelliJ from contracting the import statements
 * For `Import Layout`: The order is `import static all other imports`, `import java.\*`, `import javax.*`, `import org.\*`, `import com.*`, `import all other imports`. Add a `<blank line>` between each `import`
 
-Optionally, you can follow the <<UsingCheckstyle#, UsingCheckstyle.adoc>> document to configure Intellij to check style-compliance as you write code.
 
 === Updating documentation to match your fork
 
 After forking the repo, the documentation will still have the AY1920S1-CS2113T-T09-3 branding and refer to the `AY1920S1-CS2113T-T09-3/main` repo.
 
 If you plan to develop this fork as a separate product (i.e. instead of contributing to `AY1920S1-CS2113T-T09-3/main`), you should do the following:
 
-. Configure the <<Documentation#Docs-SiteWideDocSettings, site-wide documentation settings>> in link:{repoURL}/build.gradle[`build.gradle`], such as the `site-name`, to suit your own project.
+. Configure the site-wide documentation settings in link:{repoURL}/build.gradle[`build.gradle`], such as the `site-name`, to suit your own project.
 
 . Replace the URL in the attribute `repoURL` in link:{repoURL}/docs/DeveloperGuide.adoc[`DeveloperGuide.adoc`] and link:{repoURL}/docs/UserGuide.adoc[`UserGuide.adoc`] with the URL of your fork.
 

docs/UserGuide.adoc

@@ -253,19 +253,15 @@ image::postundo.png[width=""650"]
 
 === Provides questions for improvement : `help`
 
-This command provides a suggestion of problems (targeted at respective chapters) that you may wish to attempt to brush up on weaker concepts +
+This command provides a suggestion of problems (targeted at respective chapters) that you may wish to attempt to apply the
+concepts you have learnt in the application to solve an algorithmic problem. The problems that are recommended are based
+on your proficiency level so do not worry if you think that the questions might be too hard for you! +
 Format : `help CHAPTER` +
 
 ====
 Example : +
 `help sorting` will list a few problems from Kattis that the user can attempt to increase their
-understanding of the chapter selected.
-=====
-*Expected outcome*
-
-image::helpsorting.png[width="650"]
-
-=====
+understanding of the chapter selected, the problems recommended will be tailored to their level of understanding.
 ====
 
 === Print questions or user information : `print`