Re: Introductory docs-hacking task: Example markup

From: "David G(dot) Johnston" <david(dot)g(dot)johnston(at)gmail(dot)com>
To: Matemática A3K <matematica(dot)a3k(at)gmail(dot)com>
Cc: Daniel Gustafsson <daniel(at)yesql(dot)se>, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Introductory docs-hacking task: Example markup
Date: 2026-11-12 02:56:05
Message-ID: CAKFQuwbQw5t4q1Oo9cxn+amS0hssrObEzWNSfmBd0EbaCERbUQ@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-docs

On Wed, Nov 11, 2026 at 7:42 PM Matemática A3K <matematica(dot)a3k(at)gmail(dot)com>
wrote:

> On Wed, Nov 11, 2026 at 9:29 AM Daniel Gustafsson <daniel(at)yesql(dot)se> wrote:
> >
> > Standardizing how we mark up examples would improve documentation
> consistency
> > and ideally make it easier to navigate and search.
>

Makes sense to me.

> I propose to add "Remove example markup and blend the encapsulated
> content into the prose of the belonging element" to the options being
> considered.
>
>
This seems unlikely to be accepted and is definitely not 'newcomer
friendly'. I'd suggest you, or anyone who does think this is needed,
provide at least three or four patch-quality examples of what you are
thinking on another thread first.

David J.

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Daniel Gustafsson 2026-11-12 09:11:42 Re: Good beginner doc-hacking task: clear-text vs. cleartext vs. clear text vs. plaintext etc..
Previous Message Matemática A3K 2026-11-12 02:41:44 Re: Introductory docs-hacking task: Example markup