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

[Cub] Add a tutorial #43

Open
mmaismma opened this issue Oct 20, 2020 · 7 comments
Open

[Cub] Add a tutorial #43

mmaismma opened this issue Oct 20, 2020 · 7 comments
Labels
enhancement New feature or request

Comments

@mmaismma
Copy link
Member

mmaismma commented Oct 20, 2020

Description

Cub's Contraption has a very simple and self-explanatory UI. But it would be fashionable to have a tutorial thing.

Possible solution(s)

Imagine a tutorial button on the webpage. The user clicks the button. A box shows up in the center of the screen. It shows an animation of step 1 i.e. "Click on the Choose Background button". The next step button (❯) appears when the animation ends. The same occurs for the other steps.

Additional context

Even better if all animations are done by CSS not uploaded videos.

@mmaismma mmaismma added the enhancement New feature or request label Oct 20, 2020
@mmaismma mmaismma added this to the v1.0.2 Cub's Contraption milestone Oct 20, 2020
@mmaismma
Copy link
Member Author

Even better if showing tutorial on pressing the F1 key.

@shubhammehra4
Copy link

Hey, can I take on this?

@mmaismma
Copy link
Member Author

@shubhammehra4 Why not? This is a pretty big task, feel free to contact me in case. Send a confirmatory message if you wish to work on this issue.

@shubhammehra4
Copy link

I'll be using Into.js
Can you please give me the detail of all the steps that I need to include in the tutorial

@mmaismma
Copy link
Member Author

Sorry to inform you, but we do not allow the usage of libraries yet. If you wish to work with plain JS, inform me.

@shubhammehra4
Copy link

Is it okay if I use Bootstrap CSS & JS?

@mmaismma
Copy link
Member Author

No, as it is also written in our contributing guidelines, we only allow usage of plain languages (something you can write without the need of linking any external file).

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