Docs Update
Niek asked me to write a consistent list of what has to be done for the documentation. Also keeping the structure concise and to the point. Since our old read the docs has been somewhat randomly been made its a good idea to restructure the whole thing. Therefore I (Joris) propose we do the following things on our Documentation D-Day (thursday 10-12-2020):
We have to (as a group) decide on the structure of the documentation, I (Joris) think the current structure is sufficiently easy to navigate
Assuming we want to keep the current structure we have to do the following things:
Setup JOAN Section
-
This section is still totally relevant and good enough (I used it on new laptop) maybe only a spellcheck. Andreeee -
One thing we might have to add, is that if you have 2 versions of unreal installed (4.26 and 4.24) you should launch unreal 4.24 from the epic games launcher. DO NOT create a copy of your project as it suggests fi you open it with another version. joris
Home Section
-
Update the youtube Video to something more current (maybe the VIDI video) -
Home should include the different sections as it is on the carla read the docs. This will bring more structure -
The links in Home have to be checked. (do they work and link correctly)
First Steps Section
-
The Overview should be elaborated upon more, maybe with more clear graphics I (Joris) tried, however it is difficult to do so. We still miss explanations on News, Settings Shared Variables and Signals. joris -
Running Joan and Carla, the GIFs should be compressed. (did this, couldnt get the biggest gif below 26mb hope thats good enough else, good luck :)) -
Running JOAN and CARLA, maybe a bit more text. -
Quick Start CARLA, check if this is still needed, and what should it contain
Using the JOAN CORE Modules section
-
An overall introductoin here would be nice -
Hardwaremanager needs to be done -
Carla Interface needs to be done -
Data Plotter needs to be done -
Data Recorder needs to be done olger -
Experiment manager needs to be redone (needs an extensive guide on how to set things up and use properly!!) olger -
Haptic Controller Manager needs to be done -
Pictures/videos of actual SensoDrive working should be updated. joris
Advanced Steps Section
-
Creating your own custom JOAN Module (needs heavy changes)
Optional advanced steps
-
State Machine usage (maybe still relevant but needs to be updated, also differentiate between central state machine and module state machine) -
Settings (saving jsons etc maybe still relevant but needs to be updated) -
Maybe nice to add a piece on MultiProcessing and serializability