1. We've introduced thread tags, search within a thread and similar thread search. Read more here.
    Dismiss Notice
  2. Learn how you'll soon be able to publish your games to China in four simple steps with Xiaomi. Sign up now for early access.
    Dismiss Notice
  3. Get further faster with the Unity Plus Accelerator Pack, free for new Unity Plus subscribers for a limited time. Click here for more details.
    Dismiss Notice
  4. We've released our first Timeline Experimental Preview, our new tool for creating cutscenes and more! To check it out click here.
    Dismiss Notice
  5. Unity 5.5 is now released.
    Dismiss Notice
  6. Check out all the fixes for 5.5 in patch releases 1 & 2.
    Dismiss Notice
  7. Unity 5.6 beta is now available for download.
    Dismiss Notice

Enhanced Unity3D docs browser

Discussion in 'General Discussion' started by superpig, Dec 3, 2012.

  1. superpig

    superpig

    Insert bacon, receive bugfix Unity Technologies

    Joined:
    Jan 16, 2011
    Posts:
    3,738
    I have put together a little webapp that I hope you will all find useful:


    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.
     
  2. Graham-Dunnett

    Graham-Dunnett

    Unity Technologies

    Joined:
    Jun 2, 2009
    Posts:
    4,225
    Most excellent! You can also view different revisions of docs on the official site, just we don't currently have a version selector. See:

    http://docs.unity3d.com/Documentation/Manual/index.html (always the latest, currently 4.0)

    http://docs.unity3d.com/356/Documentation/Manual/index.html (3.5.6)
    http://docs.unity3d.com/355/Documentation/Manual/index.html (3.5.5)
    http://docs.unity3d.com/353/Documentation/Manual/index.html (3.5.3)
    http://docs.unity3d.com/352/Documentation/Manual/index.html (3.5.2)
    http://docs.unity3d.com/351/Documentation/Manual/index.html (3.5.1)

    (3.5.4 is missing from this list because there were no significant changes that we made.)
     
  3. superpig

    superpig

    Insert bacon, receive bugfix Unity Technologies

    Joined:
    Jan 16, 2011
    Posts:
    3,738
    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?
     
  4. raincole

    raincole

    Joined:
    Sep 14, 2012
    Posts:
    37
    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.
     
  5. BrUnO-XaVIeR

    BrUnO-XaVIeR

    Joined:
    Dec 6, 2010
    Posts:
    1,697
    Unity Answers is made for this, but most users simply don't reference any docs page before posting a question.
     
  6. superpig

    superpig

    Insert bacon, receive bugfix Unity Technologies

    Joined:
    Jan 16, 2011
    Posts:
    3,738
    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.
     
  7. KHopcraft

    KHopcraft

    Joined:
    Jun 6, 2009
    Posts:
    3,248
    This is really cool. I will be using this on a regular basis now.
     
  8. Ferazel

    Ferazel

    Joined:
    Apr 18, 2010
    Posts:
    253
    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.
     
  9. drewradley

    drewradley

    Joined:
    Sep 22, 2010
    Posts:
    2,965
    Link for example projects leads to a 404 page.
     
  10. superpig

    superpig

    Insert bacon, receive bugfix Unity Technologies

    Joined:
    Jan 16, 2011
    Posts:
    3,738
    Thanks; I'm afraid that one's Unity's fault, not mine. Filed as bug 504078.
     
  11. superpig

    superpig

    Insert bacon, receive bugfix Unity Technologies

    Joined:
    Jan 16, 2011
    Posts:
    3,738
    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.
     
  12. tatoforever

    tatoforever

    Joined:
    Apr 16, 2009
    Posts:
    2,768
    This is a great initiative, keep it up.