Re: RFC: add more setups to Guix docs (was: The e(macs)lephant in the room and the Guix Bang)

[Simon Tournier <zimon.toutoune@gmail.com>]

Hi Ekaitz,

On Mon, 25 Sep 2023 at 14:25, Ekaitz Zarraga <ekaitz@elenq.tech> wrote:

> I decided to go for the action instead of discussion.

Nice initiative!

> Are maintainers open to add some section like this to the manual?

I am not maintainer and I have nothing against. :-)

Well, I do not know if you plan to iterate.  Here minor comments while
reading it, in case.


> --- a/doc/contributing.texi
> +++ b/doc/contributing.texi
> @@ -23,6 +23,7 @@ Contributing
>  * Building from Git::           The latest and greatest.
>  * Running Guix Before It Is Installed::  Hacker tricks.
>  * The Perfect Setup::           The right tools.
> +* Alternative Setups::          Other posible tools that do the job.
>  * Packaging Guidelines::        Growing the distribution.
>  * Coding Style::                Hygiene of the contributor.
>  * Submitting Patches::          Share your work.
> @@ -448,6 +449,76 @@ The Perfect Setup
>  Emacs Manual} and @ref{Minor Mode,,, debbugs-ug, The Debbugs User
>  Guide}.
>  
> +@node Alternative Setups
> +
> +Other setups may let you work on Guix with a similar development
> +experience, but using an editor that is not as powerful as Emacs, but
> +they might work better with the tools you currently use or help you
> +make the transition to Emacs.

Alternative wording:

    Alternative setups than Emacs may let you work on Guix with a
    similar development experience and they might work better with the
    tools you currently use or help you make the transition to Emacs.

> +The options listed below only provide the alternatives to the Emacs
> +based setup, which is the most widely used in the Guix community. If
> +you want to really understand how is the perfect setup for Guix
> +development supposed to work, we encourage you to read the section
> +before this regardless the editor you choose to use.
> +
> +@menu
> +* Guile Studio::                First step in your transition to Emacs.
> +* Vim and NeoVim::              When you are evil to the root.
> +@end menu
> +
> +@node Guile Studio
> +@subsection Guile Studio
> +
> +Guile Studio is a pre-configured Emacs with mostly everything you need
> +to start hacking in guile. If you are not familiar with Emacs it makes
                      -^
                      Guile

typo: s/guile/Guile

> +the transition easier for you.
> +
> +@example
> +guix install guile-studio
> +@end example
> +
> +Guile Studio comes with Geiser preinstalled and prepared for action.
> +
> +@node Vim and NeoVim
> +@subsection Vim and Neovim
> +
> +Vim (and NeoVim) are also packaged in Guix, just in case you decided
> +to go for the evil path.
> +
> +@example
> +guix install vim
> +@end example
> +
> +If you want to enjoy a similar development experience to that in the perfect
> +setup, you should install several plugins to configure the editor. Vim (and
> +NeoVim) have the equivalent to Paredit,
> +@uref{https://www.vim.org/scripts/script.php?script_id=3998,
> +@code{paredit.vim}}, that will help you with the structural editing of scheme
                                                                         -^
                                                                         Scheme
typo: s/scheme/Scheme

> +files (the support for very large files is not greath, though).
                                                      -^
                                                      typo
typo: s/greath/great

> +
> +@example
> +guix install vim-paredit
> +@end example
> +
> +We also recommend that you run @code{:set autoindent} so that your code is
> +automatically indented as you type.
> +
> +For the interaction with Git,
> +@uref{https://www.vim.org/scripts/script.php?script_id=2975
> +@code{fugitive.vim}} is the most commonly used plugin:
> +
> +@example
> +guix install vim-fugitive
> +@end example
> +
> +In NeoVim you can even even make a similar setup to Geiser using
                    -^   -^
                    double
typo: double even

> +@url{https://conjure.fun/, Conjure} that lets you connect to a running
> +Guile process and inject your code there live (sadly it's not packaged in
> +Guix yet).

NeoVim packager, is it complicated to have in Guix?  If yes, is it easy
to install without Guix?


Cheers,
simon