Beta Documentation Feedback

#141 This thread is getting kinda long so I might have missed it but a compiler setup section might be a good addition. Like the old one but of course pointing to all of the new SDKs as well as list to what those SDKs are.

Server 2008 and march 09 DX SDK as well as the PhysX stuff. I assume anyway.

My apologies if someone already mentioned it.

Also just a suggestion for thread that get long like this see if the web guys can ad a "Search this thread" function at either the top or the bottom. After these things get over 4 pages it gets a little ridiculous.

#142 James, try checking your TGEA docs for compiler setup, it's pretty much the same (actually I think it's exactly the same...)

#143 Might I add a suggestion?

A changelog for the docs, so when you update the docs with a new push we know what was changed without having to surf this thread. (now someone's probably going to tell me that this already exists, so if you do my apologies)

=)

#144 @Pete - The best I can do is to title each new update post with Update:. While it might be convenient, writing a doc about the docs just makes my head hurt thinking about it.

Maybe I can post the SVN log of my commits...that would probably work out.

#145 From Ilidrake (http://www.garagegames.com/community/forums/viewthread/93947):

1. Guide on creating and integrating new TS modules, using Advanced Camera Resource as an example.

2. Deeper explanation of the Console system.

3. Layman's terms beginner section for each area. Possibly beneficial to have a common terms and tech guide for T3D and general development.

#146 @ Michael -

Personally I think the log of your commits would be useful, however that's just me =) Whatever yout hink is best, that was just a suggestion. I'm just happy you're commited to the docs =)

#147 Any good set of documentation will contain a revision description history or page.

Sorry, I work in configuration management. Having a revision description history helps people determine the areas they need to look for changes, rather than reading the whole doc again.

So I have to agree with Pete. Anything even if it is "Added sections 4-5" :)

#148 While I'll never cease to be amazed how excited and happy people are about documentation, there's only so much I can do to announce the doc progression. Uploading the SVN log and posting updates here is the best I can do. I'll just make sure I clean up my language from here on out for the SVN commits =)

Maybe instead of posting updates as I go here, I'll just update the OP with dates and notes.

#149 A complete newbie to Torque, I've been going through the online documentation from beginning to end and have a list of conflicts that I've been noticing.

The biggest ones I've come across is on the "Creating a Legacy Sky" page.

Both the words and images of the documentation contradict what I see in the application itself.

The Legacy Sky page refers to a "Creator" which looks an awful lot like Library/Level/Environment. However, there's no "Sky" object to be found (But the SkyBox and Scatter Sky are there). The menus in this page's screenshots are also quite different from what's in the T3D Beta 2: where the docs have "World" and "Window" menus, it's "Object" and "Tools" in Beta 2.

So my question is if this is an error in the docs or do I need to wait for further releases of the Beta to reflect the docs. Again, it's all quite confusing for a true beginner.

One other small issue: Docs refer to a pink background when the sky is deleted, but mine is always black without a sky.

#150 I'm pretty sure we are going to remove Legacy Sky completely, so this will most likely become invalid.

The reference to a pink background was before they provided a field for MissionInfo to determine your background...which now starts as black. Good catch.

#151 Documentation ?!?
The best documentation is to open the code. :)

#152 I haven't been following this thread until recently and I still have yet to read all the pages so if this has already been covered sorry.

I'm just wondering if there is going to be any outside references to learning resources within the documentation.

I understand the main focus of the documentation is to document the engine and not teach people how to write code, but if there is an excellent book or website on a topic that could help clarify things and it was referenced within the documentation itself I think that would be very useful.

This information could be at the end of the document. It could just say to learn more "go here" or "read this"

#153 @Michael — The "Creator" also shows up on the Sun page, but more puzzling is that the screenshot of the Sun properties is considerably different that what I see in T3D.

However, the explanation of azimuth and elevation is excellent!

Would love to see the other properties given as much attention. The mysterious-sounding "overDarkFactor" gets no mention in the Docs — but perhaps there's a separate section on the Advanced Lighting that I need to read ... ?

Oh — something else I forgot to post before: There's no Road Mesh editor button in Beta 2, but there is in the Docs ... ?

#154 @All - Yup. As I mentioned, I'm documenting a constantly changing engine. The Sun article was the first doc I wrote for Torque 3D. As of the next beta, every single page in the online documentation is now outdated. Fun, huh?

The documentation I'm shipping with the next Beta will be spot on, though.

@Robert - Glad you like the azimuth and elevation explanation. I want to do this more when explaining an object's relationship with the level. Simple concepts that your average user may not know.

#155 Apologies, Michael — can only imagine how busy you all must be. Looking forward to the next Beta! Good luck with it!

#156 Eww, that stinks documenting a moving target.

Awesome news about the updates though... can't wait.

#157 Hi Michael,
I was just wondering, if there is documentation in the works, that explains all the base "nodes" within models, and how to setup the heirarchy, and what the heirarchy means in models? (i'm talking about asset creation here, Things have come ALONG way on from max 3 & 4, which the tutorials reference in the art section). It is all a bit daunting for a new comer.

#158 Hi Michael,

Can you please add a section for typical distance scales used in T3D versus the popular art pipeline tools? Like Mod Tool, Blender, Maya, Max, etc.

#159 On the TSShapeConstructor page of the Artist Section, code sample 3.

This is a bit confusing to me. Where did the material rock2 come from? Was it already part of the rock1.dts?

If boulder1 had more than one mesh, would all meshes be added to the test shape?

#160 @Scott and Aldavidson - I'm still working on the Artist section. The TSShapeConstructor, COLLADA Overview, and Shape Builder are being updated as we speak. The rest of the new docs will come toward the end

@All - Update coming today, check the Original Post.