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

Added a section for usage hints and updated sketches #37

Merged
merged 6 commits into from
Feb 14, 2019

Conversation

jontje
Copy link
Contributor

@jontje jontje commented Jan 8, 2019

As per title (related to issue #20). Should not be merged until pull request #36 has been merged (due to references to work done there)

Copy link
Member

@gavanderhoorn gavanderhoorn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor comments, mostly spelling/phrasing related.

README.md Outdated
4. Verify that the Add-In was added to the list *Installed Packages*.
5. The Add-In should appear as an option during the installation of a RobotWare system.

See the Add-In's [user manual](https://robotapps.blob.core.windows.net/appreferences/docs/2093c0e8-d469-4188-bdd2-ca42e27cba5cUserManual.pdf) for more details, as well as for install instructions for RobotWare systems.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to list some sort of document identifier here (ie: a document nr or version specifier)?

Links can go stale, but a document identifier could then still be used to search in other places for the document.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now there are no such documentation identifier that would be useful for searching for it. I will add an explanation of how to find the documentation in RobotStudio, and this should work as long as the Add-In is available in RobotApps.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now there are no such documentation identifier

that's unfortunate, as especially GUID based URLs have a tendency to break fairly easily.

I can't count the nr of times I've tried a link to an ABB support document only to see the link having gone stale and the document unfindable.

But that's not something we're going to solve here.

@gavanderhoorn
Copy link
Member

Feel free to merge @jontje.

@jontje
Copy link
Contributor Author

jontje commented Feb 14, 2019

Thanks for the review @gavanderhoorn 👍

@jontje jontje merged commit 1ac24ed into ros-industrial:master Feb 14, 2019
@jontje jontje deleted the updated_readme branch February 14, 2019 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants