From mboxrd@z Thu Jan  1 00:00:00 1970
From: Pjotr Prins <pjotr.public12@thebird.nl>
Subject: Re: extending the documentation of the Scheme API
Date: Sat, 21 Dec 2019 06:24:42 -0600
Message-ID: <20191221122442.w7o5ffuciex4fydz@thebird.nl>
References: <87sgleprp6.fsf@elephly.net>
 <77d56dafca86b5b86f3a64c92e65a2588af2207c.camel@gmail.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Return-path: <guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org>
Received: from eggs.gnu.org ([2001:470:142:3::10]:57196)
 by lists.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <pjotr2019@thebird.nl>) id 1iidv5-0002Fs-JB
 for guix-devel@gnu.org; Sat, 21 Dec 2019 07:31:44 -0500
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
 (envelope-from <pjotr2019@thebird.nl>) id 1iidv4-0002zx-4K
 for guix-devel@gnu.org; Sat, 21 Dec 2019 07:31:43 -0500
Received: from mail.thebird.nl ([94.142.245.5]:58558)
 by eggs.gnu.org with esmtp (Exim 4.71)
 (envelope-from <pjotr2019@thebird.nl>) id 1iidv3-0002xq-Qj
 for guix-devel@gnu.org; Sat, 21 Dec 2019 07:31:42 -0500
Content-Disposition: inline
In-Reply-To: <77d56dafca86b5b86f3a64c92e65a2588af2207c.camel@gmail.com>
List-Id: "Development of GNU Guix and the GNU System distribution."
 <guix-devel.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/guix-devel>,
 <mailto:guix-devel-request@gnu.org?subject=unsubscribe>
List-Archive: <https://lists.gnu.org/archive/html/guix-devel>
List-Post: <mailto:guix-devel@gnu.org>
List-Help: <mailto:guix-devel-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/guix-devel>,
 <mailto:guix-devel-request@gnu.org?subject=subscribe>
Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org
Sender: "Guix-devel" <guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org>
To: Jesse Gibbons <jgibbons2357@gmail.com>
Cc: Guix-devel <guix-devel@gnu.org>

On Fri, Dec 20, 2019 at 09:04:16PM -0700, Jesse Gibbons wrote:
> On Fri, 2019-12-20 at 23:17 +0100, Ricardo Wurmus wrote:
> > Hi Guix,
> >=20
> > we have lots of nice macros and procedures in Guix that aren=E2=80=99=
t
> > documented beyond their docstrings.
> >=20
> > Should we snarf the docstrings and add them to the manual?
> >=20
> > --
> > Ricardo
> >=20
> >=20
> I don't care where it goes, but is there maybe a better place than the =
guix
> manual?
>=20
> Am I alone in thinking it makes sense to produce a "guix api reference
> manual"? The guix manual is already fairly large. We can treat the guix
> manual as a manual for setting up guix and using it from a shell, the g=
uix
> api reference manual as a reference for `guix repl` and more complex pa=
ckage
> and service production.
>=20
> This is just something I think we should consider.

How about a Guix hackers manual? Bliss from the REPL. I think that is
one of the key assets of Guix while it is still pretty hard to get at
without documentation.

Pj.