Re: [HACKERS] Contrib modules documentation online

Neil Conway <neilc@samurai.com>

From: Neil Conway <neilc@samurai.com>

To: Tom Lane <tgl@sss.pgh.pa.us>

Cc: Josh Berkus <josh@agliodbs.com>, pgsql-hackers@postgresql.org, Albert Cervera i Areny <albert@nan-tic.com>, pgsql-docs@postgresql.org

Date: 2007-08-29T18:18:44Z

Lists: pgsql-hackers

On Wed, 2007-08-29 at 13:53 -0400, Tom Lane wrote:
> Why wouldn't we just remove the README files altogether?  I can't
> see maintaining duplicate sets of documentation.

I agree that duplication is bad, but I think README files in the
individual contrib directories is useful and worth keeping: if I'm about
to install a contrib module and want to learn how to install and use it,
this change would only make that information *more* difficult to find.

I wonder if it would be possible to keep the master version of the
contrib docs as SGML, and generate plaintext READMEs from it during the
documentation build.

-Neil