This is a migrated thread and some comments may be shown as answers.

Documentation

3 Answers 105 Views

Validation

This is a migrated thread and some comments may be shown as answers.

Alistair asked on 10 Sep 2014, 11:51 AM

Hi,

I have a 30 day trial licence of Kendu UI and I am struggling with the documentation. What would be great, would be a mini-site for each Kendo UI element which clearly shows all the documentation. For example:

Validator
- Overview
- Configuration
- Demos
- Forum threads
- Code library
- Issues
- Stack overflow

Instead what we have is validator documenation in different parts of the site:
http://docs.telerik.com/kendo-ui/framework/validator/overview - located under "Framework and Utilities - Validator - Overview"
http://docs.telerik.com/kendo-ui/api/javascript/ui/validator#methods-validateInput - located under "API Reference - Javascript - Ui - Validator"
http://demos.telerik.com/kendo-ui/validator/angular - not referenced in the above menus.
http://www.telerik.com/forums/kendo-ui/validation - link only appears in the footer for the above link but not for the first two
http://www.telerik.com/support/code-library/kendo-ui/validator - as above
https://github.com/telerik/kendo-ui-core/issues?q=is%3Aopen+is%3Aissue - not linked anywhere (as far as I know)
http://stackoverflow.com/questions/tagged/kendo-ui

All this makes it very difficult to make sure you have read all the relevant documentation and seen the examples. I am also sure there is a link to your bug tracking system which people ought to be aware of.

These comments can equally apply to any of the Kendo UI elements.

Do you think these points are fair / do you have any plans to improve the documentation?

Many thanks

3 Answers, 1 is accepted

answered on 10 Sep 2014, 12:12 PM

Hello Alistair,

Thank you very much for sharing your input.

The different section of the documentation are the Getting Started section, where the general purpose of the widget is explained along with the core functionality, that you will most probably read just once. Then you have the API reference that you will need daily in order to check the different methods, configurations and events that the widget has and this is why these two are separated in the documentation site.

The demos are quite different than the documentation as they show some use case scenarios for the widgets, but do not explain the API reference of the widget.

As for the GitHub issues - as you know there is an open source version of Kendo UI that is hosted on GitHub. The issue tracker that you see there is related to the widgets that are part of the Kendo UI Core (open source version).

Stackoverflow is something that is beyond the scope of the Kendo UI team. Yes, we do sometimes respond to Kendo UI threads, but it is a community open forums, that are not particularly related to our documentation site.

I will forward your feedback to the people responsible for the documentation on the site, so they will consider it for future implementation.

Thanks again for bringing this to our attention.

Regards,
Kiril Nikolov
Telerik

Join us on our journey to create the world's most complete HTML 5 UI Framework - download Kendo UI now!