Beta Documentation Feedback
by Michael Perry · in Torque 3D Beginner · 03/28/2009 (8:03 pm) · 329 replies
=========================================================================
This was the official feedback thread for the Torque 3D beta.
It is now locked.
Please make post any new documentation feedback in the official thread:
Official Torque 3D Documentation Feedback
=========================================================================
6/16/09 Update Changed title of thread to Torque 3D Beta, instead of Official Torque 3D. When the final release ships, I want to have a clean thread for new users to be able to search through and post in. This thread will be archived.
7/17/09 Update: Tooltips work. Component Tutorials work in certain browsers. CLICK HERE for SVN Change Log.
9/31/09 Update: Posted full TOC for docs, using WIP template to hold spot for final docs to be written. CLICK HERE for SVN Change Log.
This was the official feedback thread for the Torque 3D beta.
It is now locked.
Please make post any new documentation feedback in the official thread:
Official Torque 3D Documentation Feedback
=========================================================================
6/16/09 Update Changed title of thread to Torque 3D Beta, instead of Official Torque 3D. When the final release ships, I want to have a clean thread for new users to be able to search through and post in. This thread will be archived.
7/17/09 Update: Tooltips work. Component Tutorials work in certain browsers. CLICK HERE for SVN Change Log.
9/31/09 Update: Posted full TOC for docs, using WIP template to hold spot for final docs to be written. CLICK HERE for SVN Change Log.
About the author
Programmer.
Thread is locked
#122
05/11/2009 (12:44 pm)
Also console commands; dumpConsoleClasses and dumpConsoleFunctions, i find to be helpful.
#123
05/17/2009 (1:43 am)
Any updates on the Documents? =]
#124
05/17/2009 (3:01 am)
@Aldavidson - That's what I'm waiting for too :-D Though, we will probably have to wait until Beta 2 release before the next set of docs will be released (including the revised versions of some of the current docs).
#125
BTW, Good job.
05/17/2009 (7:48 am)
@Michael - Under the description of the World Editor / Scene Tree; it would be helpful if there was an explanation on how to add an object to a simgroup. I know pickup and drop works, it would just be nice to have an explanation of the preferred method. BTW, Good job.
#126
05/21/2009 (7:39 pm)
I think it might be good to include a generated PDF version of the doc. Such as one huge PDF file, or maybe 1 PDF file per big section. That way you have a different way to search it, can read it from your Kindle or mobile-phone/iPod etc... Just as a convenience feature for the doc.
#127
05/22/2009 (11:53 am)
Is there a quick way to generate reference docs for the new beta? I assuming most of them are generated from the code anyway (doxygen/graphviz). There was some mention in the current docs about it, but it's broken. Any chance there will be a quick hint about how to do this in the near future?
#128
05/23/2009 (7:54 pm)
Firstly, thank you Michael for creating some awesome documentation. Secondly, some recomendations on different genere type games and model polygon count recommendations would be awesome for the artists section!
#129
05/29/2009 (9:11 pm)
The documentation looks nice. I take it's not fully finished but at least I like the direction it's going. Nice and clear, better organized.
#130
Would be nice if (http://docs.garagegames.com/t3d/official/) had:
1) web version (as is)
2) download latest as .zip for offline html version
3) download latest as .zip for offline pdf version
PDF is nice for reading doc, with a different method for search, and also for other devices (smart phone, iPod, Kindle, etc)
I don't know if 1 huge PDF is overkill, so an alternative would be like 1 PDF per section like: Introduction, Beginner Guide, Artist Section, Component Tutorials
[Edit: oops, I didn't realize I was double-posting this; I only checked pages 1 2 3 4 5 6, not page 7]
[Edit: in fact, on second thought, since it's a convenience thing rather than a content thing, maybe I should just do it and post a resource]
06/03/2009 (5:30 pm)
Has it been considered to link download for a PDF versions of the doc?Would be nice if (http://docs.garagegames.com/t3d/official/) had:
1) web version (as is)
2) download latest as .zip for offline html version
3) download latest as .zip for offline pdf version
PDF is nice for reading doc, with a different method for search, and also for other devices (smart phone, iPod, Kindle, etc)
I don't know if 1 huge PDF is overkill, so an alternative would be like 1 PDF per section like: Introduction, Beginner Guide, Artist Section, Component Tutorials
[Edit: oops, I didn't realize I was double-posting this; I only checked pages 1 2 3 4 5 6, not page 7]
[Edit: in fact, on second thought, since it's a convenience thing rather than a content thing, maybe I should just do it and post a resource]
#131
06/03/2009 (11:44 pm)
When can we expect the next wave of beautifull documents?
#132
he'll be back with avengance, and a whole lot more docs, soon, I'm sure.
06/04/2009 (6:30 am)
Michael is on a well deserved vacation at the moment, I believe.he'll be back with avengance, and a whole lot more docs, soon, I'm sure.
#133
So, Monday will be the next doc update focusing on ToolBox, Material Editor, River and Road tools, World Editor update, and Collada. Some upcoming Beta stuff will probably be snuck into the docs, so don't freak out if you are seeing stuff not currently in your hands.
Once I get those essential getting started docs out, I will go back to documenting the lighting and SFX system, which is most useful for programmers and scripters.
06/04/2009 (1:36 pm)
I'm switched gears to do a bit more Getting Started and artist stuff. We are getting some interns on Monday. I'd like for them to pick up Torque 3D and run with it and experience as little trouble as possible. This will be a good test of the beginner guide docs, since none of them have Torque experience.So, Monday will be the next doc update focusing on ToolBox, Material Editor, River and Road tools, World Editor update, and Collada. Some upcoming Beta stuff will probably be snuck into the docs, so don't freak out if you are seeing stuff not currently in your hands.
Once I get those essential getting started docs out, I will go back to documenting the lighting and SFX system, which is most useful for programmers and scripters.
#134
06/04/2009 (1:47 pm)
Sounds awesome Michael!
#135
06/04/2009 (1:53 pm)
Michael -- will the documentation always be a work in progress? What I mean to ask is, after T3D ships, if you get requests or comments that a certain area is confusing or lacking will your team add to it? Or will you be moving on to other projects and the docs are what they are , and that's it?. The point of my question is that there is some beginner stuff that I would like to request, but I haven't because I don't know what you already have in store, so I have held back.
#136
So after the engine ships, I will post what is still being written to save everyone time of having to point out holes. After you read through the list you can post requests.
06/04/2009 (1:55 pm)
@Steve - Oh believe me, I've already scheduled myself to work on Torque 3D docs for about 2 or 3 months after the first engine release. There are some parts I just will not have time to get to. I will be very open to corrections and suggestions provided by the community, thus the purpose of this thread.So after the engine ships, I will post what is still being written to save everyone time of having to point out holes. After you read through the list you can post requests.
#137
06/04/2009 (1:56 pm)
As far as holding back goes, any comments about what is currently available is what I need at this time. If you find grammar errors, bad links, or holes in an existing doc, post about that.
#138
you talk about
06/04/2009 (9:56 pm)
@Michael,you talk about
Quote:Some upcoming Beta stuff will probably be snuck into the docs, so don't freak out if you are seeing stuff not currently in your handsbut what about the physx docs? please.
#139
06/05/2009 (11:29 am)
@deepscratch - That part is being written by some of the devs, then handed off to me for polishing. Should be in the next beta.
Associate Steve Acaster
[YorkshireRifles.com]
It's a bit old, and obviously ignore anything that mention OpenGL, but still useful.
You'll have to log in to TDN and then re-enter the requested url, it's how it works.