Removed ROS docs, replaced with an brief overview and a link to the n…

…ew docs. Updated nav and index to reflect changes
matejm42 · Apr 16, 2021 · a2a9737 · a2a9737
1 parent eb8d79a
commit a2a9737
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 21 deletions.
diff --git a/Docs/index.md b/Docs/index.md
@@ -65,10 +65,7 @@ CARLA forum</a>
 [__carlaviz — web visualizer__](plugins_carlaviz.md) — Plugin that listens the simulation and shows the scene and some simulation data in a web browser.  
 
 ## ROS bridge
-[__ROS bridge installation__](ros_installation.md) — The different ways to install the ROS bridge.  
-[__CARLA messages reference__](ros_msgs.md) — Contains explanations and fields for every type of CARLA message available in ROS.  
-[__Launchfiles reference__](ros_launchs.md) — Lists the launchfiles and nodes provided, and the topics being consumed and published.  
-
+[__ROS bridge documentation__](ros_documentation.md) — Brief overview of the ROS bridge and a link to the full documentation
 ## Tutorials — General
 [__Add friction triggers__](tuto_G_add_friction_triggers.md) — Define dynamic box triggers for wheels.  
 [__Control vehicle physics__](tuto_G_control_vehicle_physics.md) — Set runtime changes on a vehicle physics.  

diff --git a/Docs/ros_documentation.md b/Docs/ros_documentation.md
@@ -0,0 +1,16 @@
+# ROS Bridge
+
+__Full documentation of the ROS bridge is found [__here__](https://carla.readthedocs.io/projects/ros-bridge/en/latest/).__
+
+---
+
+The ROS bridge enables two-way communication between ROS and CARLA. The information from the CARLA server is translated to ROS topics. In the same way, the messages sent between nodes in ROS get translated to commands to be applied in CARLA.
+
+The ROS bridge is compatible with both ROS 1 and ROS 2.
+
+The ROS bridge boasts the following features:
+
+- Provides sensor data for LIDAR, Semantic LIDAR, Cameras (depth, segmentation, rgb, dvs), GNSS, Radar and IMU.
+- Provides object data such as transforms, traffic light status, visualisation markers, collision and lane invasion.
+- Control of AD agents through steering, throttle and brake.
+- Control of aspects of the CARLA simulation like synchronous mode, playing and pausing the simulation and setting simulation parameters.
diff --git a/Docs/ros_installation.md b/Docs/ros_installation.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -44,9 +44,7 @@ nav:
 - Plugins:
   - 'carlaviz — web visualizer': 'plugins_carlaviz.md'
 - ROS bridge:
-  - 'ROS bridge installation': 'ros_installation.md'
-  - 'CARLA messages reference': 'ros_msgs.md'
-  - 'Launchfiles reference': 'ros_launchs.md'
+  - 'ROS bridge documentation': 'ros_documentation.md'
 - Tutorials (general):
   - 'Add friction triggers': "tuto_G_add_friction_triggers.md"
   - 'Control vehicle physics': "tuto_G_control_vehicle_physics.md"