I have further added
contribution instructions and projects (ideas right now, will add walkthroughs once I finish my docs)
current contribution instructions (can change as per your advice ) :
If you wanna contribute to this repository:
1. you may help with the formatting using # or ## for headings, > for notes, code between two sets of ``` above and below the code, and adequate spacing
2. If you’re from Husarion team, feel free to mention and use parts of my repository as and where needed, just make sure to credit me atleast once in the page used (doesn’t need to extravagant)
3. Adding missing explanations, improving examples
Fixing mistakes or outdated information
Improving tutorials or walkthroughs
Suggesting better learning resources (for e.g i tend to use ros2 humble docs and geeks for geeks for ros2 and c++ concepts respectively)
Creating FAQs
Improving troubleshooting sections
Adding screenshots or diagrams
Expanding setup guides(i generally don't write them cause they are pretty straight forward and haven't faced any problems yet)
4. Improving navigation and organization by adding hyperlinks / wiki links like
```
[alt-test](/path-to-file)
```
5. Help port this walkthrough to jazzy once Husarion docs is updated (Husarion team mentioned to me that soon the docs will be updated to ros2 jazzy)
6. Add project suggestions under [Project_suggestions.md](/ros2-roadmap-ultralab/projects/Project_suggestions.md).
Format for project suggestions :
Tag(begineer/intermediate/advanced)
one-line introduction of what to make
point wise features of the project
learning outcomes
Links and credits
e.g
```
- Begineer project :
\*\*what you'll make--\*\*
two-wheeled car with remote control,
autonomous navigation using LiDAR and SLAM,
object detection and following
\*\*what you'll learn--\*\*
ROS2 and gazebo basics including but not limited to setting up urdf and xacro files
SLAM basics
Teleoperation
Open CV basics
https://www.youtube.com/watch?v=OWeLUSzxMsw
video by \*\*Articulated Robotics\*\*
```
7. Walkthroughs of projects in Project_suggestions.md . Make a new directory for each project inside /projects directory
8. Beginners can contribute by:
- Reporting confusing sections
- Fixing typos
- Asking clarification questions
- Testing instructions
- Sharing learning feedback
- Suggesting simpler explanations
9. Accessibility and Translation
You may contribute by:
- Translating content
- Simplifying language
- Improving accessibility
- Adding captions or transcripts for linked media
- Making content easier for non-native English learners