AltME: Red Docs

Messages

Gregg
Find something to emulate, whatever it may be. Learn from others who have done this before.
Gregg
Gregg
This is an interesting approach: http://clojuredocs.org/quickref/Clojure%20Core
AdrianS
the Scala doc site seems pretty decent, as well: http://docs.scala-lang.org
Andreas
Oldes: nice mashup!

DocKimbel
We might have another good alternative option to the wiki (maybe easier and more flexible): use a github repo for all the    documentation pages in makedoc format, and have external export batch script to export them in HTML, PDF or whatever format.
I would be able to write most of the reference documentation, but would probably let the dictionnary be written by the community. The githun repo would allow for everyone to contribute while being filtered by one or several managers.
I would like to copy this extjs template component for documentation, with content in JSON format:
- http://docs.sencha.com/ext-js/4-1/#!/guide
- http://docs.sencha.com/ext-js/4-1/#!/api
I guess it should be search-engines friendly.
BTW, this extjs template handles user comments also....Not sure we would need it as it is possible to add comments to github source code.
So storing the docs in source format in a DVCS repo would allow us to generate static web pages for the docs, avoiding   (potentially painful) tweaking and maintainance of a PHP-based wiki engine.
DocKimbel
So, how does that option sounds to you?
AdrianS
Are you also thinking of serving the docs site(s) from github pages as well?
http://pages.github.com
Gregg
I like the sencha guide page OK, but I like http://clojuredocs.org/quickref/Clojure%20Core better than the sencha API page. It seems like a better fit for Red/REBOL to me. Guess I'll really have to learn git now.
Now, where is that new version of altme that uses git for file sharing and just hides all the details...
DocKimbel
AdrianS: Github Pages uses Markdown format, they have no support for makedoc.
DocKimbel
Gregg: the Red dictionary could be displayed in different ways, the treeview (unfolded like for clojuredocs or navigatable like in the Sensha demo) is one option, another is displaying it like REBOL's one:
http://www.rebol.com/docs/dictionary.html
Anyway, the dictionary is a not the "reference documentation" (think REBOL/Core manual) which should be the first focus.
DocKimbel
I'm also adding other features we should have for Red docs:
- search field: a true local search engine, not a wrapper on Google search.
- versioning: ability for users to consult any previous version of the docs.
- a simple way to track changes in the docs.
DocKimbel
For now, I would just link the docs from red-lang.org and host them on static.red-lang.org which points to my own server.
In a few months, when bootstrapped Red will be complete, I would like to move all to a new, more appealing web site. I might use a github repo for managing the static parts of the web site. I would also move the blog to WordPress or anything else than Blogger.
DocKimbel
About Git, it is not that complicated, you just need to learn a few (2-3) usage patterns to be able to install/update your local repo and submit a change. Maybe someone could provide a simple Red-repo-oriented tutorial using TortoiseGit and command-lines for those basic usage patterns?

Last message posted 65 weeks ago.