From: Tom Lane <tgl@sss.pgh.pa.us>
To: Peter Eisentraut <peter_e@gmx.net>
Cc: Bruce Momjian <pgman@candle.pha.pa.us>
Cc: Vince Vielhaber <vev@michvhf.com>
Cc: PostgreSQL-documentation <pgsql-docs@postgresql.org>
Subject: Re: Reference manual
Date: Fri, 09 Feb 2001 13:16:07 -0500
Message-ID: <20494.981742567@sss.pgh.pa.us> (raw)
In-Reply-To: <Pine.LNX.4.30.0102091852440.1286-100000@peter.localdomain>
References: <Pine.LNX.4.30.0102091852440.1286-100000@peter.localdomain>
Peter Eisentraut <peter_e@gmx.net> writes:
> As far as the HTML-formatted docs go and as far as 7.1 (and future) goes,
> there should only be exactly one link, which points to the index.html of
> the intergrated doc. There will no longer be separated docs, because
> that's why there's an integrated doc with a title page and all the links.
A complaint that someone made on the lists last night crystallized
something that's been bothering me for awhile now: the front page of the
integrated docs (http://www.postgresql.org/devel-corner/docs/postgres/)
is too sparse. If you don't already understand the layout of the docs,
it's not clear where you want to go from here.
I think it would work a lot better if this page showed not just the six
top-level document names, but the first sublevel (ie, chapter headings)
within each one. That would give people a sense of what is in each
document, and it'd also save a level of click-through in many cases,
since you could click straight to the chapter you want. It looks like
this would expand the page from six lines to about fifty, which doesn't
seem unreasonable.
I have no idea if this is easy, hard, or impossible to do given our
current documentation tools, but if it's possible I think it would be
a good improvement.
regards, tom lane
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: tgl@sss.pgh.pa.us, peter_e@gmx.net, pgman@candle.pha.pa.us, vev@michvhf.com
Subject: Re: Reference manual
In-Reply-To: <20494.981742567@sss.pgh.pa.us>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox