Re: Reworking the cookbook layout

2019-11-27 Thread Bengt Richter
On +2019-11-27 12:08:00 +0100, zimoun wrote: > Hi, > > Thank you to open the discussion about the Cookbook. > > The first thing is: what is the purpose of the Cookbook? I mean I am > not sure we all define the same object with the same goal. > > Currently, it is all what cannot be included in th

Re: Reworking the cookbook layout

2019-11-27 Thread Julien Lepiller
Le 27 novembre 2019 16:26:06 GMT+01:00, zimoun a écrit : >I break the usual rules of reply. Hope that will be ok. :-) > > >On Wed, 27 Nov 2019 at 13:14, Julien Lepiller >wrote: > >> Le 27 novembre 2019 12:08:00 GMT+01:00, zimoun > a écrit : > >> >On Tue, 26 Nov 2019 at 23:12, Julien Lepiller >

Re: Reworking the cookbook layout

2019-11-27 Thread zimoun
I break the usual rules of reply. Hope that will be ok. :-) On Wed, 27 Nov 2019 at 13:14, Julien Lepiller wrote: > Le 27 novembre 2019 12:08:00 GMT+01:00, zimoun a > écrit : > >On Tue, 26 Nov 2019 at 23:12, Julien Lepiller > >The first thing is: what is the purpose of the Cookbook? I mean

Re: Reworking the cookbook layout

2019-11-27 Thread sirgazil
On Wed, 27 Nov 2019 05:21:22 -0500 Pierre Neidhardt wrote > No strong opinion here, it seems to be a good idea. > > My only current itch with the cookbook is that it might have too deep a > hierarchy. Personally, I prefer to put the @menu before the @contents because the form

Re: Reworking the cookbook layout

2019-11-27 Thread Julien Lepiller
Le 27 novembre 2019 12:08:00 GMT+01:00, zimoun a écrit : >Hi, > >Thank you to open the discussion about the Cookbook. > >The first thing is: what is the purpose of the Cookbook? I mean I am >not sure we all define the same object with the same goal. > >Currently, it is all what cannot be included

Re: Reworking the cookbook layout

2019-11-27 Thread zimoun
Hi, Thank you to open the discussion about the Cookbook. The first thing is: what is the purpose of the Cookbook? I mean I am not sure we all define the same object with the same goal. Currently, it is all what cannot be included in the Reference Manual. So do we need to organize all this materi

Re: Reworking the cookbook layout

2019-11-27 Thread Pierre Neidhardt
No strong opinion here, it seems to be a good idea. My only current itch with the cookbook is that it might have too deep a hierarchy. -- Pierre Neidhardt https://ambrevar.xyz/ signature.asc Description: PGP signature

Reworking the cookbook layout

2019-11-26 Thread Julien Lepiller
Hi Guix! Today I have been reading https://www.divio.com/blog/documentation/ which makes some good points on how to write good documentation. They suggest to divide documentation into four categories, depending on their purpose: - tutorials, written for newcomers. They should be to the point and