RFC: Source-markup language for GHC User's Guide

Tuncer Ayaz tuncer.ayaz at gmail.com
Wed Oct 8 08:21:08 UTC 2014

On Tue, Oct 7, 2014 at 5:20 PM, Herbert Valerio Riedel wrote:
> Hello GHC Developers & GHC User's Guide writers,
> I assume it is common knowledge to everyone here, that the GHC
> User's Guide is written in Docbook XML markup.
> However, it's a bit tedious to write Docbook-XML by hand, and the
> XML markup is not as lightweight as modern state-of-the-art markup
> languages designed for being edited in a simple text-editor are.
> Therefore I'd like to hear your opinion on migrating away from the
> current Docbook XML markup to some other similarly expressive but
> yet more lightweight markup documentation system such as Asciidoc[1]
> or ReST/Sphinx[2].
> There's obviously some cost involved upfront for a (semi-automatic)
> conversion[3]. So one important question is obviously whether the
> long-term benefits outweight the cost/investment that we'd incur for
> the initial conversion.
> All suggestions/comments/worries welcome; please commence
> brainstorming :)

Given the choices (and existing Docbook files), I would select AsciiDoc.

More information about the ghc-devs mailing list