From: jgart <jgart@dismail.de>
To: Guix Devel <guix-devel@gnu.org>
Subject: Texinfo, Free Beer
Date: Sat, 6 Aug 2022 08:30:01 -0500 [thread overview]
Message-ID: <20220806083001.GC4096@gac> (raw)
Hi Guixers,
wdyt of having some modern TLDR entry in the cookbook for getting Guix neophytes up to par with texinfo?
Since texinfo is the defacto markup for the GNU Guix project and we're not likely to change it any time soon,
I was think we could have some distilled/TLDR docs for users who mostly write and consume markdown.
I was thinking something along the lines of what chicken has for rubyists or pythonistas:
https://wiki.call-cc.org/chicken-for-ruby-programmers
https://wiki.call-cc.org/chicken-for-python-programmers
"Texinfo for MDs"
roptat started a TLDR Texinfo guide on the learnxinyminutes series*.
Should we just improve on roptat's guide and link it in a Guix doc somewhere so
that it is more discoverable or integrate/fork it or similar into our docs?
Same way we have a Scheme crash course, we can have a Texinfo crash course?
It would be worth it since Texinfo seems more complex than Scheme from
a syntactic perspective and our new documentation contributors could
benefit from a crash course in Texinfo.
I think the GNU docs for texinfo are TMI for a new user just wanting to write some Guix docs for great good.
Another option could be to integrate guile-commonmark** into Guix so that
we could support markdown in addition to Texinfo? Please don't boo and
throw free beer at the stage.
Nix used to mostly have their docs in docbook but now they support
markdown and their users are much happier***
--
jgart
* https://learnxinyminutes.com/docs/texinfo/
** https://github.com/OrangeShark/guile-commonmark
*** https://invidious.osi.kr/watch?v=WwgSMgpX6TM
next reply other threads:[~2022-08-06 13:30 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-06 13:30 jgart [this message]
2022-08-06 13:43 ` Texinfo, Free Beer Ekaitz Zarraga
2022-08-09 9:22 ` pinoaffe
2022-08-09 23:03 ` jgart
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=20220806083001.GC4096@gac \
--to=jgart@dismail.de \
--cc=guix-devel@gnu.org \
/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).