Skip to content

Feedback on Documentation

/docker/README.md

Numbered list counts from 1-7, but 5 and 6 are missing?

Installation guide works perfectly fine. The remark on logging out after configuring the user access could be a bit better highlighted. I missed it the first time.

Can further documentation on the hello-world example project be found somewhere? The simulation works perfectly fine for me, but I don't understand the output at all. Reference wiki or other readme?

main README.md

Overlaps with the /docker/README.md. I think I'd prefer stronger isolation and referencing here. Suggestion: Skip the rest of the Docker section after "The recommend way is using the provided Makefile and Dockerfile:" and reference the /docker/README instead. The /docker/README is more precise and helpful here, "Take a look into the src/example. There's the sensor-reader example from the KU Leuven Homepage." is really fuzzy.

What do you think about putting some information about your repo structure and the folders in here? At first glance, I don't know what to expect from every folder.

Just an idea, feel free to discuss, but how about putting the installation guides for docker and from source into the wiki altogether?

And in general, please indicate what was written by you and what is taken 1:1 from other sources (e.g. /Repos/overview.md?).

That's it for now, I will read the Wiki articles now :)

Good job so far!

Edited by larissazech