Search Unity

  1. Welcome to the Unity Forums! Please take the time to read our Code of Conduct to familiarize yourself with the forum rules and how to post constructively.
  2. Dismiss Notice

Question Where to find the Documentation for formerly builtin and new Packages?

Discussion in 'General Discussion' started by OUTTAHERE, Sep 22, 2022.

  1. OUTTAHERE

    OUTTAHERE

    Joined:
    Sep 23, 2013
    Posts:
    656
    I have problems finding and bookmarking the authoritative documentation and scripting references for packages, for Unity Tech Stream and LTS versions since 2021 and later (but seems to affect Unity 2019 and later).

    For example, for UnityEngine.UI, there is no recent documentation I can find - the last is for Unity 2018 here:
    https://docs.unity3d.com/2018.1/Documentation/ScriptReference/UI.AspectRatioFitter.html

    Alas, when clicking on the (formerly quite helpful!)
    upload_2022-9-22_14-36-40.png ,
    that brings me to the most recent scripting reference, but that no longer contains any documentation for the UnityEngine.UI package.

    This problem is compounded for some of the more modern packages, such as Unity.mathematics; where only obscure or very old versions can be found. For instance:
    https://docs.unity3d.com/Packages/com.unity.mathematics@0.0/api/Unity.Mathematics.Random.html
    os for Version "0.0" of Unity.mathematics.
    upload_2022-9-22_14-39-4.png
    brings us to a completely different page, that is actually not even a scripting reference, just a basic usage overview.

    Curiously / comically, docs.unity.cn has the newer scripting reference:
    https://docs.unity.cn/Packages/com.unity.mathematics@1.2/api/Unity.Mathematics.Random
    structure, but of course is painfully slow to browse because China is on the other side of the world for many of us.

    The expected equivalent on docs.unity.com
    https://docs.unity.com/Packages/com.unity.mathematics@1.2/api/Unity.Mathematics.Random
    returns a 404.

    Google sure doesn't seem to have it indexed, either, only the Chinese versions. With some digging, you can find the right page here, but, and this is pretty bad, the full text search field in the top right for the documentation doesn't seem to have indexed its contents, only the class names and only when you get the precise prefix right, and finding functions by name is impossible (either finds nothing, or highly unspecific, poorly formatted results).
    upload_2022-9-22_15-6-53.png
    (if it is a Google Site Search, this may be related - but the loss of usability is massive)
     

    Attached Files:

    Last edited: Sep 22, 2022
  2. CodeSmile

    CodeSmile

    Joined:
    Apr 10, 2014
    Posts:
    4,019

    Attached Files:

    Socrates and OUTTAHERE like this.
  3. OUTTAHERE

    OUTTAHERE

    Joined:
    Sep 23, 2013
    Posts:
    656
    Thanks - so this backwater page never seen by the likes of Google is the official place :eek:
    (I added a screenshot about what's wrong with it to my original post.)

    So why isn't this in the normal Google Index? And why isn't it full text indexed?
    (and why is the .cn version both of these things?)
     
    Last edited: Sep 22, 2022
  4. CodeSmile

    CodeSmile

    Joined:
    Apr 10, 2014
    Posts:
    4,019
    I have no idea. Could be because one version is more popular than another, or has more "relevant keyword density" or something so Google ends up ranking it higher, more so the more users click on that link. That system sometimes turns against itself when there's frequently updated docs that use a different URL. I bet from a Google point of view it would be best to have the latest version of a document always reachable by the same URL, and archiving older versions with versioned URLs.

    I ran into this myself, looking at outdated docs. Make sure to follow the links in Package Manager instead.
     
    Ryiah and OUTTAHERE like this.
  5. Murgilod

    Murgilod

    Joined:
    Nov 12, 2013
    Posts:
    9,745
    Cool how Unity has gone from "woefully incomplete documentation" to "woefully incomplete documentation scattered across multiple sources that aren't easy to find."
     
  6. CodeSmile

    CodeSmile

    Joined:
    Apr 10, 2014
    Posts:
    4,019
  7. neginfinity

    neginfinity

    Joined:
    Jan 27, 2013
    Posts:
    13,321
    Its original state was "very well done documentation", for the record.

    On other hand built-in documentation search never really worked and you had to google, and "see most recent version" haven't ever worked either.
     
  8. Murgilod

    Murgilod

    Joined:
    Nov 12, 2013
    Posts:
    9,745
    Sure, but even by of 2015 there were loads of parts of the API reference that were just fundamentally lacking any explanation of what certain functions did. There's no point in saying "it used to be good" when it's been getting progressively worse for nearly a decade.
     
  9. OUTTAHERE

    OUTTAHERE

    Joined:
    Sep 23, 2013
    Posts:
    656
    You should check the documentation for MongoDB Atlas and MongoDB Realm:
    That is what I would call a well done documentation.

    Unity docs were ok, sometimes good. But never "very well done".
     
  10. neginfinity

    neginfinity

    Joined:
    Jan 27, 2013
    Posts:
    13,321
    You're trying to argue about one true definition of "very well done" for some reason. I'm not sure if discussing that is worth the time.

    You need to check Qt documentation and Unreal documentation.
    Qt used to be "gold standard". Unreal used to be "quite bad".

    In your example I was unable to jump to API refernce sufficiently quickly, and getting to C++ class index required going through a menu, where it became obvious that it is a doxygen dump without any additional information.

    For example:
    upload_2022-10-1_19-23-3.png
    That doesn't tell me anything useful.

    Compare it with:
    https://docs.unity3d.com/ScriptReference/Mesh.html
    Which is very thorough. Or something like this.

    Like I said, gold standard used to be Qt (and not your link), but it's been ages since I worked with it, so maybe things changed since.
     
  11. steego

    steego

    Joined:
    Jul 15, 2010
    Posts:
    968
    angrypenguin and Neonlyte like this.