From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:403:4789::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms9.migadu.com with LMTPS id 2Kc6CcRs7GTRCAAA9RJhRA:P1 (envelope-from ) for ; Mon, 28 Aug 2023 11:45:40 +0200 Received: from aspmx1.migadu.com ([2001:41d0:403:4789::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id 2Kc6CcRs7GTRCAAA9RJhRA (envelope-from ) for ; Mon, 28 Aug 2023 11:45:40 +0200 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 91E915B962 for ; Mon, 28 Aug 2023 11:45:39 +0200 (CEST) Authentication-Results: aspmx1.migadu.com; dkim=none; spf=pass (aspmx1.migadu.com: domain of "guix-devel-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-devel-bounces+larch=yhetil.org@gnu.org"; dmarc=none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1693215940; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post; bh=jhAOb63/wAtCjieat1vIRXOrLubHUmiOALzC3I6pywc=; b=AYJMP2b/uXMzMa3vPEqz3EUcOz9/Wq/KOsBTjhz01QA/a0SGrsqlG70/Ka4UxYh7wXhOJQ v3EMwG2OoaZYeucpS/nCoyuWR0Sv+QOiWtK5s7IL9ktGWKuI8tr3b0Ji56BCtjsE7msukE 4J2IITcINtgF5eMyUbf4gjbHy8SHgdW6ybmxPEnzn/8eO2QCsmx9xzkZ1mfwb5noT9dlS6 ECWlJRHBvRLyCFxXaxVaw56T+mJh3exD4I839SnO7xz3Tnbn1cN0lpDnqgoO3FreaLNZ3Q JGtChawwsFweSrW//lnT6PzBlEpsVbRBcp2VquISKSPFrptgcWTDK+Hh3r6d9A== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1693215940; a=rsa-sha256; cv=none; b=mHG/ojdjwH8FtkAK51l6nkpplznqnMSLkNQfShLgeDq3Bj5uCxDXRQU74Ntn/BKduI1wgu d0/5xCTuybFqcPjhOI87zZuaka27Yf+iT9iMt2szPdc9s9HyYQGstD+PSE39EboClUk8Mf Uai2TJH/Fqv2WW+EwkAV3V053zei64aT5HqARQUxAsUWIhD3HQ3dMrbBir1AeSdGwhUUUH 0tlJ2ClUkXxOkWG+cQ2Xl8cc4H1MY5sZO6OzfcuhPe/7Wa2D6adyVGdHtTrsT+JwyP53HE 99Z/fVS0GF0MPDiKAot1UQ71rIg+A60DM9+k9Y4AyBTZIgl2HbzER034cxrRbw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; spf=pass (aspmx1.migadu.com: domain of "guix-devel-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-devel-bounces+larch=yhetil.org@gnu.org"; dmarc=none Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qaYns-0006RL-Mi; Mon, 28 Aug 2023 05:45:00 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qaYnn-0006RB-SQ for guix-devel@gnu.org; Mon, 28 Aug 2023 05:44:56 -0400 Received: from ns13.heimat.it ([46.4.214.66]) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qaYnk-00027U-Jx for guix-devel@gnu.org; Mon, 28 Aug 2023 05:44:55 -0400 Received: from localhost (ip6-localhost [127.0.0.1]) by ns13.heimat.it (Postfix) with ESMTP id 8E97A3008E0; Mon, 28 Aug 2023 09:44:50 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at ns13.heimat.it Received: from ns13.heimat.it ([127.0.0.1]) by localhost (ns13.heimat.it [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id sMNLNTgQJzII; Mon, 28 Aug 2023 09:44:48 +0000 (UTC) Received: from bourrache.mug.xelera.it (unknown [93.56.171.217]) (using TLSv1.2 with cipher ECDHE-ECDSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by ns13.heimat.it (Postfix) with ESMTPSA id 49B2E3008B3; Mon, 28 Aug 2023 09:44:48 +0000 (UTC) Received: from roquette.mug.biscuolo.net (roquette [10.38.2.14]) by bourrache.mug.xelera.it (Postfix) with SMTP id B7C0E293C254; Mon, 28 Aug 2023 11:44:47 +0200 (CEST) Received: (nullmailer pid 2413 invoked by uid 1000); Mon, 28 Aug 2023 09:44:46 -0000 From: Giovanni Biscuolo To: Josselin Poiret , Maxim Cournoyer , Katherine Cox-Buday Cc: Csepp , guix-devel@gnu.org Subject: Re: How can we decrease the cognitive overhead for contributors? In-Reply-To: <878r9w6ftu.fsf@jpoiret.xyz> Organization: Xelera.eu References: <871qfsayyx.fsf@riseup.net> <875y51jijv.fsf@gmail.com> <878r9w6ftu.fsf@jpoiret.xyz> Date: Mon, 28 Aug 2023 11:44:34 +0200 Message-ID: <87ledva4cd.fsf@xelera.eu> MIME-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha512; protocol="application/pgp-signature" Received-SPF: pass client-ip=46.4.214.66; envelope-from=g@xelera.eu; helo=ns13.heimat.it X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: guix-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+larch=yhetil.org@gnu.org Sender: guix-devel-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Spam-Score: -3.44 X-Spam-Score: -3.44 X-Migadu-Queue-Id: 91E915B962 X-Migadu-Scanner: mx1.migadu.com X-TUID: KG4/+grTQ2fH --=-=-= Content-Type: text/plain Content-Transfer-Encoding: quoted-printable Hi, Josselin Poiret writes: > Maxim Cournoyer writes: > >> Texinfo is mostly just plain text until you learn about a few decorators >> :-). It gives us the info manuals that I find very nifty (it's like a >> man page, but with hyperlinks and advanced navigation capabilities!) and >> used across many GNU projects (e.g. coreutils, Emacs, Bash, GCC, GNU >> Make, etc.) I see it as a strength more than a weakness for the >> project. > > I agree with Maxim here, I think the texinfo markup is important to be > able to generate such a nice manual my 2 cents... I've studied and used (some less than others) many available "lightweight markup language" for documentation purposes: LaTeX, markdown (manu flavours), restructured-text, AsciiDoc, org-mode, Texinfo in my experience markdown - thus every wiki periodically is the alleged missing tool - is _not_ suited at all for documentation, it lacks so many _semantics_ needed for documentation purposes. given that markdown (and a wiki) is not suitable for the task of "writing good documentation", more or less all other markup languages are of good quality, including Texinfo additionally, Texinfo can be browsed directly - I mean without being transformed in the final output format - by several programs [1], some of them packaged in Guix: emacs, info-reader, pinfo, khelpcenter (GUI), yelp (GUI); quite good choiche of Texinfo readers. after all, Texinfo is a wise choiche IMO. [...] Happy hacking, Gio' P.S.: not that Texinfo is the best /document programming framework/ (yes: the book is a program), the best ones are skribilo (Guile) and Pollen (https://docs.racket-lang.org/pollen/)... and org-mode publish :-) [1] https://en.wikipedia.org/wiki/Info_(Unix)#List_of_Info_readers =2D-=20 Giovanni Biscuolo Xelera IT Infrastructures --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQJABAEBCgAqFiEERcxjuFJYydVfNLI5030Op87MORIFAmTsbIMMHGdAeGVsZXJh LmV1AAoJENN9DqfOzDkSUs4QANMOcKfXzFOkf3Ojq1nUxuzrv8aP7MMSzHbjlnW1 o23KFmIp0Bi2vQKaSvareKASYOk065/lxQf3D2qAEWbZT4s1sP5rURIR2mwjPDi1 kjusriPMnTxa1zVwVRgUU62xKtDLafaihaSE3R8leD/0IxZMKJ6eMmLyoRLyW35o MJP+rBORkMpTrtqWhpDLjWfJfXz+F2xQd6bTiO1ulwy24dBvYsmjuOfFkZ+1ih9Q csfuO38OKzSVqD+/hHDLYNNcyt1A5oSVJscgVvw04Km/wkh+t8ydK6CZ5d5L5vKr cbwBu56/eDyiMi6lq3hY2wp6Dlag8OlF0nm5DEma8rC7gIA7MISzeoe1MAedfMTf Iuk/4Ce6aNamTLYlBSBFeAFnwUp+RbPtJSvUHrkzHhhCUi5ahyKCtgj3gZYvMEte dXqxBgPnuhWQ0LNe/8JuOxSR62zGLwL179LoyypOVuR0CTC130X4JFaEl4diCAAu gfbM9cqxNH4+3IVrqoiDohkQvvf8YDIKRZMoE5UI7TjptKNSAA+ptlZkKBhX8IMv F+J7SxtzrepisRHTjtVey6PQFb0U/GmXD1lPqI3RReLSv70B8WCRWlWg8yeOTiya 8mBLq0yPIRmOjzlpMBKWYwl2h4mIjJr5g82Jift+T5pmnnEZVBar3UHWCSrV4/VS 1vsC =LQQx -----END PGP SIGNATURE----- --=-=-=--