Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

val3_driver: create ROS wiki page #6

Closed
gavanderhoorn opened this issue Jul 11, 2016 · 4 comments
Closed

val3_driver: create ROS wiki page #6

gavanderhoorn opened this issue Jul 11, 2016 · 4 comments

Comments

@gavanderhoorn
Copy link
Member

The README already contains quite some information, but is not the first place most users would look to for instructions on installation and usage.

It would be good to expand the ROS wiki page for staubli_val3_driver to include things such as minimum version of VAL3 supported, compatible controllers, information on compatible manipulators, etc.

See fanuc_driver for an example of such a page.

@gavanderhoorn
Copy link
Member Author

Alternatively, we might want to invest in writing Sphinx-based documentation for the staubli packages.

That would have a nr of advantages over the ROS wiki (versioning with source, easier on resources, target multiple output formats with a single source, responsive layout, etc). A disadvantage is less integration (and visibility?) with the ROS wiki.

See also ros-industrial/fanuc#148.

@gavanderhoorn
Copy link
Member Author

@nilsmelchert: is this perhaps something you would be interested in?

The current page is wiki/staubli_val3_driver.

You could take a look at the fanuc_driver one mentioned in the OP (see also the installation tutorial) and the Motoman installation tutorial.

If you've run into any issues while setting up staubli_val3_driver, it might be nice to document those on a Troubleshooting page similar to the ones for fanuc_driver (here) and motoman_driver (here).

@nilsmelchert
Copy link

nilsmelchert commented Nov 19, 2018

Sure. I totally forgot about this Issue. I will take care of it.

Edit:Besides, I figured that the tx60 series are not listed on the main wiki page of this repository yet: http://wiki.ros.org/staubli_experimental.

@gavanderhoorn gavanderhoorn transferred this issue from ros-industrial/staubli_experimental Jan 16, 2020
@gavanderhoorn
Copy link
Member Author

gavanderhoorn commented Mar 12, 2020

I'm going to close this one, as I believe we (as in: the ROS community) are slowly migrating away from the wiki. It will not be used with ROS 2 fi, and keeping documentation near code is a good way to increase the chances it'll be kept up-to-date.

#8 improves the readme already. We could see whether more extensive documentation would be required/desirable. If so, please post new issue(s) to track this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants