From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: dsmich@roadrunner.com Newsgroups: gmane.lisp.guile.devel Subject: Re: a cookbook Date: Mon, 14 Feb 2022 22:00:04 +0000 Message-ID: Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="=_676d3b41c5fe3f2c6ca6d5d5da1b594f" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="12807"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 'guile-devel' To: "'Vijay Marupudi'" Original-X-From: guile-devel-bounces+guile-devel=m.gmane-mx.org@gnu.org Mon Feb 14 23:01:12 2022 Return-path: Envelope-to: guile-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nJjPE-00037R-2P for guile-devel@m.gmane-mx.org; Mon, 14 Feb 2022 23:01:12 +0100 Original-Received: from localhost ([::1]:56924 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nJjPC-0008UI-BW for guile-devel@m.gmane-mx.org; Mon, 14 Feb 2022 17:01:10 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:35278) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nJjOY-0008Sf-5F for guile-devel@gnu.org; Mon, 14 Feb 2022 17:00:30 -0500 Original-Received: from p-impout006aa.msg.pkvw.co.charter.net ([47.43.26.137]:44220 helo=p-impout006.msg.pkvw.co.charter.net) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nJjOT-0003Z1-3p for guile-devel@gnu.org; Mon, 14 Feb 2022 17:00:29 -0500 Original-Received: from localhost ([52.86.171.38]) by cmsmtp with ESMTP id JjO8nF8eDJrGlJjO9nw8GQ; Mon, 14 Feb 2022 22:00:05 +0000 X-Authority-Analysis: v=2.4 cv=PIscRNmC c=1 sm=1 tr=0 ts=620ad0e5 a=KRKCKI1VKQ4u2uwitZ6MRA==:117 a=KRKCKI1VKQ4u2uwitZ6MRA==:17 a=KTtA7ReM4oAA:10 a=Z0QMfBvOMwEA:10 a=pyRaz854AAAA:8 a=eoj2QmFzaB1iRaCQPjcA:9 a=QEXdDO2ut3YA:10 a=flVGzeV_AAAA:8 a=MYyFUiaCoPzmaEG9mr4A:9 a=Yc8uXf5YTP2UhdP8:21 a=_W_S_7VecoQA:10 a=CfZrmnkZ5DPcdgvFUTMh:22 a=bwlETf49wTIvOTEbNpu0:22 X-Mailer: Atmail X-Originating-IP: [63.87.53.154] X-Priority: 3 Importance: Normal X-MSMail-Priority: Normal X-CMAE-Envelope: MS4xfEL/AwojPqbTIGiJHa2fADgRkwcarGbT6YAfSzkJ2g+WMQSqKw8kNy1hoHkLX1a16MuYg3YMyfoZAnq1jBTfpG2ZKt3oA2umzaxyFftKdCB5qyggAP+c s32x3ffA1ccK6QQg1gxdWLdqxTLThxb65lZFdHmj6wcB0J72Rip2dlE8bDoaQZ3OK/VNgaOOtnnIJ/HYEjqwAMif/78WgUfvZBbbNVvmhTeU8omGvzfypbeC SFKcu4ARnyFJJjOIbf3pFw== Received-SPF: pass client-ip=47.43.26.137; envelope-from=dsmich@roadrunner.com; helo=p-impout006.msg.pkvw.co.charter.net X-Spam_score_int: 0 X-Spam_score: -0.0 X-Spam_bar: / X-Spam_report: (-0.0 / 5.0 requ) BAYES_00=-1.9, HTML_MESSAGE=0.001, MISSING_MIMEOLE=1.899, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: guile-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Developers list for Guile, the GNU extensibility library" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guile-devel-bounces+guile-devel=m.gmane-mx.org@gnu.org Original-Sender: "guile-devel" Xref: news.gmane.io gmane.lisp.guile.devel:21116 Archived-At: --=_676d3b41c5fe3f2c6ca6d5d5da1b594f Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable > From: "Vijay Marupudi" =0A> To: "Catonano", "guile-devel"=0A> Subject:= Re: a cookbook=0A=0A> > Is there any interest/possibility to have such= a cookbook hosted=0A> > within the Guile official documentation (as it= is for Guix) ?=0A=0A> I personally think that a Cookbook should be an i= ndependent effort,=0A> with=0A> links from the Guile Manual if possible.= This would lighten the load=0A> on=0A> the maintainers, and allow for q= uicker collaboration.=0A=0AI found this interesting: https://diataxis.fr= /=0A=0AClassifies documentation into 4 types=0A=0ATutorials: Learning or= iented=0AHow-To Guides: Task oriented=0AExplanation: Understanding orien= ted=0AReference: Information oriented=0A=0AThe Guile Manual is a Referen= ce. Mainly a Reference. There are some=0Atutorial-like things in it, and= some explanations, but not much.=0A=0AIt really would be good to have m= ore non-reference documentation.=0A=0A-Dale=0A=0A --=_676d3b41c5fe3f2c6ca6d5d5da1b594f Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable > From: "Vijay Marupudi"
>= ; To: "Catonano", "guile-devel"
> Subject: Re: a cookbook

&= gt; > Is there any interest/possibility to have such a cookbook hoste= d
> > within the Guile official documentation (as it is for Gui= x) ?
=0A
> I personally think that a Cookbook should be an inde= pendent effort,
> with
> links from the Guile Manual if poss= ible. This would lighten the load
> on
> the maintainers, an= d allow for quicker collaboration.

I found this interesting: http= s://diataxis.fr/

Classifies documentation into 4 types

Tut= orials:  Learning oriented
How-To Guides: Task oriented
Expla= nation: Understanding oriented
Reference: Information oriented
The Guile Manual is a Reference.  Mainly a Reference.  There= are some tutorial-like things in it, and some explanations, but not muc= h.

It really would be good to have more non-reference documentati= on.

-Dale


=0A --=_676d3b41c5fe3f2c6ca6d5d5da1b594f--