Included documentation, any volunteers? - Page 2

Included documentation, any volunteers?

Discuss the source code and development of Spring Engine in general from a technical point of view. Patches go here too.

Moderator: Moderators

MelTraX
Posts: 470
Joined: 02 Jan 2007, 16:18

Post by MelTraX »

I started a little First-Aid page a month ago because new users usually ask these questions when they first start the lobby..

I don't know if it helps but feel free to use those screenshots..
Tobi
Spring Developer
Posts: 4598
Joined: 01 Jun 2005, 11:36

Post by Tobi »

Ah nice, maybe someone can compile these stuffs together a bit?
User avatar
PauloMorfeo
Posts: 2004
Joined: 15 Dec 2004, 20:53

Post by PauloMorfeo »

AF wrote:Its from much earlier than that. That document was released with 0.4b1 the first spring release ever, and was originally created by fnordia.

As time ent on fnordia/sj/jouninkomiko made one ro two modifications, untill tir eached that version, at which poitn ti was already out of date.

So paulomorfeo wrote a small set of html files to replace them but they were never accepted. They too would be out of date atm.
Unless the documentation shiped with spring changed from when i last played, it followed basically this path:

- Documentation was beeing needed to be shiped with spring and we reached the conclusion that, since most of the info was on the wiki, it would be as simple as transforming the info in the wiki to html.
- Since no one would do it, i actually ended up doing it myself. Basically, just accessed the pages with the browser and created the htmlpages from that.
- Apart from the general layout, i only made some quality control and introduced, for the forst time, the oficial separation of Spring as an engine and TA Spring, the combination of the engine + the content, as what people were installing.
- From then on, i think developers have been changing the titles to change the number of the version in it.

I think you should follow the same path. That is, update and clean up the wiki and, then, create the documentation from there (ain't too hard to transform by hand the wikis to htmls). If not, you will not end up with things syncronized (some info in the docs and another diferent in the wiki).
Post Reply

Return to “Engine”