search

darsain / sly

JavaScript library for one-directional scrolling with item based navigation support.
http://darsa.in/sly
2.87k stars 497 forks source link

initilization ! #246

Open cbvora opened 8 years ago

cbvora commented 8 years ago

can you pls provide all in one documentation ?

i just wanted to use simpler one !!

and its time consuming even to find how to initialize it !

lukasT commented 8 years ago

+1 ! after visiting 5 different pages for documentation, I didn't manage to build just a simple scrollbar because I can't combine the information to one simple example.

sergey-dev commented 8 years ago

I think it's normal practice to split the documentation into the sections. What's wrong with you guys, @cbvora and @lukasT , are you lazy? It works out of the box.

Here's the introduction section, in the documentation with some really easy code examples of usage. Then there's General Documentation (the bird perspective overview), with the corresponding split into logical sections: Methods, Options, Markup, Events and Properties.

The documentation is almost ideal and laconic! To make it absolutely perfect, I'd say, it just lacks the richer section with Examples. It might help to avoid future questions from the lazy developers, who can't use the documentation or not willing to.

lukasT commented 8 years ago

"It might help to avoid future questions from the lazy developers, who can't use the documentation or not willing to" - wow, just wow :D

Nothing wrong with us. If the usage-part on the root-page will only give you one of at least two parts on how to at least try it, we will be forced to search for ourselves. Didn't want to offend here, sorry if it wasn't written in a kinder manner.

sergey-dev commented 8 years ago

@lukasT , hehe :smiley:, sorry that I written my reply in sarcastic mode as well, it was not something targeted personally to anyone.

But, agree, this documentation was not that bad :) and when someone says that not even managed to find how to initialize it in the documentation, and in reality it is the first page in the repo's docs - then I'm wordless :unamused:

I found the docs to be pretty much explicit, and the author did the great job.

p-decoraid commented 7 years ago

I neglected to apply .init() after converting jquery plugin calls to new Sly style, even though it's mentioned everywhere. Bah.