search

uikit / uikit-site

🌎 Website and Documentation
https://getuikit.com
365 stars 331 forks source link

Documentation improvements #216

Open excitedbox opened 3 years ago

excitedbox commented 3 years ago

Working with the documentation is rather difficult when trying to figure out Jquery events or features in general. It would be nice if there was more information about the features each item supports as well.

Features such as dynamically inserting/removing elements are entirely undocumented as far as I can tell and even figuring out how to implement data updates and combine them with JS is really hard.

For beginners it is also hard to tell where what needs to go because the examples mix css and JS with no indication which part is a id, variable name, or function. This is especially hard for JS. So I think better labeling could be important.

I think a search would be really useful as well.

If someone can explain some of these things clearly enough so I can make sense of them I would be willing to write up some documentation for them.

viocassel commented 3 years ago

@excitedbox https://github.com/uikit/uikit-site/blob/feature/js-utils/docs/pages/javascript-utilities.md

excitedbox commented 3 years ago

oh thank you. This should probably be linked in the documents on the website. I assumed that the website docs would be the same so I didn't think to look here.