incubator-flex-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Maciek Sakrejda <m.sakre...@gmail.com>
Subject Re: Project Goshawk [was Time for an Apache Flex compiler.]
Date Thu, 16 Feb 2012 21:24:19 GMT
Very nice. Have you considered RST [1] (or another markup language)
for the design document formatting? It's readable as plain text,
github displays some of these natively (I think at least RST and
Markdown), and RST can be "compiled" to PDF or HTML (e.g., Python uses
it for their documentation and generates output with Sphinx [2]).
Also, being plain text, it's fairly easy to merge proposed changes to
sections of your design document.

The main downsides are that formatting is limited (probably not an
issue--an asset, in fact--in something like a design document) and
that tables can be a royal pain (it's WYSIWYG, so you frequently need
to massage the table structure if you change data).

[1]: http://docutils.sourceforge.net/docs/user/rst/quickref.html
[2]: http://sphinx.pocoo.org/rest.html

Mime
View raw message