Hi Chris, thanks for your input regarding documentation. It is indeed being reworked with to goals (and users) in mind: tutorial (for newbies) and reference. Current version in the wiki is still rough and is in the works.
As we already discussed, looking forward to collaborating with you on this effort. Helloworld has just been the start. ;-) I'll get in touch with you directly to further coordinate the updating and polishing of docs. TTYL, :-) Andreas > > I think the move to a single standardized SDK is a good one. > > I think what is causing Jason grief is really the current state of the > qooxdoo documentation on the site. Although there is a lot of good > documentation, there is also a lot missing, or even (it seems) mixing > a bit of 0.8 and 0.7? > > As soon as the 0.8 release is sorted, I think the biggest area that > the qooxdoo project could benefit from would be to do a big push on > refining and extending the wiki -- the API and Demo apps are already > rather fantastic, but dropping into the qooxdoo universe from outside > can be rather daunting, and requires a bit of persistence to get to > the point where things start to click. > > > What I would personally suggest is to reorganize your wiki docs to > take the view of someone coming to qooxdoo for the first time. Make > the main heading sections be things that new users will want to > 'discover' and then give them a good portion of "why" things are done, > before dumping them into the lower levels of "how" they're done. > > This is just a rough idea -- I don't know enough of all the system > details to make an accurate list... > * Get all the document detail wiki pages up and working > (http://qooxdoo.org/documentation/0.8/) in their current > layout state. > > * Identify "Areas" of functionality, that need a higher level > set of documentation. These Areas could be things like: > > * qooxdoo Quick Start - Installing the SDK and getting > your fist app runing. > * The ideas and concepts behind qooxdoo > * Unix-like installation & setup > * Standard or SVN > * Windows installation & setup > * Standard or SVN > * Mac OSX installation & setup > * Standard or SVN > * Hello qooxdoo World > * Simple Stand Alone app (a full qooxdoo based > "desktop-style" app) > * Simple Inline app (adding a small qooxdoo app > to an existing html web page) > * The qooxdoo Generator > * An overview of how to generate your apps with > qooxdoo > * The different types of applications you can > generate. > * The organization of a generated qooxdoo > project - what goes where, and why. > * ... > * Unit Testing how to help make sure your apps work > * The idea behind Unit Tests. > * How to add and use the qooxdoo Test Runner in > your app > * Intermediate Testing > * Advanced Testing > * Debugging & Profiling > * OO Programing with qooxdoo > * All the Class, Interface, Mixin stuff here. > * GUI Development > * Widgets > * Layouts > * ... > * Events > * AJAX server communication > * Custom Widgets customizing qooxdoo and skinning > existing widgets. > * API Browser > * Demo application browser > * qooxdoo libraries user contributed additions to > qooxdoo > * ... > > Two things here; > 1. The first is that you're organizing this documentation from a > complete qooxdoo "noob's" point of view, by starting with the > points that are the most relevant for them. So the concept of > the wiki documentation overview page would be Novice -> Expert > as you move down the page. > 2. The second is that I think that you have a good deal of this > information already. It needs to be updated for qooxdoo 0.8 > (obviously) and some more in depth "How to do things" > articles, that cover both the basics and in-depth details for > more advanced users. > > Just my 2 cents as a qooxdoo noob myself :-) . > > Cheers, > -Chris ------------------------------------------------------------------------- This SF.Net email is sponsored by the Moblin Your Move Developer's challenge Build the coolest Linux based applications with Moblin SDK & win great prizes Grand prize is a trip for two to an Open Source event anywhere in the world http://moblin-contest.org/redirect.php?banner_id=100&url=/ _______________________________________________ qooxdoo-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel
