unofficial mirror of bug-guix@gnu.org 
 help / color / mirror / code / Atom feed
From: ludo@gnu.org (Ludovic Courtès)
To: Pierre Neidhardt <mail@ambrevar.xyz>
Cc: 32845@debbugs.gnu.org
Subject: bug#32845: guix.info: Missing manual
Date: Fri, 28 Sep 2018 22:08:16 +0200	[thread overview]
Message-ID: <877ej51j2n.fsf@gnu.org> (raw)
In-Reply-To: <87va6q2652.fsf@ambrevar.xyz> (Pierre Neidhardt's message of "Thu, 27 Sep 2018 19:37:45 +0200")

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 work on
> it "live".

One obvious problem with documentation on the web is that it’s hard to
tell if it matches the version of what you’re actually using.  (That’s
one of the reasons for the “Documentation” section in the manual.)

The only reason IMO that justifies keeping “static” documentation (for
the latest release) is the installation instructions: these may change
anytime in ‘master’, but it’s important that those on-line match what
people will actually download.

Thoughts?

Ludo’.

  reply	other threads:[~2018-09-28 20:09 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-26 10:33 bug#32845: guix.info: Missing manual Pierre Neidhardt
2018-09-26 18:01 ` Ricardo Wurmus
2018-09-26 19:44   ` Pierre Neidhardt
2018-09-26 20:10     ` Ricardo Wurmus
2018-09-27 13:46       ` Ludovic Courtès
2018-09-27 15:28         ` Ricardo Wurmus
2018-09-27 17:37           ` Pierre Neidhardt
2018-09-28 20:08             ` Ludovic Courtès [this message]
2018-09-28 20:03           ` Ludovic Courtès
2018-09-28 20:38             ` Ricardo Wurmus
2018-09-28 20:39             ` Tobias Geerinckx-Rice
2018-09-29 16:14               ` Ludovic Courtès
2020-01-25 18:00 ` sirgazil via Bug reports for GNU Guix
2020-01-28 10:28   ` Ludovic Courtès

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=877ej51j2n.fsf@gnu.org \
    --to=ludo@gnu.org \
    --cc=32845@debbugs.gnu.org \
    --cc=mail@ambrevar.xyz \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).