Re: extending the documentation of the Scheme API

[Pjotr Prins <pjotr.public12@thebird.nl>]

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,
> > 
> > we have lots of nice macros and procedures in Guix that aren’t
> > documented beyond their docstrings.
> > 
> > Should we snarf the docstrings and add them to the manual?
> > 
> > --
> > Ricardo
> > 
> > 
> I don't care where it goes, but is there maybe a better place than the guix
> manual?
> 
> 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 guix
> api reference manual as a reference for `guix repl` and more complex package
> and service production.
> 
> 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.