Enable users to contribute doc improvements via GitHub


#1

The best documentation for any framework is achieved by a collaboration between the developers and the users. One convenient way to enable users to improve or add to the DHTMLX documentation is to make it available on GitHub.

KendoUI does exactly that - see docs.telerik.com/kendo-ui/introd … -at-github

MongoDB goes one step further: every page on docs.mongodb.org has an “Edit” icon that directs to where on GitHub that page is located.

I believe that implementing this will drastically improve the quality of the DHTMLX documentation. For example, take a look at the Kendo docs: github.com/telerik/kendo-docs/issues - over 500 pull requests. You can also see about 20 from me, submitted within the last week. If DHTMLX had a similar mechanism to accept documentation improvements, I would’ve used it instead because DHTMLX appears at this point as a better fit for my project. However, the inability to contribute was an important factor in considering Kendo instead, despite its shortcomings.


#2

Dan, thanks for your suggestion and willingness to improve our docs. For now we’re ready to enable the comments in dhtmlx documentation. We’ll also consider the possibility to share our docs on GitHub.


#3

Enabling comments on the documentation is a good start. Webix does that and I’ve commented a lot on their pages.