Skip to content

Commit

Permalink
Merge 3d32d7f into f441f1f
Browse files Browse the repository at this point in the history
  • Loading branch information
alxkohh committed Nov 10, 2019
2 parents f441f1f + 3d32d7f commit a2b22bb
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 21 deletions.
59 changes: 38 additions & 21 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,23 @@ By: `CS2103T-F14-1` Since: `Aug 2019` Licence: `MIT`

== Introduction

DukeAcademy is a coding practice platform that operates entirely on your local machine without the need for an internet
Duke Academy is a coding practice platform that operates entirely on your local machine without the need for an internet
connection. Whether you are revising for a test, practicing for a tech interview, or just coding for the sheer joy of
it, DukeAcademy gives you access to a wide range of programming problems from various categories. Easily find something
that suits your needs and interests and start honing your skills today!

DukeAcademy features a built-in list of problem sets and its very own text editor. Simply choose a problem statement
that catches your eye, load it up in the problem display panel and start coding away! DukeAcademy also features your
Duke Academy features a built-in list of problem sets and its very own text editor. Simply choose a problem statement
that catches your eye, load it up in the problem display panel and start coding away! Duke Academy also features your
very own profile page for you to immediately view all of your accomplishments at a glance. Your profile page also helps
you keep track of the problems that you have attempted and those you have bookmarked, so that you can get back to them
easily at a later time.

For educators, you can use DukeAcademy as a platform to administer your assignments or practice questions. If you have
For educators, you can use Duke Academy as a platform to administer your assignments or practice questions. If you have
questions of your own you would like to test your students, you can use the built-in question loader in DukeAcademy to
set your own questions and then distribute the updated _questionBank.json_ file to your students through your favourite
communication channels.

DukeAcademy is optimized for those who prefer to work with a CLI (Command Line Interface) while still enjoying the
Duke Academy is optimized for those who prefer to work with a CLI (Command Line Interface) while still enjoying the
benefits of a GUI (Graphical User Interface). If you are unfamiliar with using a CLI (which is an important skill for all
programmers), you can get used to it while working on your coding skills here in DukeAcademy!

Expand Down Expand Up @@ -75,7 +75,9 @@ The User Interfaces that are important for now:
+
This will be the field where you input all your commands. After you press the kbd:[Enter] button, your command will be executed.
+
e.g. typing *`showall`* and pressing kbd:[Enter] will display all the questions in the app.
e.g. typing *`showall`*, followed by pressing kbd:[Enter] will display all the questions in the app.
+
To find out about the commands available in Duke Academy, please visit <<Features>>.

2. *Result Box*
+
Expand All @@ -95,24 +97,30 @@ _Note: the index of a question is the number displayed next to its title._
+
image::questionindex.png[width="1000"]
+
. Refer to <<Features>> to view our full list of commands.

[[Overview]]
== Overview

The application is divided into 3 separate tabs, each one of them serving a specific purpose. You can toggle between the
different tabs by entering `tab` into the *CommandBox*.
different tabs by entering `tab` into the *Command Box*.

=== Home
The *Home* tab contains an introduction of the application along with a brief overview of your user profile.
The *Home* tab contains an introduction of the application, and more importantly, a *Personal Dashboard* for you to keep track of your progress made in Duke Academy.

image::homepage.png[width="1000"]

On the "Home" page, you can:
On the *Personal Dashboard* you can:

. See your completion percentage and current skill tier!
. See the percentage of questions you completed and your current skill tier.
+
Novice 0 - 29 % {nbsp} +
Apprentice 30 - 49 % {nbsp} +
Master 50 - 69 % {nbsp} +
Grandmaster 70 - 89 % {nbsp} +
Duke 90 - 100 %
+
. Keep track of the questions that you are currently attempting.
. View your bookmarked questions.
. Keep track of the questions that you bookmarked.

=== Questions
The *Questions* tab contains a list of all the available questions and also a window to view your problem statements.
Expand All @@ -134,13 +142,13 @@ The workspace is where you will work on the various questions.

image::workspace.png[width="1000"]

. *ProblemStatementDisplay*
. *Problem Statement Display*
+
Displays the question that you are currently attempting.

. *ProgramEvaluationDisplay*
. *Program Evaluation Panel*
+
This window displays the results after DukeAcademy has finished evaluating the correctness of your program.
This panel displays the correctness of your program when evaluated against the pre-defined list of test cases tied to the question you are solving.
. *Editor*
+
A built-in editor for you to write your code.
Expand Down Expand Up @@ -170,9 +178,18 @@ e.g. `browse [category]...` can be used as
`browse easy linkedlist hashtable recursion` (i.e. 4 entries), etc.
====

=== Access Homepage: `home`
=== Access Help Tab: `help`

Navigates to the *Help* Tab.

*Format:* `help`

image::help.png[width="1000"]


=== Access Home Tab: `home`

Navigates back to the *HomePage*.
Navigates to the *Home* Tab.

*Format:* `home`

Expand All @@ -191,26 +208,26 @@ image::listallquestions.png[width="1000"]
//end::showall[]
=== Adding bookmark: `bookmark`

Bookmarks a question by its id.
Bookmarks a specific question.

*Format:* `bookmark [id]`

****
* The id of a question can be found next to its title.
* The bookmarked question will appear in the list of bookmarked questions under the *Home* Tab.
* The bookmarked question will appear in the list of bookmarked questions located within your *Personal Dashboard*.
****

image::bookmark.png[width="1000"]

=== Removing bookmark: `deletebookmark`

Removes a bookmark from a question by its id.
Removes the bookmark from a specific question.

*Format:* `deletebookmark [id]`

****
* The id of a question can be found next to its title.
* The question with the bookmark removed will disappear from the list of bookmarked questions under the *Home* Tab.
* The question with the bookmark removed will disappear from the list of bookmarked questions located within your *Personal Dashboard*.
****

//tag::find[]
Expand Down
Binary file modified docs/images/userguide/help.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.

0 comments on commit a2b22bb

Please sign in to comment.