Update contributions page

README.md

@@ -1,3 +1,3 @@
 # Trunk Stack
-Welcome to the ASL Trunk robot software stack.
+Welcome to the ASL Trunk Robot software stack.
 This repository contains all code to run experiments on the Trunk platform, including [documentation](https://stanfordasl.github.io/trunk-stack/) and configuration files.

docs/contributing.md

@@ -1,40 +1,36 @@
-# Contributing to the ASL Trunk robot project
+# Contributing to the ASL Trunk Robot project
 
 Contributions are welcome! Here are some guidelines to follow when contributing to the project.
 
 ## Getting started
-Start by cloning this repository using the following command:
+Start by cloning this repository, e.g. using the following command:
 ```bash
-gh repo clone hbuurmei/asl_trunk
+gh repo clone StanfordASL/trunk-stack
 ```
-where the GitHub CLI is required to use the `gh` command (I highly recommend it).
+where the GitHub CLI is required to use the `gh` command.
 
 ## Project layout
 The project is organized as follows:
 
-    asl_trunk/
+    trunk-stack/
         README.md  # The project README file.
-        asl_trunk/  # The main package.
-            asl_trunk_ws/  # The main ROS2 workspace, incl. data collection etc.
-            mocap_ws/  # The ROS2 workspace for interfacing with the motion capture system.
-            motor_control_ws/  # The ROS2 workspace for controlling the motors.
-        docs/
-            mkdocs.yml    # The website configuration file.
+        stack/  # The main package.
+            main/  # The main ROS2 workspace, incl. data collection etc.
+            mocap/  # The ROS2 workspace for interfacing with the motion capture system.
+            motors/  # The ROS2 workspace for controlling the motors.
+        docs/  # Documentation directory.
             docs/
                 index.md  # The documentation homepage.
                 contributing.md  # This file.
                 ...       # Other markdown pages, images and other files.
+        mkdocs.yml    # The website configuration file.
 
-## Code contributions
-All the ROS2 packages are located in the `asl_trunk/` directory, and each workspace is their own repository.
-These are added via git subtrees to have everything in one place.
-Therefore, just contribute to the respective workspace repository, which will most likely be the [asl_trunk_ws](https://github.com/hbuurmei/asl_trunk_ws) repository.
-Afterwards, the main repository can be updated with the new changes using the following command:
-```bash
-git subtree pull --prefix=asl_trunk/asl_trunk_ws https://github.com/hbuurmei/asl_trunk_ws.git main
-```
+## Code Contributions
+All the ROS2 packages are located within the `stack/` directory.
+For simplicity, this is a monorepo, meaning that all the packages are in the same repository.
+However, most likely contributions will be made to the `main/` package, where e.g. the controller and the main logic are located.
 
-## Contributing to the documentation
+## Contributing to Documentation
 After cloning this repository, one can make updates to the documentation by editing the files in the `docs/` directory.
 The documentation is built using [MkDocs](https://www.mkdocs.org/), a static site generator that's geared towards project documentation.
 Specifically, we use the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.

docs/ros2_workspaces.md

@@ -0,0 +1,7 @@
+# ROS2 Workspaces
+
+## Motion Capture Workspace
+
+## Motor Control Workspace
+
+## Main Workspace

docs/software_design.md

@@ -1,9 +1,10 @@
 # Software Design
 
 ## Description
+The software stack of the ASL Trunk Robot is primarily developed in ROS2, and can be divided into three components: main, motion capture and motor control.
 
-## ROS Graph
-Generated using [ros2_graph](https://github.com/kiwicampus/ros2_graph/).
+## ROS2 Graph
+The diagrams are generated using [ros2_graph](https://github.com/kiwicampus/ros2_graph/).
 
 ```mermaid
 flowchart LR

mkdocs.yml

@@ -25,6 +25,7 @@ nav:
   - Setup:
     - 3D Printing: 3dprinting.md 
     - OpiTrack System: optitrack.md 
+    - ROS2 Workspaces: ros2_workspaces.md
   - Usage:
     - Motion Capture: mocap.md
     - Motor Control: motor_control.md