On 2011-08-27, at 10.18, Niclas Hedhman wrote: > What worked out of the box though is "Python Markdown". > http://freewisdom.org/projects/python-markdown/ > > Not sure which route to take from there...
Need to understand more want you want to do (see below...) > On Sat, Aug 27, 2011 at 3:37 PM, Niclas Hedhman <[email protected]> wrote: >> Well, I would *really* like the docs to be located *with* the source >> code, as close as possible. That encourages people like Rickard to >> once in a while add a paragraph or two. In separate repository, that >> won't happen ;-) >> I am also quite keen on having docs be generated for offline consumption, >> and distributed with the SDK itself. JavaDocs, right? How "generated" (probably silly question)? What "docs" are you referring to? Is it only JavaDocs, or also articles, tutorials, documentation etc on the website? Personally I don't like the concept of JavaDocs that much (I think they disturb the readability of the code - even with code folding in the editor). I have a hunch that there could be a better system that would automatically monitor code (specially tests and all thrown exceptions) in order to track undocumented code. And that the documentation process could be more integrated with a project website and the contributors - even Rickard ;-). I want to explore a more holistic approach to managing a software project - not only thinking of tickets, internal communication etc like standard management systems available, but one that addresses the issues we are talking about here - how to make documenting smooth and how to integrate it with the public website. But of course that's a whole other story far from the reality right now with the current documentation. Not of help now, I know... Cheers, Marc _______________________________________________ qi4j-dev mailing list [email protected] http://lists.ops4j.org/mailman/listinfo/qi4j-dev
