Re: [DOCS] Contrib modules documentation online - Mailing list pgsql-hackers

From Neil Conway
Subject Re: [DOCS] Contrib modules documentation online
Date
Msg-id 1188411524.32003.6.camel@dell.linuxdev.us.dell.com
Whole thread Raw
In response to Re: [DOCS] Contrib modules documentation online  (Tom Lane <tgl@sss.pgh.pa.us>)
Responses Re: [DOCS] Contrib modules documentation online  ("Mario Gonzalez" <gonzalemario@gmail.com>)
Re: [DOCS] Contrib modules documentation online  (Peter Eisentraut <peter_e@gmx.net>)
List 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



pgsql-hackers by date:

Previous
From: "Joshua D. Drake"
Date:
Subject: Re: [DOCS] Contrib modules documentation online
Next
From: Andrew Dunstan
Date:
Subject: Re: [DOCS] Contrib modules documentation online