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.4 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,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 13454 invoked from network); 19 May 2022 15:16:37 -0000 Received: from zero.zsh.org (2a02:898:31:0:48:4558:7a:7368) by inbox.vuxu.org with ESMTPUTF8; 19 May 2022 15:16:37 -0000 ARC-Seal: i=1; cv=none; a=rsa-sha256; d=zsh.org; s=rsa-20210803; t=1652973397; b=KA4k5wLmUcr6v3kwNFfYHjuUf5/lya0IfnYmlQnmN5hASV/UyOzoyzLG6LfNlkQODSpppYCsmS 6Y6wpWRBofw5c55Z5W2g0pf62E2Mcavr0e/hiIE8pBkTfaO2fbGeVdP4hxlMQo4zomRJQg5kH0 yvShYTOexHhDOMSEj4+PXU6BKgOWswu4PTev35fYGOGKzdv7V1rhOX6JEYUmeXCBr4q3ML8OK3 5MzQ5yPYgT9B7W+GLxsVkDJgrGJPBuXROT2GUdFtwEbimCuWSBrkrhf+dFWbVWub7p52NpVMKQ dBDoYF1stVPiZir0SLrBj/wCMaPxYgqx2Ic2g3Mix7jlNg==; ARC-Authentication-Results: i=1; zsh.org; iprev=pass (smtpq2.tb.ukmail.iss.as9143.net) smtp.remote-ip=212.54.57.97; dkim=pass header.d=ntlworld.com header.s=meg.feb2017 header.a=rsa-sha256; dmarc=pass header.from=ntlworld.com; arc=none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed; d=zsh.org; s=rsa-20210803; t=1652973397; bh=bFPhHcr+nwT8LTRGEYynrzJopo0CRDoXSJ+i376gQCU=; h=List-Archive:List-Owner:List-Post:List-Unsubscribe:List-Subscribe:List-Help: List-Id:Sender:Content-Transfer-Encoding:Content-Type:MIME-Version:Subject: References:In-Reply-To:Message-ID:To:From:Date:DKIM-Signature: DKIM-Signature; b=Xrl6vg4m/kRRgTjv5qVIYRT3cRp30wDR3k9u1LOKrq5gCXemnfl1xnFG8QhxLOIZ+erV0hOrbp p2jbmByfiLPbRL1oT1qk0phZpLxGYmZmmU/HS41JV9jRtMhKfTD2hB1Ga7N8PD520RIza+YhMC ka7tkEo0KDS6B8XbMb4ird3jx6owmjJp+n5np2ch8RmF5jbVM2VDObPnvTCGTKo/WMOqsIKP5N HtEz5soAmXYR/EExXazsEZ0hnTg1RRKehsYa1ypYShxe38XRic9puoDqOYx3uKdQTX+RfByQeh lXRUsKy0yeboLni87K0ZEUfKWTRihseOpjmCAklqDuf/Ag==; 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:MIME-Version:Subject:References:In-Reply-To:Message-ID:To:From: Date:Reply-To:Cc:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID; bh=bFPhHcr+nwT8LTRGEYynrzJopo0CRDoXSJ+i376gQCU=; b=ZitfUFvp6oVC7+KY77PU6/hPDJ 0kpp3sVYvKaABLml5t2MiNS/1WZ4TfFRBw1dFH6P1HMnxWrSgS+Np5M+8C3xjbIPv35oxObwW/FZM ryafNDcvetX+8nqBAMdlgNUZTY1T8QpDKmlNL8eDMbJE45pZ/S4Gi93/SBHYNNBRb+1b3Kssaw/X3 yguwD2dZDVDvIR2LHpCZ0jTU/EFNstFuTQjXPGPbhtziACX8YFQkCMP2mOVFyszkX5RsgjGa8e4oC muHvzzT6yojf5vT5F0kov9NLBmIMjvZ6xuaVXnRI9fgywrbn/ODzZuGrK+MBlHpF1Q/N2rbywIf+J 1PJvOnIA==; Received: from authenticated user by zero.zsh.org with local id 1nrhtF-000DLJ-3r; Thu, 19 May 2022 15:16:37 +0000 Authentication-Results: zsh.org; iprev=pass (smtpq2.tb.ukmail.iss.as9143.net) smtp.remote-ip=212.54.57.97; dkim=pass header.d=ntlworld.com header.s=meg.feb2017 header.a=rsa-sha256; dmarc=pass header.from=ntlworld.com; arc=none Received: from smtpq2.tb.ukmail.iss.as9143.net ([212.54.57.97]:47724) by zero.zsh.org with esmtps (TLS1.2:ECDHE-RSA-AES256-GCM-SHA384:256) id 1nrhsx-000D0b-14; Thu, 19 May 2022 15:16:19 +0000 Received: from [212.54.57.81] (helo=smtp2.tb.ukmail.iss.as9143.net) by smtpq2.tb.ukmail.iss.as9143.net with esmtp (Exim 4.90_1) (envelope-from ) id 1nrhsw-0007sZ-Mi for zsh-workers@zsh.org; Thu, 19 May 2022 17:16:18 +0200 Received: from oxbe13.tb.ukmail.iss.as9143.net ([172.25.160.144]) by smtp2.tb.ukmail.iss.as9143.net with ESMTP id rhswnE8G1v24mrhswnOs56; Thu, 19 May 2022 17:16:18 +0200 X-Env-Mailfrom: p.w.stephenson@ntlworld.com X-Env-Rcptto: zsh-workers@zsh.org X-SourceIP: 172.25.160.144 X-CNFS-Analysis: v=2.4 cv=LKR1/ba9 c=1 sm=1 tr=0 ts=62865f42 cx=a_exe a=wuFMYA7voKp1dZz7Z+vj5Q==:117 a=wbvTLvLwOfMA:10 a=IkcTkHD0fZMA:10 a=7H6ixmLU1AQA:10 a=OETlz8OZwiFvvAe8nIkA:9 a=QEXdDO2ut3YA:10 X-Authenticated-Sender: p.w.stephenson@ntlworld.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ntlworld.com; s=meg.feb2017; t=1652973378; bh=bFPhHcr+nwT8LTRGEYynrzJopo0CRDoXSJ+i376gQCU=; h=Date:From:To:In-Reply-To:References:Subject; b=q2BfdF23+TAkCOWd2E9xUaB3faieYDoKaVxXdT6LrbKR38n0mpIn6Yf0R/AKwVKIj swZ+vzE7qWxIOq7FKWO/fTcRRvou0U6/JilV7xhgkzrlP5DbqXUEPlnPMZ3BPmoZd7 cJFAN56doaRW7mtFeAHoDg3VZlsAAqsXs2NGPNJ1Pj99bmquXeV86WzVjfF1ibNvj0 WpXDywFJ6MSvzt3lUcTc53wSLG95tS2LgHer1+R/wZNx7qiyZyLkkppCmRUSpaO8N+ 8cAg/7/w/FldAaArr2OgeBP4lFQAbNwiyYlgw//4uphFwGoIDIs3DT4pEMje8D9TcI tNrxRIGSVW7kQ== Date: Thu, 19 May 2022 16:16:18 +0100 (BST) From: Peter Stephenson To: Bevan Stanely , zsh-workers@zsh.org Message-ID: <606077703.223769.1652973378609@mail2.virginmedia.com> In-Reply-To: References: <33e425a1-36a6-4fa6-8a59-a892a7861d93@www.fastmail.com> <1540829696.208973.1652950518801@mail2.virginmedia.com> Subject: Re: Proposal: Use Markdown syntax for README and other documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-Priority: 3 Importance: Medium X-Mailer: Open-Xchange Mailer v7.8.4-Rev72 X-Originating-IP: 147.161.167.85 X-Originating-Client: open-xchange-appsuite X-CMAE-Envelope: MS4xfJXd8VCBSWDKNHzQA40XUS9KBE1WOaZKaU5AWu5M7XgW/Uz58pSfXSVVVBy0Of0Zcmn12EgWlmCqg0lbCktyABzQtSrmgR6QCPNecF52rseVxOJPZaNB 30Sz1mcfHvqQPSZ6IWMkNEkMcbIJbFlnBUGYx/VUoDVp/1aT7UnWb+rCWMPB4/2vFU9bS9R8PdGn23Aysl/WSa73hkoTaOJDS1nvOLdEmIW+YUbG6lqZJfZk JjBuQDj57+VWIgB4lDKWa27f9TK5v3Uj2i2J1+8m9YE= X-Seq: 50253 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 19 May 2022 at 16:10 Bevan Stanely 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. pws