Re: Introductory docs-hacking task: Example markup

From: Daniel Gustafsson <daniel(at)yesql(dot)se>
To: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
Cc: Matemática A3K <matematica(dot)a3k(at)gmail(dot)com>, Xavier Fischer <xavier_fischer(at)hotmail(dot)fr>, "pgsql-docs(at)lists(dot)postgresql(dot)org" <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: Re: Introductory docs-hacking task: Example markup
Date: 2026-11-17 09:28:40
Message-ID: A24CBD68-5042-448A-9EEB-A12F3E0C0D06@yesql.se
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-docs

> On 17 Nov 2026, at 06:20, David G. Johnston <david(dot)g(dot)johnston(at)gmail(dot)com> wrote:

> But the project itself has basically zero priorities

I respectfully disagree with this statement, but that's beside the discussion
at hand.

> and this one item isn't going to make such a list come into existence.
>
> To a large extent what the docs do today is the guideline, if you want evidence to back a position that is where it will be found.

If anyone is interested in pursuing a set of guidelines for the documentation
(which for sure would be useful) I would argue that a good place to start would
be to document the consistent markup we have, and go from there. An excercise
like that will serve to identify where we are consistent and where we can
improve. The current Style Guide covers a pretty slim portion of the docs.

--
Daniel Gustafsson

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Daniel Gustafsson 2026-11-17 09:35:03 Re: Introductory docs-hacking task: Example markup
Previous Message Karen Jex 2026-11-17 08:49:52 Re: Good beginner doc-hacking task: clear-text vs. cleartext vs. clear text vs. plaintext etc..