zsh-workers
 help / color / mirror / code / Atom feed
From: Peter Stephenson <p.w.stephenson@ntlworld.com>
To: Bevan Stanely <bevanstanely@iisc.ac.in>, zsh-workers@zsh.org
Subject: Re: Proposal: Use Markdown syntax for README and other documentation
Date: Thu, 19 May 2022 09:55:18 +0100 (BST)	[thread overview]
Message-ID: <1540829696.208973.1652950518801@mail2.virginmedia.com> (raw)
In-Reply-To: <MA1PR01MB2876DDD7729194C2BF9B7F8AE9D09@MA1PR01MB2876.INDPRD01.PROD.OUTLOOK.COM>

Markdown's fine for what it's does --- the only requirement I'd suggest before we start
using it is that there is a firm plan to do something with it, e.g. integrate it
into a website.  I've been a bit bemused before staring at carefully formatted
package documentation and wondering how I'm supposed to render it and having done
a bit of research tentatively concluded I'm probably not supposed to and then
wondered what's the point and why I had to go through this exercise in the first
place...  If there *is* a point, that's another matter.

Pruning down README sounds sensible, too, though that probably needs a separate
thread.

pws


  reply	other threads:[~2022-05-19  8:55 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 [this message]
2022-05-19 15:10           ` Bevan Stanely
2022-05-19 15:16             ` Peter Stephenson
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

Reply instructions:

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:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1540829696.208973.1652950518801@mail2.virginmedia.com \
    --to=p.w.stephenson@ntlworld.com \
    --cc=bevanstanely@iisc.ac.in \
    --cc=zsh-workers@zsh.org \
    --subject='Re: Proposal: Use Markdown syntax for README and other documentation' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this inbox:

	https://git.vuxu.org/mirror/zsh/

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).