Re: documentation structure

Tom Lane <tgl@sss.pgh.pa.us>

From: Tom Lane <tgl@sss.pgh.pa.us>

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

Cc: Tatsuo Ishii <ishii@postgresql.org>, andrew@dunslane.net, corey.huinker@gmail.com, jian.universality@gmail.com, robertmhaas@gmail.com, pgsql-hackers@postgresql.org

Date: 2024-07-19T20:17:41Z

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 →

docs: Consistently use <optional> to indicate optional parameters
- 0d829703363b 18.0 landed
docs: Consolidate into new "WAL for Extensions" chapter.
- 09d9800e5282 17.0 landed
freespace: Don't return blocks past the end of the main fork.
- 935829743151 17.0 cited
docs: Merge separate chapters on built-in index AMs into one.
- fe8eaa54420c 17.0 landed
docs: Demote "Monitoring Disk Usage" from chapter to section.
- f470b5c67924 17.0 landed
doc: move system views section to its own chapter
- 64d364bb39cb 16.0 cited

"David G. Johnston" <david.g.johnston@gmail.com> writes:
> +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.

I'd go for shorter myself (ie "func/"), mainly due to the precedent
of the existing subdirectory which is "ref/" not "reference/".
It's hardly a big deal though.

			regards, tom lane