Barracuda docs....
Jacob Kjome <[email protected]>
| Newsgroups | gmane.comp.java.enhydra.barracuda.general |
|---|---|
| Message-ID | <[email protected]> |
At some point we need to figure out what we want to do with Barracuda's docs. The way things are is not overly manageable. I think we should use something like Forest from the XML Apache project: http://xml.apache.org/forrest/index.html This will make the doc source human readable and allow for lots of flexibility in the presentation. Human readability is important for those who might want to contribute to the docs. They should be able to do so using a simple text editor and not have to know much of anything about the resulting format of the docs. This ease of use will, I believe, increase contributions to our documentation which, everyone will agree, requires some enhancement. While it might seem like Forest forces a particular presentation format based on most of the sites that use Forest looking almost exactly the same ( such as http://ant.apache.org/ looking like Forest's layout above ), I believe this was a conscious choice of those sites to use what is probably the default layout. Looking at some of the sites who claim to use Forest bears this fact out.... http://xml.apache.org/forrest/live-sites.html There are a few in that list that don't look like standard Forest layout. I'm not saying we need to do this immediately. However, we need to get some people thinking about it and working on it at some point. Any thoughts? Any volunteers? Jake