Horton

Re: documentation structure

jian he <jian.universality@gmail.com>

View thread
From: jian he <jian.universality@gmail.com>
To: Andrew Dunstan <andrew@dunslane.net>
Cc: Robert Haas <robertmhaas@gmail.com>, "pgsql-hackers@postgresql.org" <pgsql-hackers@postgresql.org>
Date: 2024-04-28T00:00:00Z
Lists: pgsql-hackers

Commits

Same data as JSON: GET /api/v1/messages/:b64id/commits the thread's linked commits as JSON, with link sources. API reference →

  1. docs: Consistently use <optional> to indicate optional parameters

  2. docs: Consolidate into new "WAL for Extensions" chapter.

  3. freespace: Don't return blocks past the end of the main fork.

  4. docs: Merge separate chapters on built-in index AMs into one.

  5. docs: Demote "Monitoring Disk Usage" from chapter to section.

  6. doc: move system views section to its own chapter

Attachments

On Mon, Apr 15, 2024 at 1:00 PM jian he <jian.universality@gmail.com> wrote:
>
> On Wed, Mar 20, 2024 at 5:40 AM Andrew Dunstan <andrew@dunslane.net> wrote:
> >
> >
> > +many for improving the index.
> >
> > My own pet docs peeve is a purely editorial one: func.sgml is a 30k line beast, and I think there's a good case for splitting out at least the larger chunks of it.
> >
>
> I think I successfully reduced func.sgml from 311322 lines to 13167 lines.
> (base-commit: 93582974315174d544592185d797a2b44696d1e5)
>
> writing a patch would be unreviewable.

I've splitted it to7 patches.
each patch split one <sect1> into separate new files.

> func-string.sgml
> func-matching.sgml
> func-datetime.sgml
> func-json.sgml
> func-aggregate.sgml
> func-info.sgml
> func-admin.sgml

the above will be newly created files, each corresponding to related
individual patches.