AltME: Red Docs

Messages

Kaj
No, then it wouldn't work at all
Gregg
I don't know Doc. I'll find out when I can. Being the commercial branch of CouchDB, they may not make everything available.
What browser Kaj?
DocKimbel
Gregg, no problem, anyway, this is something we can generate ourselves and copy the good-looking parts from it.
Gregg
Agreed.
Kaj
Firefox 29
Gregg
First time here, FF28, didn't sync. Then I opened the TOC one level and it started working.
Gregg
I think the clojure ref model and the couchbase manual model are fairly compatible as well.

Gregg
DocKimbel
So, in a nutshell:
- github for hosting the docs (in a red/documentation repo)
- markdown for the initial format (with eventually some additions)
- Nim's documentation layout and style
DocKimbel
For the content itself, we need:
1) a user manual (with the same level as the Rebol/Core Manual)
2) a dictionary of the words
3) some tutorials
(1) is the biggest and most important part.

Andreas
4) a language reference
DocKimbel
You mean a language specification document?
Andreas
Yes. Everything that is not covered by the dictionary.
And stuff at a technical detail that is too much for the user manual.
One of the more important aspects: syntax. But also stuff like: binding, argument passing modes, cor e evaluation semantics.
Gregg
Language Design/Implementation Reference?
PeterWood
That's a very, very good suggestion Andreas. It won't be easy to write well. Do you think you may have a little time to help with it?
5) a dictionary of values
I always found it strange that the equivalent of the word dictionary for values was hidden away as an appendix in the Rebol user guide. I think such an important aspect of the language needs a more visible presence.

Gregg
Do you mean like a standard library reference Peter? I have notes for something like a Nutshell series book.

Last message posted 65 weeks ago.