Official Torque 3D Documentation Feedback
by Michael Perry · in Torque 3D Beginner · 10/21/2009 (1:59 pm) · 207 replies
=========================================================================
This Thread Is The Official Documentation Feedback Area For Torque 3D
If you want to quick search for all Torque 3D Doc Updates, perform a keyword search in your browser for "Documentation Update"
=========================================================================
Torque 3D Wiki
Documentation Landing Page
Official Documentation
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.
Purpose of the Thread:
- Provide a central thread for Torque 3D users to post their thoughts, suggestions, and criticisms about documentation.
Targets:
- Official documentation
Suggestions for Posts:
- What is the #1 thing you would like added to the official docs?
- What area of the docs do you think needs the most work?
- What do you see in other tech docs, be it for other Torque engines or non-Torque tech, that you think would be beneficial to have in the docs?
- Bring attention to resources, tutorials, articles, or community member submissions you think should be merged into the official docs
...etc, etc
So, the overall concept of this thread is pretty simple. This is your chance to talk until your face turns blue about what you want from the docs.
Be as clear, descriptive, and specific as you can!
You can find the archived feedback thread from the beta here: Beta Documentation Feedback.
7/17/09 Update: Tooltips work. Component Tutorials work in certain browsers. CLICK HERE for SVN Change Log.
7/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.
9/24/09 to 10/14/09 Update: CLICK HERE for full SVN change log
2/4/2010 Update: First major update to documentation pushed. Meant to coincide with 1.1 Beta, but full 1.1 docs are not finished. CLICK HERE for list of changes.
This Thread Is The Official Documentation Feedback Area For Torque 3D
If you want to quick search for all Torque 3D Doc Updates, perform a keyword search in your browser for "Documentation Update"
=========================================================================
Torque 3D Wiki
Documentation Landing Page
Official Documentation
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.
Purpose of the Thread:
- Provide a central thread for Torque 3D users to post their thoughts, suggestions, and criticisms about documentation.
Targets:
- Official documentation
Suggestions for Posts:
- What is the #1 thing you would like added to the official docs?
- What area of the docs do you think needs the most work?
- What do you see in other tech docs, be it for other Torque engines or non-Torque tech, that you think would be beneficial to have in the docs?
- Bring attention to resources, tutorials, articles, or community member submissions you think should be merged into the official docs
...etc, etc
So, the overall concept of this thread is pretty simple. This is your chance to talk until your face turns blue about what you want from the docs.
Be as clear, descriptive, and specific as you can!
You can find the archived feedback thread from the beta here: Beta Documentation Feedback.
Known Issues
- Docs are in progress7/17/09 Update: Tooltips work. Component Tutorials work in certain browsers. CLICK HERE for SVN Change Log.
7/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.
9/24/09 to 10/14/09 Update: CLICK HERE for full SVN change log
2/4/2010 Update: First major update to documentation pushed. Meant to coincide with 1.1 Beta, but full 1.1 docs are not finished. CLICK HERE for list of changes.
About the author
Programmer.
#203
I think torque should have something like this:
http://wiki.garrysmod.com/page/Main_Page
or
http://www.terathon.com/wiki/index.php/Main_Page
Right now everything all over the place and there's some really old threads on the forums which don't have a purpose anymore but are still stickyed.
08/09/2013 (8:03 am)
Sorry Michael Perry but there really is not much information there at all. I am talking about tutorials, templates, default function information. Sorta like what garrysmod has to index what is available to the developer.I think torque should have something like this:
http://wiki.garrysmod.com/page/Main_Page
or
http://www.terathon.com/wiki/index.php/Main_Page
Right now everything all over the place and there's some really old threads on the forums which don't have a purpose anymore but are still stickyed.
#204
The new wikis should help, but they're still pretty bare. Maybe we could all pick our favorite tutorial and migrate it to the new wiki....
08/09/2013 (8:10 am)
Quote:No Torque information ever really becomes worthless - it just loses its flavor on the bedpost. Older stuff just takes more skill to dust off - it is generally still relevant even if it doesn't work "out of the box" anymore.
really old threads on the forums which don't have a purpose anymore
The new wikis should help, but they're still pretty bare. Maybe we could all pick our favorite tutorial and migrate it to the new wiki....
#205
It'll happen with time, but it always helps to find out more about what users are looking for. What kind of tutorials? Written or video? What content? What skill level? And so on.
08/09/2013 (8:13 am)
@Ireheart - I just noticed the same problem with some stickied threads. I've been going through slowly and looking at what can be cleaned up. As for the lack of content, I guess it depends on what you are looking for. T3D has one or two amazing tutorials, but it can certainly use more. No doubt about it. Same deal with Torque 2D. The problem is that more writers are needed. The documentation effort requires more people writing the tutorials and submitting them to be posted on the official wiki.It'll happen with time, but it always helps to find out more about what users are looking for. What kind of tutorials? Written or video? What content? What skill level? And so on.
#206
1. Write docs
2. Generate docs
3. Copy built docs to the website repository
4. Commit SVN
5. SSH into a server using terminal
6. Call a .sh script to pull down repository, then push the docs online using a network command
Steps 1-5 work, but step 6 is completely borked. In November, we switched all of our repository DNS. I can relocate my local repositories fine, but no one bothered to change the .sh script on the server. That means I cannot push documentation online. I've submitted a support request to OPS, but I do not have an ETA from them.
Is this frustrating? Very. Is the process inefficient? Absolutely. Is there anything I can directly do about
09/26/2013 (12:57 am)
The method for pushing new documentation online is a bit of a pain:1. Write docs
2. Generate docs
3. Copy built docs to the website repository
4. Commit SVN
5. SSH into a server using terminal
6. Call a .sh script to pull down repository, then push the docs online using a network command
Steps 1-5 work, but step 6 is completely borked. In November, we switched all of our repository DNS. I can relocate my local repositories fine, but no one bothered to change the .sh script on the server. That means I cannot push documentation online. I've submitted a support request to OPS, but I do not have an ETA from them.
Is this frustrating? Very. Is the process inefficient? Absolutely. Is there anything I can directly do about
#207
@Richard Ranft
Amen.
09/26/2013 (8:21 am)
Quote:No Torque information ever really becomes worthless - it just loses its flavor on the bedpost. Older stuff just takes more skill to dust off - it is generally still relevant even if it doesn't work "out of the box" anymore.
@Richard Ranft
Amen.
Ireheart