Thank you Billy for the feedback. The documentation site is a living breathing document.

The actual docs for the tags and functions come from the Java code itself; so any chances you want to see there, simply checkout the SVN code, find the function, make the change and submit a patch to us (me or Andy).

Likewise the rest of the /manual/ site is also in SVN and you can do the same thing and submit us a patch.

Alternatively, file an issue, and we'll update it for you.
http://code.google.com/p/openbluedragon/issues/list

We're continually expanding it and as and when we hit tags/functions that are not properly documented we do it there and then.

Also ... if you wish to submit code samples, then please do so, we have a mechanism in the manual to easily include them.


Billy Cravens wrote:
First off, let me say that I really dig the documentation, especially since it was updated. So easy to get to.

Is there a mechanism for submitted doc errors/updates? For example, http://www.openbd.org/manual/?/language_operators uses <if> instead of <cfif>. There's also places where some of the function params/return values aren't clear .. for example, fileWrite() says it returns a string.. but what does this value represent? The docs don't specify what is returned, only the type. When working in OpenBD I often find myself looking up the function, then going to Adobe's docs for clarification.

Looking on the docs site I don't see a way to submit updates.. is there any action around this?


--
online documentation: http://openbd.org/manual/
  google+ hints/tips: https://plus.google.com/115990347459711259462
    http://groups.google.com/group/openbd?hl=en

Reply via email to