Search Unity

  1. Unity support for visionOS is now available. Learn more in our blog post.
    Dismiss Notice

Discussion Why is there no proper documentation?

Discussion in 'Unity Transport' started by MariuszKowalczyk, Mar 15, 2023.

  1. MariuszKowalczyk

    MariuszKowalczyk

    Joined:
    Nov 29, 2011
    Posts:
    300
    I use Unity for over 11 years. One of the strongest element of Unity engine was always a good documentation and manuals.

    Why is there no proper Unity Transport documentation available?

    Also I can not understand why there are two different, yet similar places with almost the same informations:
    1. https://docs.unity3d.com/Packages/com.unity.transport@2.0/api/index.html
    2. https://docs-multiplayer.unity3d.com/transport/2.0.0/about

    The documentation offers a list of class and methods with a few of them being shortly explained. Most of them have zero explanations and no usage examples.

    The client server example is also a bit confusing. The minimum would be to show how to connect to a specific IP (even if this is the local IP), but either I don't see it or it is not in the example.

    I understand that this low level api is not for casual Unity users. We will be able to figure how all this works (there are some similarities to UNET which helps), but the lack of documentation will make the process longer and waste the time of all of us. Proper method explanation would also help us avoid bugs.

    I already have seen a video from a developer who is using Transport and he complains about it too (he was even forced to read the change logs to get the pieces of info that should be in the documentation).

    Could you please write a better documentation for this API?
     
    Last edited: Mar 15, 2023