From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on inbox.vuxu.org X-Spam-Level: X-Spam-Status: No, score=-3.3 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, MAILING_LIST_MULTI,RCVD_IN_DNSWL_MED,T_SCC_BODY_TEXT_LINE, UNPARSEABLE_RELAY autolearn=ham autolearn_force=no version=3.4.4 Received: (qmail 23974 invoked from network); 19 May 2022 04:03:24 -0000 Received: from zero.zsh.org (2a02:898:31:0:48:4558:7a:7368) by inbox.vuxu.org with ESMTPUTF8; 19 May 2022 04:03:24 -0000 ARC-Seal: i=1; cv=none; a=rsa-sha256; d=zsh.org; s=rsa-20210803; t=1652933004; b=HjelWXk+zkREUaZCAdxVWJdYoZy6cK/M2o/990dBxNvcTPcQAQgQwWtn3mI9j6IIdsRNv31ExT n1tHARXtqZweJC6YY1U/TTBm+Jsily2oRdoS8VaCyrCm+rMm6PiReGT4P5lQ3TYoESuvn9/VVd dd/kkwxdKe/Ty9+z+PoyHH21tXgQ/olm44fzVwDhmViJtL7oNBVVQfQt3SHfeNECdunoq9CqD4 dLe6QrU30cKfnLxutQJUm4eUKADjz0/P7ojBc9rW/cS3LxW/NPgTeNj2ZtNwJEwn5C5IgZm1ou UzM07gIT2kRsCHDO4Djgw6e7aq4dEbOooW1uOyb8lbfqBw==; ARC-Authentication-Results: i=1; zsh.org; iprev=pass (wout2-smtp.messagingengine.com) smtp.remote-ip=64.147.123.25; dkim=pass header.d=dana.is header.s=fm1 header.a=rsa-sha256; dkim=pass header.d=messagingengine.com header.s=fm1 header.a=rsa-sha256; dmarc=none header.from=dana.is; arc=none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed; d=zsh.org; s=rsa-20210803; t=1652933004; bh=oVshPfWWj+EvEnW3cC7yIcHVh40uEkBYOH6khjEhdwo=; h=List-Archive:List-Owner:List-Post:List-Unsubscribe:List-Subscribe:List-Help: List-Id:Sender:Content-Transfer-Encoding:Content-Type:Subject:Cc:To:From: Date:References:In-Reply-To:Message-ID:MIME-Version:DKIM-Signature: DKIM-Signature:DKIM-Signature; b=U+4/jYc0fMIZd6eV8Wt2a2WejycxjOukurDJzKmLBoDtee6DxqjfChml1YBFa/yVeaKyLMKRsr Hl1bBW/oV5iE6IqaOXzO+H12su37/UYDpAyM05YBCrDTFFSMCy53Qe64r58gEQAIecLphUqzoX TABaiKcOMIj4aUifKaGWB1gNZwWlVEEHaRbtFGYJHOXB5gAvn8ZfLwOLU12qIgr9Dzc0TCaH7X jqlLoBv5Cubh39MBbxoxP/r2y4oWTEfivmW1hhRqcwHMnpSyA0LfFSGzFtKOWnj3at9X89QhNy iUOan+JwZknwWTSwHCVgR5fkUrYYNNmdG8y16eCekeBUVQ==; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=zsh.org; s=rsa-20210803; h=List-Archive:List-Owner:List-Post:List-Unsubscribe: List-Subscribe:List-Help:List-Id:Sender:Content-Transfer-Encoding: Content-Type:Subject:Cc:To:From:Date:References:In-Reply-To:Message-Id: Mime-Version:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID; bh=oVshPfWWj+EvEnW3cC7yIcHVh40uEkBYOH6khjEhdwo=; b=awTeO55HGx/JG36MVT/ta+8Z/C 3ooobp8ToUxnkBHMonbBOBB3hUAbT9l970KmDNG0wC89+JsKfwp4NySALN/NQJWmI0gYEH/fQ4Rbj RVDejXk79+TlJQVkQTs3AQ+tXcFcjbxAQiPJXTO2CubdTauYQzIm0NDQewUqTE2E6JmpDezgFHgbH 5/vpsxaaY1YXoVWIQ/8vwzYi8R80AmDgC1JcZlZMxOUbjWI/O+9yyBGAplKam0KedG9mkPpbofUnH 8BhiByslFUvwuTVlOD9yVg1z4BOJ2Zkod3kll0UaFAM4ZTG74G3lUlWcF5HUHsh6pbqbra1qyldQV HhsusHcg==; Received: from authenticated user by zero.zsh.org with local id 1nrXNk-000C7S-C3; Thu, 19 May 2022 04:03:24 +0000 Authentication-Results: zsh.org; iprev=pass (wout2-smtp.messagingengine.com) smtp.remote-ip=64.147.123.25; dkim=pass header.d=dana.is header.s=fm1 header.a=rsa-sha256; dkim=pass header.d=messagingengine.com header.s=fm1 header.a=rsa-sha256; dmarc=none header.from=dana.is; arc=none Received: from wout2-smtp.messagingengine.com ([64.147.123.25]:32779) by zero.zsh.org with esmtps (TLS1.3:TLS_AES_256_GCM_SHA384:256) id 1nrXNE-000Boi-Uh; Thu, 19 May 2022 04:02:53 +0000 Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.west.internal (Postfix) with ESMTP id 1DBDF320029B; Thu, 19 May 2022 00:02:51 -0400 (EDT) Received: from imap50 ([10.202.2.100]) by compute5.internal (MEProxy); Thu, 19 May 2022 00:02:51 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=dana.is; h=cc:cc :content-transfer-encoding:content-type:date:date:from:from :in-reply-to:in-reply-to:message-id:mime-version:references :reply-to:sender:subject:subject:to:to; s=fm1; t=1652932970; x= 1653019370; bh=oVshPfWWj+EvEnW3cC7yIcHVh40uEkBYOH6khjEhdwo=; b=H rpvbQcD/X/daT9uVItyHcSeNXBKSfDJoNnFqjXdCd5bHGlEOjkZgKbZMTmndPP5a vpH9lrJNmUZ78Ls/4SC/v5KVZXuOb5MEu1I1yHfGGzV3XeGPn8FZOhwbpEK3hSQt XItM4Mm67IkpOUqb1jGShG4VvYYspnrYGzIBJUxrYrWEsv561/2QtDKwGwoZBdr6 gXhdjD+VSraGC2VcUuqaa7a8FCjdOYY9Mv4W0m7M5niIEu/sAUgbQw0fruOwGFQU VWx5tAW8FNuXLgpvPq1uTHCx0W9wfm5ed7OLaTiMndxjzyPI6J2witku/hX3odFC 2sJc37kcbjscPek4Y9I7A== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type:date:date:feedback-id:feedback-id:from:from :in-reply-to:in-reply-to:message-id:mime-version:references :reply-to:sender:subject:subject:to:to:x-me-proxy:x-me-proxy :x-me-sender:x-me-sender:x-sasl-enc; s=fm1; t=1652932970; x= 1653019370; bh=oVshPfWWj+EvEnW3cC7yIcHVh40uEkBYOH6khjEhdwo=; b=T aywxysMO1+je615iFlZNXejxGc/RpVLbEU/66/I79+PNXOkwBJszekYkEtZt+Og+ 0synqrz9uuGvQv2JTBVrdBvqwht1fFw6HQKYOvcVvrloIB0wC6megOQQvy1Kjn2x JYrN0o3PKiVxoH8jAAM+mw+BpO4bT5Czcstj6q8EnO+NUnZ+6+rvcjyIflomKyte j1VJJFuK8QNBzuE3SU7Cd6JAVH2E8Et9OXExochMsow0cWYhcoJVoN19H1Wn5tY3 6r2VudSbcZK04ZohVr/mvhED/PYTVteYuf3/gemX2Njm1I09N4G2PBr9JGS7Ns4T IZwo65ztQyTbP1CCUL3Gg== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvfedriedtgdejlecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpefofgggkfgjfhffhffvvefutgfgsehtqhertderreejnecuhfhrohhmpegurghn rgcuoegurghnrgesuggrnhgrrdhisheqnecuggftrfgrthhtvghrnheptedvkeffueetie evveekfffhtdegudeuudeigfefgfeukedtgfdtffehfeeuhfeunecuvehluhhsthgvrhfu ihiivgeptdenucfrrghrrghmpehmrghilhhfrhhomhepuggrnhgrsegurghnrgdrihhs X-ME-Proxy: Feedback-ID: i9be146f9:Fastmail Received: by mailuser.nyi.internal (Postfix, from userid 501) id 2E920170005F; Thu, 19 May 2022 00:02:50 -0400 (EDT) X-Mailer: MessagingEngine.com Webmail Interface User-Agent: Cyrus-JMAP/3.7.0-alpha0-591-gfe6c3a2700-fm-20220427.001-gfe6c3a27 Mime-Version: 1.0 Message-Id: In-Reply-To: <33e425a1-36a6-4fa6-8a59-a892a7861d93@www.fastmail.com> References: <33e425a1-36a6-4fa6-8a59-a892a7861d93@www.fastmail.com> Date: Wed, 18 May 2022 23:02:29 -0500 From: dana To: =?UTF-8?Q?Lawrence_Vel=C3=A1zquez?= Cc: "Zsh hackers list" , "Bevan Stanely" Subject: Re: Proposal: Use Markdown syntax for README and other documentation Content-Type: text/plain;charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Seq: 50247 Archived-At: X-Loop: zsh-workers@zsh.org Errors-To: zsh-workers-owner@zsh.org Precedence: list Precedence: bulk Sender: zsh-workers-request@zsh.org X-no-archive: yes List-Id: List-Help: List-Subscribe: List-Unsubscribe: List-Post: List-Owner: List-Archive: On Wed 18 May 2022, at 10:41, Bevan Stanely wrote: > As an initial step, I have separated out the list of backward > incompatibilities to the file COMPATIBILITY and formatted the shorter > README I don't feel *super* strongly about this, but i have thought before that the README/NEWS dichotomy was slightly confusing, and that maybe the average person would prefer it if the README just had a shorter overview of the most important information. Not sure about the naming convention but i would personally be OK with breaking the changes out into another file, or combining it with NEWS, and improving the formatting and structure of the rest of the README On Wed 18 May 2022, at 20:10, Lawrence Vel=C3=A1zquez wrote: > While nice for editing, raw markup (even Markdown) makes for a poor > reading experience. I don't think that's necessarily the case, as demonstrated by the fact that Bevan thought we were already using Markdown lol. And we very nearly are I don't think it'd be a big change to have the README standardise on some sub-set of Markdown to make it look a little nicer on code-hosting sites, as long as we continued to avoid the more advanced/noisy features like images and hyper-links But i feel even less strongly about that than the other thing dana