zurb / joyride

jQuery feature tour plugin.
http://www.zurb.com/playground/jquery-joyride-feature-tour-plugin
1.42k stars 241 forks source link

joyride docs #178

Open Maujor opened 10 years ago

Maujor commented 10 years ago

Joyrire documentation page says:

Joyride does not initialize on page load like the rest of the plugins. You need to call start to get it to load. $(document).foundation('joyride', 'start');

Looking in the source code of that page we can see that the Joyride plugin is initialized using the following sintax:

$(document).foundation().foundation('joyride', 'start');

Playing with the plugin I realized that the sintax pointed in the docs text doesn't work. Is there a mistake on the docs text?

vicky5 commented 10 years ago

At 2014-05-25 08:50:44, "Maujor" notifications@github.com wrote:

Joyrire documentation page says:

Joyride does not initialize on page load like the rest of the plugins. You need to call start to get it to load. $(document).foundation('joyride', 'start');

Looking in the source code of that page we can see that the Joyride plugin is initialized using the following sintax:

$(document).foundation().foundation('joyride', 'start');

Playing with the plugin I realized that the sintax pointed in the docs text doesn't work. Is there a mistake on the docs text?

¡ª Reply to this email directly or view it on GitHub.

ESWAT commented 10 years ago

+1 it seems http://zurb.com/playground/jquery-joyride-feature-tour-plugin is outdated and doesn’t have all the options in the actual plugin. Was going to add all the extra options myself but noticed the demo site in the repo is not the same as the one on Zurb.

The hosted docs should really be in this repo as well so it can be updated as the plugin updates.

minorOffense commented 10 years ago

Yeah I agree. I just spent the better part of two hours debugging the location of my joyride stuff to discover that the docs say "tip_location" but the code wants "tipLocation"