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 better documentation #19

Open
Whip opened this issue Oct 26, 2015 · 2 comments
Open

Add better documentation #19

Whip opened this issue Oct 26, 2015 · 2 comments
Assignees
Milestone

Comments

@Whip
Copy link

Whip commented Oct 26, 2015

Amazing plugin but too bad a novice like me cannot use it. I'm having a lot of trouble trying to understand how to setup the plugin. Please write a better documentation and tutorials. You haven't mentioned once how to fully set up the plugin in steps.

I saw the code in your examples and they are way different from each other and some of the code is not mentioned in the docs, eg the way you're calling the function and using options. And You also never mentioned to include the css file either, I discovered that going through the examples. Please include those as well.

Thanks

@hellsan631
Copy link
Owner

Ah yea, your right.

Can you give me some perspective as to what's missing (other then the css and perhaps some setup?)

Should I outline each demo in the docs/wiki? Do I need to go through each setting in depth to show the differences, or does implimentation only (demo docs) work better?

I'm thinking that since this is a pretty big can of worms, I should use the wiki pages on github to do further documentation. Would this be alright?

@hellsan631 hellsan631 added this to the Version 1.0 milestone Oct 27, 2015
@hellsan631 hellsan631 self-assigned this Oct 27, 2015
@Whip
Copy link
Author

Whip commented Oct 28, 2015

Well I'm not any expert on this and other authors might give you better advice but I'd like to see a simple tutorial that lays out all the steps that would lead to a working demo. That is, everything you need to do to setup the basic example.

Then you can mention in detail other features and enhancements to improve upon the basic example and add more features.

Hope this helps

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants