Official TGEA Documentation Feedback
by Michael Perry · in Torque Game Engine Advanced · 03/19/2008 (7:21 am) · 102 replies
=========================================================================
This Thread Is The Official Documentation Feedback Area For ALL Versions of TGEA
If you want to quick search for all TGEA Doc Updates, perform a keyword search in your browser for "Documentation Update:"
=========================================================================
Hey Everyone. I've got my nose to the grindstone working on the documentation and tutorials for TGEA, which was provided in the TGEA 1.7.0 Beta.
By using this thread as a central source to leave documentation feedback, we can keep the other forums clean.
Feel free to post any criticism, suggestions, bugs (missing images or dead hyperlinks), outdated information, etc.
Outside of messing up an object or class name, don't worry about correcting grammar or spelling. Believe me, I'll find those eventually =)
Known Issues:
- Missing images in Mission Editor section (Found the reason and will correct it soon)
- Formatting inconsistent (Created a new template and porting finished sections over)
- Missing or Out of Order Table of Contents for quite a few sections. Let me know what you find
- Reference to a Tutorials Section that does not exist.
I want to elaborate on this last part. I really like how the TGB documentation separates its reference and overview sections from its tutorials. If you read through the GUI Editor section, you'll see there is a mini-tutorial. This is used solely for giving an overview of the Editor and its layout. I'm going to create a Tutorial section, and one example for an extended GUI tut would be "Creating An In Game Inventory GUI."
Look forward to the feedback ladies and gents =)
This Thread Is The Official Documentation Feedback Area For ALL Versions of TGEA
If you want to quick search for all TGEA Doc Updates, perform a keyword search in your browser for "Documentation Update:"
=========================================================================
Hey Everyone. I've got my nose to the grindstone working on the documentation and tutorials for TGEA, which was provided in the TGEA 1.7.0 Beta.
By using this thread as a central source to leave documentation feedback, we can keep the other forums clean.
Feel free to post any criticism, suggestions, bugs (missing images or dead hyperlinks), outdated information, etc.
Outside of messing up an object or class name, don't worry about correcting grammar or spelling. Believe me, I'll find those eventually =)
Known Issues:
- Missing images in Mission Editor section (Found the reason and will correct it soon)
- Formatting inconsistent (Created a new template and porting finished sections over)
- Missing or Out of Order Table of Contents for quite a few sections. Let me know what you find
- Reference to a Tutorials Section that does not exist.
I want to elaborate on this last part. I really like how the TGB documentation separates its reference and overview sections from its tutorials. If you read through the GUI Editor section, you'll see there is a mini-tutorial. This is used solely for giving an overview of the Editor and its layout. I'm going to create a Tutorial section, and one example for an extended GUI tut would be "Creating An In Game Inventory GUI."
Look forward to the feedback ladies and gents =)
About the author
Programmer.
#102
03/29/2009 (6:34 am)
Thanks Mich. For now, I'll continue to troll the code to see if I can find code that comes close. This is where "Better Commenting On Code Changes In The Code Would Have Come In Handy" (pointed at the programmers, not Mich.) It's great to see the docs getting so much attention. You are doing a fantastic job. :-)
Torque 3D Owner Tony Richards
Mr. Perry has been doing a fantastic job with the online stuff... lets not limit or stagnate his progress.
Great job at GDC Mitch... and don't forget to pay attention to the better half. ;-)