Documentation tourbleshooting #19
Description
Just suggestions for enhancement for the documentation. As a non-developer user, I tried to spot places where the documentation is hard to understand.
- In step 2 of the tutorial, the first paragraph is hard to understand.
To start the creation of the Unity game, a first step consists in cloning or just downloading the [Simple template Unity](https://github.com/project-SIMPLE/simple.toolchain/archive/refs/heads/Unity-6.zip) and add it in the Unity Hub (Unzip the file and add the contents of the "Unity Template" folder to the Unity Hub). You can then open it.
It would be better to add a screenshot and mention the button on which to click ("add") since the layout does not naturally lead to it, but to "import". Honestly I got lost during this phase and had to ask for help... in particular, the sentence "Unzip the file and add the contents of the "Unity Template" folder to the Unity Hub" means nothing for people who discover Unity Hub.
- In Scene Loading and Middleware Connection Verification
got it easily but took me a bit of time anyway to understand how to access "Game Manager" with the inspector. The step should be described more in detail: or at least add some visual mark on the left menu on the screenshot, and highlight the player and ground field. Keep in mind that at this stage, information on the screen is extremely dense and hard to read for people discovering unity.
- In Open another scene (for example: Assets/Scenes/Code Examples/Limit Player Movement):
there file to be opened at this location. I found something else in another directory.
Now I'm trying to reopen the scene I created. More guidance is required here: trying to open it with "open scene", I just found an empty directory with nothing to load again, as shown in the following screenshot ("est" is for "test" with a missing "t")... misleading, but with "open recent scene" I could make it.
- Additionally, verify that the connection to the middleware is properly configured by inspecting the Manager / Connection Manager object in the scene.
At this point, following the instructions, I downloaded the middleware (as asked in the mail but not in the tutorial) but did not install it or unpack it. So I am not sure about what should be the state of it at this stage. If fixed properties is ticked, does it mean that the middleware is working ?
=> OK it has to be installed and run after, but the explanations are confusing here.
Maybe more comments to come, right now the middleware won't start so I will wait for support on this...