From mboxrd@z Thu Jan  1 00:00:00 1970
From: ludo@gnu.org (Ludovic =?UTF-8?Q?Court=C3=A8s?=)
Subject: bug#32845: guix.info: Missing manual
Date: Fri, 28 Sep 2018 22:08:16 +0200
Message-ID: <877ej51j2n.fsf@gnu.org>
References: <87y3bolf9v.fsf@ambrevar.xyz> <874lect9x0.fsf@elephly.net>
	<87efdgjb7h.fsf@ambrevar.xyz> <87zhw4rpel.fsf@elephly.net>
	<87ftxv3vf4.fsf@gnu.org> <87r2hfrmcf.fsf@elephly.net>
	<87va6q2652.fsf@ambrevar.xyz>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Return-path: <bug-guix-bounces+gcggb-bug-guix=m.gmane.org@gnu.org>
Received: from eggs.gnu.org ([2001:4830:134:3::10]:39604)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <Debian-debbugs@debbugs.gnu.org>) id 1g5z4R-0002Nz-M3
	for bug-guix@gnu.org; Fri, 28 Sep 2018 16:09:04 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <Debian-debbugs@debbugs.gnu.org>) id 1g5z4Q-0007by-NQ
	for bug-guix@gnu.org; Fri, 28 Sep 2018 16:09:03 -0400
Received: from debbugs.gnu.org ([208.118.235.43]:53752)
	by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16)
	(Exim 4.71) (envelope-from <Debian-debbugs@debbugs.gnu.org>)
	id 1g5z4Q-0007bd-HT
	for bug-guix@gnu.org; Fri, 28 Sep 2018 16:09:02 -0400
Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2)
	(envelope-from <Debian-debbugs@debbugs.gnu.org>) id 1g5z4Q-0004Xn-7G
	for bug-guix@gnu.org; Fri, 28 Sep 2018 16:09:02 -0400
Sender: "Debbugs-submit" <debbugs-submit-bounces@debbugs.gnu.org>
Resent-Message-ID: <handler.32845.B32845.153816530617421@debbugs.gnu.org>
In-Reply-To: <87va6q2652.fsf@ambrevar.xyz> (Pierre Neidhardt's message of
	"Thu, 27 Sep 2018 19:37:45 +0200")
List-Id: Bug reports for GNU Guix <bug-guix.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/bug-guix>,
	<mailto:bug-guix-request@gnu.org?subject=unsubscribe>
List-Archive: <http://lists.gnu.org/archive/html/bug-guix/>
List-Post: <mailto:bug-guix@gnu.org>
List-Help: <mailto:bug-guix-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/bug-guix>,
	<mailto:bug-guix-request@gnu.org?subject=subscribe>
Errors-To: bug-guix-bounces+gcggb-bug-guix=m.gmane.org@gnu.org
Sender: "bug-Guix" <bug-guix-bounces+gcggb-bug-guix=m.gmane.org@gnu.org>
To: Pierre Neidhardt <mail@ambrevar.xyz>
Cc: 32845@debbugs.gnu.org

Pierre Neidhardt <mail@ambrevar.xyz> skribis:

>> Currently, the manual shown on guix.info is fairly close to the latest
>> in git.  This means it contains documentation about channels, which
>> cannot be found in the latest release that matches the manual on
>> gnu.org.
>
> This is crucial, I believe.  I believe.  "Static" documentation is a Bad =
Idea.
> I think the manual is better than a wiki, but only if contributors can wo=
rk on
> it "live".

One obvious problem with documentation on the web is that it=E2=80=99s hard=
 to
tell if it matches the version of what you=E2=80=99re actually using.  (Tha=
t=E2=80=99s
one of the reasons for the =E2=80=9CDocumentation=E2=80=9D section in the m=
anual.)

The only reason IMO that justifies keeping =E2=80=9Cstatic=E2=80=9D documen=
tation (for
the latest release) is the installation instructions: these may change
anytime in =E2=80=98master=E2=80=99, but it=E2=80=99s important that those =
on-line match what
people will actually download.

Thoughts?

Ludo=E2=80=99.