User community comments now supported in documentation
Posting this for Henry Minsky:
There is now a way for developers to add comments and examples to the documentation. At the bottom of every doc page is a link that lets you write a comment or tip. The comments will be sent to volunteer reviewers, and if approved will appear on the doc page.
The guideline for comments is similar to the PHP docs; you should add tips or code samples that clarify the documentation on that page. Questions and bug reports should be filed in JIRA or posted to the mailing lists or forums.
You can see the doc-with-comments feature on the docs on the nightly build only for now, for example the reference manual
http://labs.openlaszlo.org/trunk-nightly/docs/reference/
The comment-enabled docs are in trunk, so they will appear on the openlaszlo.org docs with the next release. Please try contributing some comments with the nightly build, so we can debug the comments system. Also send me a note if you want to be a volunteer reviewer.
--
Henry Minsky
Software Architect
February 13th, 2009 at 2:34 am
I’m glad that you did that, Henry. Will make the documentation a lot more use valuable.
February 15th, 2009 at 7:53 pm
Following that link to the nighlty-build-docs, just gives me a 404?!
February 16th, 2009 at 12:23 pm
Very interesting, but the link doesn’t work and in the documentation (http://www.openlaszlo.org/lps4.2/docs/reference/) I don’t see any difference…
February 18th, 2009 at 2:30 pm
Thumbs up!
February 20th, 2009 at 3:01 pm
Hmm, it the docs with comments enabled should make it into the http://www.openlaszlo.org/lps4.2/docs/reference/ when the 4.2.0.1 goes live, lemme check when that is supposed to happen. For now the comments are enabled in the docs in the nightly build, and comments made there will be visible when the 4.2.0.1 docs are installed, so comment away now on the nightly’s docs.