[Nitro] New Blog Article About Nitro/Og
Thomas Leitner
t_leitner at gmx.at
Fri Oct 26 12:06:12 EDT 2007
How about a system like the one used by the Django framework? They
have all the necessary user documentation as text files in the
repository. It seems quite reasonable to have the documentation in
the source code repository and using a markup language like Markdown
or Textile would make it easy to read the docu as plain text and as
HTML (I personally prefer Markdown with extras - see http://
maruku.rubyforge.org). This would be usage documentation in contrast
to the API documentation provided by the RDocs.
An additional wiki where users could post documentation, tips and
tricks wouldn't be bad either, perhaps integrate oxywtf better into
the documentation effort.
Just some thoughts because I currently don't have time to provide
anything else.
Thomas
On 26.10.2007, at 17:48, Robert Mela wrote:
> I'd love to see the site code so I can learn yet more about Nitro.
>
> I'd be happy to move cheatsheets over to nitroproject.org, and
> certainly seeing how George and others code in Nitro will give me
> more stuff to fold into the cheatsheet docs. It'd also be a great
> way for users on this list to learn each others idioms. Best
> techniques for using Nitro, based on experience, would soon follow.
>
> This framework is just too wonderful to let wither.
More information about the Nitro-general
mailing list