Re: Converting README documentation to Markdown

On Sat, Jan 24, 2026 at 5:31 PM Álvaro Herrera <alvherre(at)kurilemu(dot)de> wrote:
>
> 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.

GitHub also provides nice rendering for markdown files, see

https://github.com/postgres/postgres/blob/master/src/backend/storage/aio/README.md

>
>
> (*) 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"
>
>

--
Regards
Junwang Zhao