Re: A quick guide to Scheme implementations
Lassi Kortela 04 Feb 2020 17:01 UTC
> I think we can find a way to store the data in a flexible format and
> pull implementation details from that whenever necessary.
Sounds good. Some kind of templating language might work. Would be good
to decide on a common markup language and a common templating language
to go with it.
I aspire to pull the native manuals of many Scheme implementations into
a documentation aggregator. Most of those are written in texinfo, but
not all, it's going to be a multi-format show eventually anyway. But for
new material we write for schemedoc, it'd be nice to be consistent :)
I don't have experience with texinfo so I don't know if it's any good
for writing new stuff. The GitHub preview of Markdown, AsciiDoc and
org-mode files is nice for collaboration since you can just go into the
repo and see nicely rendered versions of working drafts. Scheme Scribe /
Scribble is probably nice but has no GitHub support (at least, not yet!
maybe we can send some rendering code to GitHub, I think they use many
ruby gems to do stuff).
> >By coincidence, I just created this empty repo yesterday:
> ><https://github.com/schemedoc/guides>. Feel free to add it there.
>
> Excellent! We could turn that into an FAQ-like collection of guides for
> newbies.
Exactly what I had in mind :)
I started an implementation internals / optimization guide yesterday,
but halfway through the first draft, got inspired about a guide that
would cover Common Lisp and Clojure as well. Not sure what to do. I can
post what I have so far into the repo. Also I'm not an expert on that topic.
> >We should agree on what markup language (markdown? asciidoc?
> >restructured text? texinfo? scheme scribe?) to use for Schemedoc stuff.
>
> I personally use org-mode for everything. This document was also written
> in org.
Arthur also likes it. I fear it may be a bit Emacs-centric, though maybe
the markup can be read from other tools as well. Pandoc and GitHub
support it.