Hi, Patrick!

Patrick W. Fraley wrote:
I would love to help contributing. I am not sure how well my english writing skills are, but maybe I can help with the documentation or something ( my javascript programming skills suck though, so no chance here :) How do you genrate the current documentation? The Class Tree etc?

Patrick

There are various forms of documentation that we would like people to get involved with and contribute to while they gain experience with qooxdoo.


* Articles in section "Documentation" are available for different user levels: Beginner, Intermediate, Developer.

http://qooxdoo.oss.schlund.de/documentation


* Any kind of tutorial, that wraps up your findings in getting qooxdoo to work, similar to the contributed "First step guide"

http://qooxdoo.oss.schlund.de/documentation/first-step-guide


* Code snippets that may be interesting to others.

http://qooxdoo.oss.schlund.de/snippets


* FAQ, particularly the technical part, to help users that ran into problems.

http://qooxdoo.oss.schlund.de/documentation/faq#link5


* Contributions to the mailinglist or actively posting to help other users solving their problems

http://lists.sourceforge.net/lists/listinfo/qooxdoo-devel


* Auto-generated documention including class tree

http://qooxdoo.oss.schlund.de/documentation/api-reference


The generated documentation is not meant to be complete, but is a good reference-like start. Often, names of classes, properties and methods are somewhat self-explanatory, so it usually gives you an overview and saves you from digging into the code yourself. Documentation is build with:

tools/generate/make-docs.sh

Enjoy a refreshing coffee while the documentation is being generated. It will take a few minutes...

Cheers,

Andreas





-------------------------------------------------------
This SF.Net email is sponsored by xPML, a groundbreaking scripting language
that extends applications into web and mobile media. Attend the live webcast
and join the prime developer group breaking into this new coding territory!
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=110944&bid=241720&dat=121642
_______________________________________________
Qooxdoo-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel

Reply via email to