Cris,

I do believe in contributing or helping with the documentation for the features I provide.

How would you want me to contribute the relevant documentation? Do you have a doc you want me to edit directly? Source Controlled? Or shall I just provide you with draft writeups that you will incorporate?

Carl Nagle

I have a module in the cvs, dimx_docs that contains the MS Word documents for the Readme and Developer's Reference.

Everything else is on our WIKI

http://www.gamesclan.it/dimensionex/wiki/index.php/Main_Page

Everything that is pertinent to syntax to be used for game development should go in the Developer's Reference, all else can go in the WIKI that is more comfortable to work collaboratively on.

Please wait until I've released also the developer's reference for dimx 6.3.6, as I already did some edits on devref 635, then add all you want.

see you soon,

OK I have released the documentation (and publicized dimensionex 636 on the newsletter).

Now you can simply check out module dimx_docs and edit the MS Word file "Developer Reference.doc" to match the changes you implement.

remember: before releasing the new version of the devref, you just neet to change the version number at the first page title, and on the pages' header (2 places, then). Make it match the version number of your dimensionex distribution (perhaps will be 6.4.0 or 7.0.0?)

Cheers!

OK. So, as I make a change, and I change the the rev in multiplayer.java, I can then make the associated changes to the doc and use the same rev number. I don't know your "release" process.

So, I'm assuming I will just make the rev of the docs match the rev of multiplayer and you will release things when ready. I also don't know what kind of regression testing you do on a release, if you do any.

If the release process is simple, then I can do that, I just need to know how.

The release process I use is simple.

When I see that a modified version is fairly stable, say: 6.3.6 E, I rename it to 6.3.7 and release it.

- I make a dimensionex###.zip files usually replacing in the previous one the classes folder and the changed files in the system folder.

- The Developer's Reference (I update it while making enhancements) is renamed in the title and in the page header. Then I make a PDF out from it (I have Acrobat) and then zip it to make devref673.zip

- The two files are then uploaded to sourceforge and released using the normal process.
- Also I upload them on the website as I noticed the download process from sourceforge was complicated in the past.


About regression tests:
- I usually make a run of testrug1.dxw
- Also I try out Underworld thoroughly - it is using most features.
Usually the to-be-released version is used for some days on the production server - if there's something that is not working, the users tell me immediately and so I roll back and correct problems before releasing.


FInally, about docs, I have made this:

http://www.scribd.com/doc/464590/Dimension...-Reference-v633

on this free service. I cannot remember if I uploaded the PDF or if I uploaded the MS Word and then it made the PDF.
I think it can be useful. Perhaps inthe future we should start using a WIKI to make the doc.

what do you think?

I have updated the Developer's Reference doc in CVS to reflect the availability of INCLUDE statements. I put the Version number to be 6.3.6c to reflect the current revision of code. But I recognize that this is NOT going to be the version it will be released at. I also had to update page numbers in TOC since stuff slid down as new content was added.

When a real release is done the version of the doc will need to be updated to reflect the real version of the release.

Carl

Seen it!

Great.

I usually update the TOC by doing a selectall+rightclick+update fields before producing the PDF to be released. You can skip this step until the release I think, but you were very clever to do so.

Thanks Carl,