Interactive Documentation - how do you want it to work?

From: "Dave Page" <dpage(at)vale-housing(dot)co(dot)uk>
To: "PostgreSQL-development" <pgsql-hackers(at)postgresql(dot)org>
Subject: Interactive Documentation - how do you want it to work?
Date: 2003-02-02 20:22:49
Message-ID: 03AF4E498C591348A42FC93DEA9661B885A2@mail.vale-housing.co.uk
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers


As you may have noticed we have recently revamped the Interactive
Documentation on the website (http://www.postgresql.org/docs). This has
raised a couple of questions about how the idocs should work, so I'd
like to get some votes on the following 2 issues:

1) How should comments be linked to document sets?:

- Each comment attaches only to the page name & version of the page to
which it was submitted.

- Each comment attaches only to the page name, version of the page to
which it was submitted *and* subsequent versions (this is the current
behaviour).

- Each comment should attach to the page name to which it was submitted
regardless of the version.

2) Bearing in mind your answer to the previous question, should all the
comments be deleted when useful examples have been merged into the main
documents (remember that the definition of 'useful' may vary), or should
we only remove the 'junk' ones?

- Yes

- No

Thanks, Dave.

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Josh Berkus 2003-02-02 20:24:26 Re: [PERFORM] not using index for select min(...)
Previous Message Tom Lane 2003-02-02 20:15:09 Re: Last call for 7.3.2