Horton

Re: documentation structure

David G. Johnston <david.g.johnston@gmail.com>

View thread
From: "David G. Johnston" <david.g.johnston@gmail.com>
To: Tatsuo Ishii <ishii@postgresql.org>
Cc: tgl@sss.pgh.pa.us, andrew@dunslane.net, corey.huinker@gmail.com, jian.universality@gmail.com, robertmhaas@gmail.com, pgsql-hackers@postgresql.org
Date: 2024-07-19T20:11:46Z
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

On Fri, Jul 19, 2024 at 1:01 PM Tatsuo Ishii <ishii@postgresql.org> wrote:

> > Do we want to use a "func-" prefix on the file names?  I could
> > imagine dispensing with that as unnecessary;
>
> If we don't use the prefix and we generate new file names from sect1
> tag, we could have file name collision: for example, json.sgml because
> there's sect1 tag "functions-json".
>
> > or another idea
> > could be to make a new subdirectory func/ for these.
>
> +1. Looks better than adding +30 files right under sgml directory.
>
>
+many for placing these under a subdirectory.

IMO the file name should match the ID of the sect1 element with the leading
"functions-" removed, naming the directory "functions".  Thus when viewing
the web page the corresponding sgml file is determinable.

David J.