ROS1 documentation updates and enhancements

[tsampazk]

• Main changes in projects/opendr_ws/src/perception/README.md include:
  • Added a prerequisite section describing common prerequisites between nodes and notes section for general information
  • Separated the node documentation in sections depending on their input type, similar to the contents in projects/opendr_ws/README.md
  • Added argument information about all currently updated nodes that use argparse
• Did some restructuring on projects/opendr_ws/README.md to match the order of the projects/opendr_ws/src/perception/README.md content
• Added a class ID table for semantic segmentation bisenet both in the ROS documentation and the tool's documentation
• Added some TODO comments on not yet updated nodes, see tracker issue #305.

[tsampazk]

Hey @stefaniapedrazzi! Right now from my end the PR is ready for review, but the docs are 'incomplete' as some nodes are not yet updated. Do you think we can go ahead and review/merge this and change the docs for remaining nodes as soon as they are updated or keep this as draft and update it simultaneously?

[stefaniapedrazzi]

Given that the list of nodes that still needs to be updated should be already listed in #305, I think that we can review and merge this PR.

[tsampazk]

Thank you for the review!

And maybe the very long lines containing multiple sentences may be split.

Sorry about that, i am not exactly sure what convention we are following in the docs, regarding the long lines. I applied the fixes suggested.

[stefaniapedrazzi]

Initially I tried to insist on having one sentence per line on the documentation for MD filed because it is easier to read and review the sources. But this doesn't seem very intuitive for all the other partners and at the end it is not a very important issue.

So it is preferable to not split sentences on different lines even if they are very long and it is ok to have multiple sentences per line if they are not too long. But if there are long sentences I would say it is better to write them on a new line.

[tsampazk]

Initially I tried to insist on having one sentence per line on the documentation for MD filed because it is easier to read and review the sources. But this doesn't seem very intuitive for all the other partners and at the end it is not a very important issue.

So it is preferable to not split sentences on different lines even if they are very long and it is ok to have multiple sentences per line if they are not too long. But if there are long sentences I would say it is better to write them on a new line.

Alright TYVM for the explanation!

[tsampazk]

I am converting this PR to draft, as i identified some redundancy in the instructions, i.e. every node that outputs RGB images has almost identical instructions regarding rqt_image_viewer and echoing the output topics. I'm going to investigate a way to add this as general instruction in the beginning and simplifying the instructions for each node.

[tsampazk]

ROS documentation overhaul is now complete based on the updated nodes present in develop. As a minor note, some nodes have some argparse shortcuts that are not yet implemented in the corresponding nodes (missed them in #357). They will be added in the consequent update regarding ros1 nodes.*

Edit: changes in #364.

[tsampazk]

I have made any updates needed for #364 locally (also merged that branch into this, resolving the conflicts) and i am going to push them as soon as #364 is merged, as i think this will make the procedure as clean as possible and everything ends up merging in develop smoothly.

[tsampazk]

The updates in the ROS docs are complete now, PR is ready for review.

[tsampazk]

Thanks @ad-daniel for the review! Should we add the test-tools label now that the install.sh file is modified?

[ad-daniel]

sure doesn't hurt

[ad-daniel]

no need to wait the tests again, once they pass we sync the branch and remove the label