Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a basic tutorial #1

Open
aaron97neu opened this issue Nov 9, 2018 · 4 comments
Open

Add a basic tutorial #1

aaron97neu opened this issue Nov 9, 2018 · 4 comments
Assignees
Labels
enhancement New feature or request

Comments

@aaron97neu
Copy link
Member

It was suggested that a potential enhancement to LIMO would be adding a tutorial. Some discussion needs to be had about whether this should be a video tutorial or a UI based tutorial built into the website

@aaron97neu aaron97neu added the enhancement New feature or request label Nov 9, 2018
@pjuneja81095
Copy link
Member

I think it wouldn't hurt to do both. Once we discuss this amongst ourselves and with professor Aref, I can get cranking on the video and have that done and ready to be put up before the end of this semester.

@pjuneja81095 pjuneja81095 self-assigned this Nov 9, 2018
@aaron97neu
Copy link
Member Author

That would be great. Do we have an example of a good UI based tutorial? I have looked around briefly, but I have not seen much

@pjuneja81095
Copy link
Member

Here is a tutorial, with two different options (try-it-yourself or view only):
https://www.iorad.com/player/158243/LIMO-tutorial#trysteps-1

What do you guys think? Would something like this work?

@aaron97neu
Copy link
Member Author

I really liked it, but I think there are a few things that I think we should consider changing

  1. 36% (9/25 of the steps) of the tutorial was about creating an account/logging in. I personally did not create an account until a few weeks ago because I did not need one. This is not a critical function of the program and should be more of a footnote at the end ("Oh and here are some miscellaneous features, a signup button if you want to save your programs and a small box that gives detailed explanations of the functions"). This most important features of the program are the map screen and the coding area, and those should be addressed first, and foremost.

  2. I noticed that after inputting my information and "Logging in", your information was displayed. Not only in the "Welcome Piyush" but in the text fields for the signup if I messed those up. This could cause confusion. If we can change those to something generic or remove them, that might help, though I am unsure how to go about that. Working on point 1 might help as well.

  3. I had a few issues where the tutorial seemed to bug out, but my browser has been having issues lately, so it might just be me

  4. On my screen, the right half looked cut off, could this be because you recorded the tutorial on a smaller screen? Not a huge deal, just a nitpick
    image

These are a bunch of small things, I do want to stress that I really like it and it is miles ahead of anything we have right now. Additionally, I really liked how you can export it as a pdf.

Can it be natively implemented into our website?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants