Tutorial document needs update

[130s]

Thanks for the interesting work!

In a trial to apply reuleaux to a robot of my interest, I'm still struggling. I got some assistance in #43, and also I figured something by myself, which I've already applied to the wiki (diff). But there are still some issues and questions for the documentation of reuleux:

• Section 3 on the wiki says:

  If you are interested in creating workspace and utilize reuleux for your own robot, continue following this section. Otherwise you can skip this part...

  But I have no idea if I'm interested in "creating workspace and utilize reuleux for your own robot" or not. I'm reading this tutorial because I'm interested in using reuleux, but no information has been provided about:

  • what "workspace" is. It sounds like this is different from the Catkin workspace.
  • who needs workspace and who doesn't.

• In 3.3,

  have to link it in the kinematics.h header file and block the previuos defined filename.

  What is "previuos defined filename"? --> Added in wiki ***

• *_ikfast.cpp likely includes internally *_ikfast.h files. But the instruction doesn't mention how to address that. --> added a note about this.

• Same documentation on ROS wiki is also found on reuleaux github repo. I'd strongly recommend to aggregate and use only one location, to reduce maintenance effort, avoid readers' confusions (like me), and avoid duplicate or outdated info.

  • Assuming this was part of a funded project and keeping the work in a opensource repository was required, I'd suggest to only use repository, and just link here from ROS wiki.
    • Even better is to use document generation like rosdoc_lite so that you keep docs in the repo and also populate the same doc on ros.org.

[jontromanab]

Hello @130s Thank you very much for all your effort in making Reuleaux a better organized project. The documentation in the github repo will surely be updated in the next PR (already a PR is pending which has various changes in base placement section) After the PR is merged I will surely modify the documentation in the ROS wiki. We have just provided a basic structure for the documentation to be updated later for other developers. But I am still working on it and will surely modify soon.

About the ikfast file, I know it is a headache, I am in the process of making a launch file which will take the ikfast file as an argument, then we dont have to specify it in the header file every time.

Thank you. Hope you have already solved your issues in running reuleaux. IF not, please include me in the comment, I will look after it (I was traveling for a collaborative research for the last couple of weeks, so I could not reply properly, sorry about that. Bit I am fully available now)

[130s]

Thanks for the response @jontromanab

After the PR is merged I will surely modify the documentation in the ROS wiki.

Unfortunately that's opposite from what I'm suggesting. After looking at many projects gone stale over the time, I'd humbly suggest to aggregate the location to maitainance. I think using rosdoc is a way to go for ROS projects as I suggested.

[jontromanab]

@130s I did not understand the response clearly. Can you please elaborate what do you want me to do? I am not very familiar with rosdoc.