Skip to content

Cleanup README #396

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jun 2, 2022
Merged

Cleanup README #396

merged 2 commits into from
Jun 2, 2022

Conversation

davetcoleman
Copy link
Member

  • Reduce usage of "2" in documentation
  • Remove old foxy reference
  • Clarify status of migration

AndyZe
AndyZe reviewed Jun 2, 2022
View reviewed changes
Copy link
Member

@AndyZe AndyZe left a comment

Choose a reason for hiding this comment

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

A lot of the text in this README duplicates what's available online. (https://moveit.picknik.ai/humble/doc/how_to_contribute/how_to_contribute.html)

Maybe we just need a link to the webpage from this README and delete the rest of the text here?

README.md

cd $COLCON_WS/src

Download Moveit2_tutorials Source Code
Download the MoveIt 2 Tutorials Source Code
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Download the MoveIt 2 Tutorials Source Code
Download the MoveIt Tutorials Source Code

@davetcoleman davetcoleman merged commit 40e7a22 into main Jun 2, 2022
@davetcoleman davetcoleman deleted the pr-readme-cleanup branch June 2, 2022 17:33
@davetcoleman
Copy link
Member Author

A lot of the text in this README duplicates what's available online. (https://moveit.picknik.ai/humble/doc/how_to_contribute/how_to_contribute.html)

Actually I'd argue there isn't that much overlap between the two, but I will clean it up further

@davetcoleman davetcoleman mentioned this pull request Jun 2, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AndyZe AndyZe AndyZe approved these changes

@vatanaksoytezer vatanaksoytezer Awaiting requested review from vatanaksoytezer

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@davetcoleman @AndyZe