coapp-developers team mailing list archive

[Garrett Serack <garretts@xxxxxxxxxxxxx>]

I'll be pushing out the new website today (with a lot of pages to be filled in over the next couple weeks)

The website itself uses a "fork" of DocPad, which is a static content generation system written in node.js ... all the code for it will be included in the repository, so the only thing you will need to work on it is a text editor and install node.js.

It creates pages out of github-flavored-markdown--including the triple-backtick (```) syntax-highlighed source code sections (which I added to this version, since the node.js gfm module didn't do that!.

The net effect is that we can write pages in the wiki, and simply copy them over to the website when they are 'ready-for-production' with theoretically zero changes.

Over the next couple of days, while I'm writing up documentation, let's build the official 'workflow' for contributing new documentation (and make any modifications to the website organization if required)


G


________________________________________
From: Mateusz Łoskot [mateusz@xxxxxxxxxx]
Sent: Friday, December 16, 2011 3:44 PM
To: Adam Baxter
Cc: coapp-developers@xxxxxxxxxxxxxxxxxxx; Garrett Serack
Subject: Re: [Coapp-developers] Awesome documentation for CoApp

2011/12/16 Adam Baxter <voltagex@xxxxxxxxxxxx>:
> So into the wiki idea, add approved revisions - that way you get the
> benefits of wikis with some versioning and publishing.

I think it's a good idea.
Simply, if there is:
a) well-defined workflow of documenting CoApp
b) stable frame for documentation structure set
then it should be easy to avoid or the possible chaos.

Best regards,
--
Mateusz Loskot, http://mateusz.loskot.net