I have put together a little webapp that I hope you will all find useful:
Enhanced Unity3D docs browser
It’s superior to the existing hosted documentation in two important respects:
- You can comment on the docs pages. This should allow you to add extra notes, discoveries, or gotchas to a docs page. You can also use it to ask questions, though please keep them general (i.e. don’t use it as a place to ask for project-specific help). I reserve the right to moderate all comments and delete/edit things that I think aren’t contributing to the resource.
- You can switch between different versions of the documentation. This is useful if you want to look up the details of a method in a particular older version of Unity, or if you want to compare how things have changed across versions.
To be perfectly clear, it is not an official Unity Technologies resource. I’ve spoken to the docs team about it, and they’re cool with me running it, but they’re not committing to ever looking at it or acting on any of the comments or feedback left there. If you want something to actually change in the docs, you still need to file docs bugs, but you could also leave a comment in the webapp so that other people can be informed while the bug is being resolved. Eventually UT will sort out a more comprehensive solution for getting the community involved in the documentation, but hopefully this will help fill that need for now.
If you find any bugs with the way pages are being displayed, with the scripting reference search, with comments, etc, let me know.
Most excellent! You can also view different revisions of docs on the official site, just we don’t currently have a version selector. See:
Unity - Manual: Unity User Manual 2022.3 (LTS) (always the latest, currently 4.0)
http://docs.unity3d.com/356/Documentation/Manual/index.html (3.5.6)
Unity - Unity Manual (3.5.5)
Unity - Unity Manual (3.5.3)
Unity - Unity Manual (3.5.2)
Unity - Unity Manual (3.5.1)
(3.5.4 is missing from this list because there were no significant changes that we made.)
Oh, that’s handy - if my traffic costs start getting too high, would it be OK if I used those versions of the docs instead of the copies that I’m hosting?
I like the idea to append a comment section under docs, just like what people did for PHP. I wonder why Unity team doesn’t do it.
Unity Answers is made for this, but most users simply don’t reference any docs page before posting a question.
I think, like many things, it’s just one of those areas they’ve not got around to addressing yet.
Not really. UnityAnswers is for more project-specific type help - posting your code and getting ‘this is why it’s not working’ type answers. I intend the comments on the docs browser to be more like a dynamic FAQ.
This is really cool. I will be using this on a regular basis now.
I do really like this idea, and I hope that Unity considers an approach similar to this. A moderated Wiki format that would allow us to submit our own edits to some of the more “understated” elements could really be helpful I think.
Link for example projects leads to a 404 page.
Thanks; I’m afraid that one’s Unity’s fault, not mine. Filed as bug 504078.
FYI, I think there’s a bug with the comment stuff such that they’re not showing up properly at the moment. I’m seeing them come through into DISQUS - I’ll look at it later tonight and fix whatever’s wrong. Rest assured that any comments you’ve made have not been lost.
This is a great initiative, keep it up.