[Haskell-cafe] Re: Writing great documentation

[Magnus Therning]

On 13/11/09 21:20, Max Rabkin wrote:
> On Fri, Nov 13, 2009 at 10:58 PM, Simon Michael <simon at joyful.com> wrote:
>> A very common problem with online docs is fragmentation.
> 
> Absolutely! Is it possible to include non-haddock documentation in a
> cabal package. Is it possible to have it readable on Hackage? I think
> this would help with the fragmentation and versioning issues.
> 
> One option is to have haddock-only modules for non-reference
> documentation (xmonad-contrib does this), and I think at the moment it
> is a good option, but it does have disadvantages. It may not be clear
> from the outline where documentation can be found, and it clutters up
> the module namespace. Perhaps we could add support for a
> Documentation-Modules field in cabal files, which would separate these
> modules in the outline, and not install them but only their
> documentation.

I feel the Haskell Wiki is a great place to keep non-reference docs.  That's
what I opted to do for dataenc, and will most likely do if I ever get around
to putting other modules on hackage.

/M

-- 
Magnus Therning                        (OpenPGP: 0xAB4DFBA4)
magnus＠therning．org          Jabber: magnus＠therning．org
http://therning.org/magnus         identi.ca|twitter: magthe

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 198 bytes
Desc: OpenPGP digital signature
Url : http://www.haskell.org/pipermail/haskell-cafe/attachments/20091113/b7ca8346/signature.bin