diff --git a/docs/ros2_workspaces.md b/docs/ros2_workspaces.md index 0fc061b..b4d8dd9 100644 --- a/docs/ros2_workspaces.md +++ b/docs/ros2_workspaces.md @@ -24,6 +24,13 @@ source install/setup.bash ``` Check that the build process runs without any errors. +??? note "General note" + + It is highly recommended to build individual packages (within a workspace) upon changes, using the syntax: + ```bash + colcon build --packages-select interfaces + ``` + ## Motion Capture Workspace **Note:** This workspace runs on the main machine. @@ -71,3 +78,16 @@ Due to compatibility constraints of this package, we use ROS2 Foxy for this work Clone the `trunk-stack` repository on the Pi and enter the `motors/` folder. +Enter the source directory and clone the package: +```bash +cd src/ +git clone https://github.com/vanderbiltrobotics/ros_phoenix +``` + +Note that the launch script `trunk.launch.py` is also being version controlled, therefore ensure that is placed in its respective location. + +Again, build the workspace: +```bash +cd .. # enter 'motors' dir. +colcon build --symlink-install +``` diff --git a/mkdocs.yml b/mkdocs.yml index 6b39ba4..a93ae9a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,6 +13,9 @@ theme: primary: custom features: - content.code.copy + icon: + adminition: + note: material/alert-circle extra_css: - stylesheets/extra.css @@ -39,12 +42,14 @@ nav: markdown_extensions: - attr_list - md_in_html + - admonition - pymdownx.highlight: anchor_linenums: true line_spans: __span pygments_lang_class: true - pymdownx.inlinehilite - pymdownx.snippets + - pymdownx.details - pymdownx.superfences: custom_fences: - name: mermaid