Tremulous Forum

Community => Off Topic => Topic started by: Syntac on September 23, 2008, 01:00:41 am

Title: Official Online Documentation
Post by: Syntac on September 23, 2008, 01:00:41 am
I'm of the opinion that Tremulous needs an official online documentation (not a wiki). It should contain things like information on current development, a coder's guide, and, of course, a manual.

Why shouldn't it be a wiki? For the simple reason that it should only contain information that is known to be 100% true. The only experts on Tremulous are the developers, and as such they are the only ones who should be allowed to maintain this hypothetical documentation.

I'm working on something called FooDocs that might be useful for this purpose. Does anyone else think an official documentation is a good idea?
Title: Re: Official Online Documentation
Post by: fingered banana on September 23, 2008, 01:02:20 am
so it can be a wiki closed to public ;)
edit: it would be cool if someone extracted useful info from the forums. Then someone else checks for correctness
edit: So... we can just write RTFOOD instead of STFF + RTFM + UTFG
Title: Re: Official Online Documentation
Post by: Death On Ice on September 23, 2008, 04:15:39 am
The lazy bastards behind the 1.2 blog were working on this during the summer (before our free time vanished).
Title: Re: Official Online Documentation
Post by: mooseberry on September 23, 2008, 04:46:01 am
Yeah what bastards...  :o

Anyways, interesting idea, but I don't see why this is off topic? Perhaps General Discussion is better.
Title: Re: Official Online Documentation
Post by: fingered banana on September 23, 2008, 10:57:40 am
OFFicial :P
Title: Re: Official Online Documentation
Post by: Lava Croft on September 25, 2008, 10:53:49 am
Like most good ideas, there will be tons of people who agree with you that this is a good idea.
Too bad that just having a good idea is easy, actually bringing the idea into practice is a completely different subject.
Title: Re: Official Online Documentation
Post by: Annihilation on September 25, 2008, 06:20:19 pm
Well, I would love to set one up, but I don't know enough about trem's progess svn etc to do so.  I nominate Paradox! :)
Title: Re: Official Online Documentation
Post by: Syntac on September 25, 2008, 08:40:04 pm
Well, this is up to the devs, of course. Should they choose to use FooDocs, I can finish it pretty quickly.
Title: Re: Official Online Documentation
Post by: Paradox on September 25, 2008, 10:10:30 pm
Khalsa and I have discussed this before, and the perpetual answer would be "Ya, well, we would like it, but were busy"

I might be able to set up a MediaWiki sometime for it, but I don't have the time or attention span to write every article.

Thats where the community comes in.

But for a wiki, i have a number of ideas. You can see them at the following site:
http://wiki.paradoxdgn.com/wiki/Tremulous_Wiki_ideas
Title: Re: Official Online Documentation
Post by: khalsa on September 26, 2008, 07:15:37 am
Your link is missing an 's'. I like much of your structure ideas.

lol @ official - dev only.

Khalsa
Title: Re: Official Online Documentation
Post by: + OPTIMUS + on September 26, 2008, 10:51:50 am
i'd like to read interviews instead. with a programmer, a modeler, a mapper, a game tester, etc. for technical noobs like me, its more interesting than to look deep inside the datas.
Title: Re: Official Online Documentation
Post by: Paradox on September 26, 2008, 05:53:15 pm
Optimus, feel free to add that where you see fit.