janpaepke / ScrollMagic

The javascript library for magical scroll interactions.
http://ScrollMagic.io
Other
14.8k stars 2.17k forks source link

documentation is not simpler for fast going #990

Closed shahnisargweb closed 2 years ago

shahnisargweb commented 2 years ago

we need document to understand fast to use make it simple make it more clear update some links its not working usage having very few description dd image also to understand output

johnfmorton commented 2 years ago

This is not my project, but I think there is a decent amount of documentation available.

Are you looking at the documentation on Github? Here is a link: https://github.com/janpaepke/ScrollMagic/wiki

The first page of the documentation asks for help in creating documentation including asking that if you find a mistake or have a suggestion for improvement that you should raise an issue.

There is also a site filled with examples here: http://scrollmagic.io/

The author also offers one-on-one support here: https://nerdpool.io/support/scrollmagic

Good luck.

-John

dsaisho commented 2 years ago

I thought the same until I found this section on the docs site: http://scrollmagic.io/docs/ScrollMagic.Controller.html http://scrollmagic.io/docs/ScrollMagic.Scene.html

shahnisargweb commented 2 years ago

thank you for your response i know document is trash zero resources for all api methods but you have some way to learn something pl share this path or doc or way because people are used pl send and give me help i am waiting for your reply one agin thank you

On Fri, 24 Sept 2021 at 04:19, Doug Saisho @.***> wrote:

agree, documentation is trash. zero resources for all the api methods. examples are acceptable. however, when you have 'premium support' related to an open source project, thats a great signal you wont be getting good documentation.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/janpaepke/ScrollMagic/issues/990#issuecomment-926217570, or unsubscribe https://github.com/notifications/unsubscribe-auth/AVIB4BQYUIRADQQKTKJUXR3UDOVI5ANCNFSM5DI75N5Q . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

dsaisho commented 2 years ago

good api docs :) http://scrollmagic.io/docs/ScrollMagic.Controller.html http://scrollmagic.io/docs/ScrollMagic.Scene.html

shahnisargweb commented 2 years ago

Awesome, thanks!

On Fri, 24 Sept 2021 at 23:37, Doug Saisho @.***> wrote:

good api docs :) http://scrollmagic.io/docs/ScrollMagic.Controller.html http://scrollmagic.io/docs/ScrollMagic.Scene.html

— You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub https://github.com/janpaepke/ScrollMagic/issues/990#issuecomment-926825531, or unsubscribe https://github.com/notifications/unsubscribe-auth/AVIB4BTYK67DXC3NQG67KJ3UDS47TANCNFSM5DI75N5Q . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.