docs: improve teleop and main readme instructions - #308
Merged
juelg merged 3 commits intoMay 14, 2026
Merged
juelg merged 3 commits into
juelg merged 3 commits into
Conversation
Copy link
Copy Markdown
Collaborator
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull request overview
Updates project documentation to improve onboarding and teleoperation setup clarity.
Changes:
- Added explicit “clone repository” steps to the root installation snippet.
- Refined Meta Quest teleoperation “Running” steps with additional IP configuration guidance.
- Removed the pinned SimPublisher commit checkout from the teleop example instructions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Adds clone + cd steps to the “From Source” installation shell snippet. |
| examples/teleop/README.md | Updates teleop run instructions and simplifies SimPublisher install steps. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sorry, something went wrong.
Comment thread
examples/teleop/README.md
Outdated
Comment thread
examples/teleop/README.md
Outdated
Comment thread
examples/teleop/README.md
Outdated
Comment thread
examples/teleop/README.md
Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updated README documentation
Changes
Updated the main README.md
Updated examples/teleop/README.md