Skip to content
Rain1618 edited this page Apr 6, 2025 · 14 revisions

๐Ÿ“š Welcome to the AUV Wiki! ๐Ÿ“š

This is the one-stop-shop for any and all information related to McGill Robotics' AUV Project!

Below, we provide links to key sites & hubs, this project's documentation, and contact information.

Quick Links

At the top level, here are the key sites & hubs relevant to the AUV Project and the McGill Robotics Team:

:octocat: AUV Main Repo
๐ŸŽฎ AUV Sim Repo
๐Ÿ Wiki Home
๐Ÿณ Docker Hub
๐Ÿค– McGill Robotics Website
๐Ÿ“š Google Drive
๐Ÿ† Robosub Competition Tasks

Documentation

For those looking for an in depth guide to this project, our documentation offers information about every part of the Project: what we compete in, the technologies we use, how to contribute to the project, etc..

The documentation comprises six sections, designed to flow naturally from start to end. We build up from a basic overview and motivation, to how you can start contributing, followed by a technical breakdown, and then offering additional key resources for learning, competition details and project maintenance.

As part of the onboarding process, new members should go through the entire documentation at least once, and are encouraged to regularly refer back to it along with asking questions to more seasoned members in order to gain a deep understanding of the project.

Links to the documentation:

1.1 Project Mission & Competition Goals
1.2 System Architecture at a Glance
1.3 Key Concepts & Technologies
1.4 Repository Guide

2.1 Setting up the Development Environment
2.2 Run Your First Mission
2.3 Development Workflow

3.1 Overview of the ROS Environment
3.2 ROS Packages
3.3 ROS Topics & Services

4.1 Learn Bash
4.2 Learn Git
4.3 Learn Docker
4.4 Learn ROS2
4.5 In-Project Tutorials

6.1 Project Maintenance
6.2 Team Knowledge
6.3 FAQ & Troubleshooting

Once you're done, you can evaluate your confidence on any topic with the Onboarding Checklist.

Contact the Team

To reach out to someone in the AUV Project's team, or to McGill Robotics more generally, consult the contacts page.