fixing the documentation


(SCDS_reyalP) #1

from http://www.splashdamage.com/forums/viewtopic.php?t=5233
Continued here so as not to hijack redfellas thread

It really isn’t hard. Basic stuff can be fixed by just editing the html files, submiting a bug in zerowing bugzilla, and attaching a patch or the fixed file. Posting the changed version for feedback is probably good as well, to keep one from introducing new errors.

If anyone wants to rework major parts or add new sections, then you should get on the radiant mailinglist or IRC and talk with ttimo first. In general, he seems pretty open to anyone contributes real work.

IMO, the first step would be to go through the existing documentation and fix current blatant errors and obsolete stuff. Beyond that, there are plenty of things which are not covered in detail or at all.

Here’s a few things that come to mind:
Update the radiant manual, to fix various errors (like the 'never ever overlap brushes thing) and match current compile system etc. Some of game specific stuff (in the form of links, perhaps) might be good as well.

Add sections to the shader manual to cover the various game specific shader keywords, as well as the generic ones added by q3map2. Probably the game specific stuff should be a file for each game.

Update the terrain manual to cover q3map2 style terrains and mention easygen.

Update/cleanup the compile manual. Jetscreamer (?) was doing this at some point, I don’t know what his current involvement is. q3map is kind of a special case, because it is a faster moving target than the rest.

Apply the corrections in the sticky thread for the ET LDR.

Other things that could be added:
A decent basic room tutorial (such as redfellas)
An updated version of the errors list (see recent discussion on mapcenter).
A good structure/detail/hint/vis document. This could be part of a larger section of deep technical information.

I am willing to contribute some time to this, though I would rather concentrate on coding. The .def file updates from the sticky thread have already been accepted. I may do the stuff from the LDR as well, I started, but realized I have to actually go through and veryify it by following the instructions.


(sock) #2

There is a new version of the documentation being done at the moment. I should have all the updates and changes done by next week hopefully. If people want to contribute sections or tutorials to the ET LDR documentation then PM me with the details.

Sock
:moo:


(Machine for to kill) #3

Some good documentation and reference guides would be a dream come true.

I don’t know if you’ll find many people enthusiastic to help you out. This engine is at the end of its life now (what with D3 and HL coming out). I myself wanted to try out making a few plugins but it seems like a waste of time since not many more people will continue using this engine.

If this good documentation was to be made it has to be made soon, while people are still working on maps. Else you might as well forget it.


(SCDS_reyalP) #4

FWIW,
Updated shader manual, by obsidian http://www.quake3world.com/ubb/Forum6/HTML/027126.html?

Updated radiant shortcut list, by me http://www.quake3world.com/ubb/Forum6/HTML/027125.html?

comments/corrections requested.


(Machine for to kill) #5

very nice

:clap: :clap:


(badong) #6

this thread should be a sticky…it took me forever to find it cause I rememberd seeing it a while back. Put it in the tutorials thread.