Educator's User Guide - Orbital-Knewbie/Knewbie GitHub Wiki

1. Introduction
2. Quick Start
3. Features
    3.1. Reset Password
    3.2. Classes
        3.2.1. Creating A Class
        3.2.2. Creating A Quiz
        3.2.3. Leaderboard/Progress Report
        3.2.4. Forum
        3.2.5. Edit Participants List
        3.2.6. Change Class Code
        3.2.7. Delete Class
    3.3. Profile Customization
        3.3.1. Profile Settings
        3.3.2. Account Settings
4. Frequently Asked Questions (FAQ)

Knewbie is an educational platform that provides tailored content to suit the individual's learning ability. Through the usage of our machine learning algorithm, students will be recommended content based on their current abilities to ensure that they progress at a steady rate and are not exposed to content which they are unable to do from the get go. Hence, this will provide motivation for students where they will be able to celebrate their small successes before gradually, attempting tougher challenges. Read on to find out how to use Knewbie.

1. Access the Knewbie website here.

2. Click on register to create a new account. Please note, you will need an active email account. If you do not already have one, please create an email before continuing.

3. As an Educator, remember to switch your view to the Educator registration form.

4. Enter your FIRST NAME, LAST NAME, email, password and click on the register button. Please note, by clicking on the register button, you would have agreed to our terms and conditions as listed [here]. (Not up yet)

5. If you have followed the instructions correctly, you will receive a verification link sent to the email address you registered the account with.

6. Log in to the email and click on the link to verify your account.

6. You can now successfully log in using your email and password to access all the features available on our platform!

        1. If you have forgotten your password, or want to change it, you can do so through this link.

        2. To change your password input the email address you created your account with.

        3. A link will be sent your email address. This link will only be valid for 10 minutes.
            If the link expired, you will have to request for a new one.

        4. Log in to your email account and click on the link.

        5. You will be taken to a page to change your password.

        1. When you have logged in to your acocunt, you will be able to view all your create classes from your dashboard.

        2. When you first begin, you will not have any classes.

            1. To create a class, scroll down to the bottom of your dashboard, or click on create under the dashboard.

            2. Enter a class name under the 'Create A Class' heading and click on the create button.

            3. A unique class code and passcode will be displayed. Share both information with the students you would like to participate in the class.

            1. Similarly to creating a class, you can create a quiz which can be assigned to various classes which is under your purview.

            2. Enter a class name under the 'Create A Class' heading and click on the create button.

            3. You will be taken to a new page to create the questions in your quiz.

            4. Currently, we only support MCQs. Any question you submit will be stored in our database and may appear in our tailored content.

            5. Input all the relevant fields, add an image if required and click on 'Save and add a new question'.

            6. If this is the last question in the quiz, click on 'Save and complete quiz'.

            7. Upon successful creation, you will be redirected to a page where you can preview your quiz and make relevant changes if needed.

            8. On the same page, you are able to assign the quiz to the classes you have as well or preview your quiz to make any changes.

            9. The topmost delete button will delete the entire quiz.

            10. The rest of the delete and edit buttons are for the respective questions.

            1. You will be able to view the individual progress report of all the students in your class. This includes the scores from quizzes attempted within and outtside of the class.

            2. The leaderboard is sorted based on overall proficiency.

            1. Every class comes with a Forum.

            2. You are free to use the forum to post announcements, instructions, and any other message you deem to be necessary.

            3. The main forum page will display the timestamp of the last post the number of posts as well as the title of the threads.

            4. Students will be able to post a new threads and reply to clarify doubts.

            5. As an educator and class creator, you have the right to delete any thread or post you deem inappropriate.

            6. To create a new thread, you have to click on the 'Create A New Thread' button near the top of the page.

            7. You will be taken to a new page where you need to input the title of the thread and the message.

            8. Clicking on post will make your post live.

            9. To view the content of a thread from the forum, you have to click on the thread title.

            10. You will be able to view the message along with all the other replies.

            11. You will also be able to post a reply, or edit your posts.

            1. As an educator, you can edit the participants list.

            2. You can manually add or remove participants.

            1. As an educator, you can request to change the class code.

            2. Use this feature sparingly and only if you suspect that your class has been encroached.

            3. To change the class code, just click on 'Change Class Code' which can be found on the class' sidebar.

            1. As an educator, you can delete the class.

            2. Use this feature sparingly and only if you are sure you do not need the class any longer.

            3. This action is irrevocable.

            4. To delete the class, just click on 'Delete Class' which can be found on the class' sidebar.

            5. You will be redirected and asked to input your class code which could be found on the sidebar of your class.

            6. Upon confirmation of the request, all information associated with the class will be deleted.

            1. You will be able to change certain features from your profile.

            2. When logged in, you can access the settings page from the sidebar directly from your various classes or your dashboard.

            3. In the default settings page, you can make changes to your first name, last name, profile picture (avatar). Click 'SAVE'.

            5. The account tab is where you can change your password or email associated with your Knewbie Account.

            1. It is also where you can deactivate your account. This action is irrevocable.

            2. Clicking on it will bring you to a page where you would need to input your email to confirm deactivation of your account.

            3. Upon entering your email, a link will be sent to the email you enterd.

            4. The email will contain a link to confirm your deactivation. The link will last for 10 minutes.

            5. Your account will officially be deactivated upon clicking on the link.

1. You can access the list of FAQ through the link at the footer (bottom of every page), the navigation bar, or through this link.

2. If you have a question, issue or feedback not listed here, please do not hesitate to contact us. Similarly to the FAQ page, you can access the contact us page either through the link at the footer, the navigation bar, or through this link.