Re: Converting README documentation to Markdown

From: Álvaro Herrera <alvherre(at)kurilemu(dot)de>
To: Robert Haas <robertmhaas(at)gmail(dot)com>
Cc: Daniel Gustafsson <daniel(at)yesql(dot)se>, Peter Eisentraut <peter(at)eisentraut(dot)org>, PostgreSQL Developers <pgsql-hackers(at)lists(dot)postgresql(dot)org>
Subject: Re: Converting README documentation to Markdown
Date: 2026-01-24 09:30:54
Message-ID: 202601240907.ccskdsdc5smx@alvherre.pgsql
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On 2024-Sep-10, Robert Haas wrote:

> On Tue, Sep 10, 2024 at 8:51 AM Daniel Gustafsson <daniel(at)yesql(dot)se> wrote:
> > Since there doesn't seem to be much interest in going all the way to Markdown,
>
> Just for the record, I suspect going to Markdown is actually the right
> thing to do.

I had occasion to go look at our doxygen this morning, whose box is as
of a couple of days ago running Debian Trixie, and realized that it is
now showing the README.md files in the documentation hierarchy -- for
example,
https://doxygen.postgresql.org/md_src_2backend_2storage_2aio_2README.html
The plain README files don't get this treatment.

I don't know if it was already working in the previous version, or it is
only that I happened to notice it now. (*)

Anyway, I wonder if this fact would give more fuel to the idea of making
our README files gain a .md extension.

(*) Now that I look closer, this might be very old actually, because
Bookworm had doxygen 1.9.4 and trixie has 1.9.8 -- very little
difference there. I guess I only noticed this now because we now have
README.me and the aio/README.md file.

--
Álvaro Herrera Breisgau, Deutschland — https://www.EnterpriseDB.com/
"La vida es para el que se aventura"

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Amit Kapila 2026-01-24 09:53:44 Re: unnecessary executor overheads around seqscans
Previous Message Pavel Stehule 2026-01-24 07:10:36 proposal: plpgsql - FOREACH t IN JSON ARRAY expr