From: Peter Stephenson <email@example.com>
To: Bevan Stanely <firstname.lastname@example.org>, email@example.com
Subject: Re: Proposal: Use Markdown syntax for README and other documentation
Date: Thu, 19 May 2022 16:16:18 +0100 (BST) [thread overview]
Message-ID: <firstname.lastname@example.org> (raw)
> On 19 May 2022 at 16:10 Bevan Stanely <email@example.com> wrote:
> 1. What do you mean by rendering carefully formatted package documentation?
> Is it similar to literate programming or something like doxygen? Or
> markdown will be separate from source files.
That was simply a slightly cryptic reference to use of markdown I've
seen in other settings.
> 2. I thought yodl was the tool currently being used to generate the
> documentation website. I'm not sure if it's also handling man page
> generation. Are you considering a substitute for that approach?
Yodl is used for all internal documentation, including manual pages;
as it's working OK I don't think discussions to change that have ever
got very far --- it's easy to plan for, massively harder to do.
I would imagine markdown, if used at all, would be restricted to a few
package files that are currently plain text.
next prev parent reply other threads:[~2022-05-19 15:16 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-18 15:41 Bevan Stanely
2022-05-19 1:10 ` Lawrence Velázquez
2022-05-19 4:02 ` dana
2022-05-19 4:26 ` Lawrence Velázquez
2022-05-19 6:04 ` Bevan Stanely
2022-05-19 8:55 ` Peter Stephenson
2022-05-19 15:10 ` Bevan Stanely
2022-05-19 15:16 ` Peter Stephenson [this message]
2022-05-19 15:22 ` Bevan Stanely
2022-05-19 18:23 ` Bevan Stanely
2022-05-19 18:42 ` Bart Schaefer
2022-05-20 5:43 ` Bevan Stanely
2022-05-19 4:29 ` Bart Schaefer
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).