I'd like to help with this effort and I submitted a CLA. I don't really care how it's hosted but I do have one comment. Before Tapestry I used ACS and it had some of the best documentation I've seen. I think there were two reasons for this.
1. It was considered a priority 2. The documentation was written with the framework. I think the second was very important for several reasons. 1. By definition the developers were familiar with the documentation system. 2. The documentation was built into each module and not a separate project 3. The documentation was dynamic not static. While all three are important I think the last one would be a huge benefit because the Tapestry framework is so extensible. If the documentation is part of the module then each instance would have the documentation for the modules that were loaded and could be served locally (perhaps only in development mode). This would allow things like a prefix page that contained all the prefixes configured into the currently running system. The documentation could be in the classpath just like the other know parts such as pages, components etc. So for example the project would have java/.../documentation/prefixes resources/.../documentation/prefixes Then a page could be dynamically created /documentation/prefixes/prefixesIndex This would contain a list of all the valid prefixes for the running install. Clicking one would show the documentation specific to it. A static site could be built by running the module that slurping up the generated html. Also given the way Tapestry is created some documentation could be generated. This is already true for components, but it would be nice to see things like what mixins have been automatically added to my pages and in what order. Clinking on one would reveal what it does. I think would go a long way in explaining how Tapestry works and helping people over the initial learning curve. Thanks Barry -- View this message in context: http://tapestry.1045711.n5.nabble.com/Documentation-via-Jekyll-tp5717541p5717603.html Sent from the Tapestry - Dev mailing list archive at Nabble.com. --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
