-
Notifications
You must be signed in to change notification settings - Fork 106
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
Request plugins explained #48
Conversation
I just documented PlanningRequestAdapter |
As I mentioned in #55, this PR should be rebased onto |
@@ -34,6 +34,8 @@ | |||
<li><a href="/documentation/faqs/">FAQS</a></li> | |||
<li role="separator" class="divider"></li> | |||
<li><a href="/code-api/">Code API</a></li> | |||
<li role="separator" class="divider"></li> | |||
<li><a href="/plugins/">Plugin Interfaces</a></li> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be /documentation/plugins/
, not /plugins/
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And perhaps move it up a bit. I think "FAQs" and "Code API" should be the last on that list, but that's a personal preference.
Also, the link to the plugin documentation should be added to documentation/index.markdown
(to keep it consistent with the nav bar).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
feel free to file a request :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I corrected the broken link.
Added links to interface and concrete implementations
3653129
to
eecaf81
Compare
Thanks for rebasing! Could you also have a look at my second comment?
|
Ok, I've submitted a PR for that: #60 . |
I've just removed the "Documentation" page since it didn't have any real purpose (just an index) and it keeps the menu bar concise. Nevermind... on further thought, I realize this is a bad idea because it serves as a landing page for documentation e.g. from the README.md for the moveit repo. |
d2bbaeb
to
d9ab4c4
Compare
Since WMD is over, I think we should go ahead and merge this with its remaining TODOs in place, and hopefully someone can fill it in as they feel compelled. By having the template ready and easy to find, someone is more likely to add to it in the future. |
Yeah, I'd like to merge this soon too. Two things:
|
e3560f2
to
1a8a1e7
Compare
1a8a1e7
to
23f49c5
Compare
1364a53
to
45c2236
Compare
I've added more info to PlanningRequestAdapter, added an extra thick line, and made each title easier to read. I also improved the way section links are used and reordered table of contents to match document. This is ready to merge |
f7306c3
to
0fbab4a
Compare
0fbab4a
to
3ba34e8
Compare
Merging. Thanks to everyone who contributed! |
Request plugins explained Former-commit-id: 06cd50f
The maintainers should read through the explanations and refine or correct them as required, before this goes to the website.
Here's the direct link: https://github.com/ros-planning/moveit.ros.org/blob/request-plugins-explained/documentation/plugins/index.markdown
@mikeferguson could you please have a look at the plugins you are/were involved in?
moveit/moveit#116 suggests that you are the best reviewer for the
CollisionPlugin
, but probably others too.