Clarify distinction between examples, demos, tutorials
@emersonknapp is already working on this.
Since May 9, 2025.
Assessment
This issue has not been assessed yet.
Description
The README nor repository description makes their intended purposes clear. Or at least, a separation of their purpose.
This repository contains source code for demos mentioned in the official ROS 2 documentation Tutorials.
To see some of these examples in use, visit the ROS 2 Tutorials page.
It seems that they partially or totally overlap. When making new documentation/tutorials/example code, it's unclear which repo that should go into.
Criteria to close this issue would be either of:
- the distinction is dissolved and the repos are merged into one, OR
- or the distinction is clarified and added at minimum to the README
- Dominant language
- C++
- Stars
- 970
- Forks
- 365
- Avg merge
- 12d 20h
- Merged PRs (30d)
- 1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ros2/examples
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
-
good first issue
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
good first issue
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
good first issue
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
ros2/message_filters#338 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
subsurface/subsurface#4984 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
flutter-webrtc/flutter-webrtc#2206 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
google-ai-edge/LiteRT-LM#3739 ·