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

suggestion to improve documentation #717

Open
vmarquet opened this issue Jan 4, 2018 · 3 comments
Open

suggestion to improve documentation #717

vmarquet opened this issue Jan 4, 2018 · 3 comments

Comments

@vmarquet
Copy link

vmarquet commented Jan 4, 2018

First, I'd like to say that this is a very good library, so thank you!

But I'd like to suggest an improvement to the documentation on the front page. It is particularly annoying to find an example (http://iamceege.github.io/tooltipster/#demos) that does exactly what one wants, but which do not explain how such a result was obtained.

It would be really great if, for each example, there was a button that would open a popup displaying the code used for the example (or a link to a playground like jsfiddle / codepen with the example code.

@louisameline
Copy link
Collaborator

Thank you! Good idea, I'll take care of it when I have some free time.

@magicmb
Copy link

magicmb commented Mar 21, 2020

I agree with the sentiments: A) this is a fabulous library and b) the documentation is somewhat lacking in terms of code samples.

Personally I'm not really from a development background and the thought of having to work out how to setTimeout(()=> {debugger},5000) inside the dev console to freeze the tooltip and examine the element to work out bits and pieces, before heading back to my own test environment to compare, not to mention constantly going back and forth between the Tooltipster docs as well as other documentation for other libraries I'm using e.g. FullCalendar, to figure out what is likely to be causing any issues encountered, then to read various github issues and searching StackOverflow etc before heading back to the beginning and starting all over again wasn't what I initially had in mind when I moved over from Tippy.js (also a good library who as it happens recommended yours) to Tooltipster.

However I am glad I did as I now have it working more or less exactly the way I intended and the thing that was bugging me before with Tippy.js (disabling dynamically generated tooltips post initial render) which I never really got around works nicely in your library. So it was all worth it as far as I'm concerned and I even learned a few things on the way.

The only thing I can think of in terms of improving this fantastic library would be to add a few code samples (especially '5. Use HTML inside your tooltips') as @vmarquet pointed out, to make life a little easier for anyone like myself with somewhat limited coding experience who might struggle with the documentation alone as it stands.

Again, fab library and thank you for all your hard work.

@louisameline
Copy link
Collaborator

@magicmb Thank you very much for the kind words. You're right, jsfiddles would be nice for people to see what happens. Right now people can look at the code of the demo, but it will be nicer with standalone examples.

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

3 participants