dragora-members
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Dragora-members] Dragora Handbook: Structural draft


From: Michael Siegel
Subject: Re: [Dragora-members] Dragora Handbook: Structural draft
Date: Wed, 23 Sep 2020 13:35:30 +0200
User-agent: Mozilla/5.0 (X11; Linux i686; rv:68.0) Gecko/20100101 Thunderbird/68.12.0

Am 22.09.20 um 21:20 schrieb Matias Fonzo:
> El 2020-09-18 19:24, Michael Siegel escribió:
>> Hi everyone,
>>
>> below is a (still relatively rough) draft for the structure of the
>> future Dragora Handbook. It is mainly based on work I've done on the
>> Devuan project a while back.[1]
>>
>> Let me know what you think.
>>
> 
> Looks good and organized! :-)

Thanks.

> Question: it seems good to (all of) you the idea of using Texinfo to
> compose the handbook, including the external guides like the Qi guide,
> to compose 1 handbook; it would be available both for "info" users in
> the system and for people who want to read it online, also providing the
> PDF or other format through the texinfo tools.

I think this is a good choice, even though it probably means I'll have
to learn Texinfo.

I've thought about two aspects of the Handbook template a bit more:

>> The Dragora GNU/Linux-Libre [MAJOR VERSION].x.y Handbook

I'm not sure if using [MAJOR VERSION].x.y really goes together with
semantic versioning. I guess it doesn't because a change in the minor
version number (x) could mean that additional features are introduced
(as long as they don't break backwards compatibility). The only thing in
that version number that would never affect the Handbook's content would
be a changing patch level (y).

So, it would, I think, make sense to say

  [MAJOR VERSION].[MINOR VERSION]

and leave out the patch level completely.

>>   * Typographical (and possibly other) conventions, either directly or
>>     via pointer to Appendix

Typographical and other conventions used in the book should be kept
short anyway, so I don't think this should be put into an appendix.

Texinfo probably defines some typographical conventions already.


--Michael



reply via email to

[Prev in Thread] Current Thread [Next in Thread]