On 2011-08-27, at 10.54, Niclas Hedhman wrote: > Ok, I don't know where this will lead, but I am pretty comfortable > with "Markdown" and think it is sweet enough for our needs. > > So, I will start building up some documentation, pulling a lot from > www.qi4j.org to get this effort going on the basis we need "content" > more than "tools". I have also asked Thien to help out styling > something up in CSS, but his availability is limited but says > hopefully can get us something before New Year.
Will documents/css etc be on the domain hosting or github? If on github - in what repository? I'm not insisting on using Gollum/Smeagol, just think that they offer some cool options in good line with our branching model. And they also use Markdown...? As long as the documentation can be versioned/branched, I think we have come a good step forward! :-) > On Sat, Aug 27, 2011 at 4:48 PM, Niclas Hedhman <[email protected]> wrote: >> On Sat, Aug 27, 2011 at 4:29 PM, Marc Grue <[email protected]> wrote: >>> 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? >> >> No, I mean the User Guide, Programming Reference, HowTos, Articles, >> Random Thoughts, whatever... The stuff that is normally on a website. So by "generated" you could also say "included"? There's no extraction process generating some doc files involved in the build then, right? But how do you want those documents to be "close to the code"? Isn't the issue more "close at hand"? Easy to get to and edit? I think Gollum would help here, since you would then be able to sit on the plane with a local copy of the qi4j-docs and have a cosy time writing up a little about the latest cool functions and then merge it when online again :-) Thanks for pushing this issue - better/more avilable/updated documentation will attract more collaborators and Qi4j deserves worlwide boost! Cheers, Marc _______________________________________________ qi4j-dev mailing list [email protected] http://lists.ops4j.org/mailman/listinfo/qi4j-dev
