Skip to content

Commit

Permalink
Applied review comments.
Browse files Browse the repository at this point in the history
Signed-off-by: Adam Dabrowski <adam.dabrowski@robotec.ai>
  • Loading branch information
adamdbrw committed Mar 10, 2023
1 parent 245e567 commit 79eb9b0
Show file tree
Hide file tree
Showing 9 changed files with 23 additions and 22 deletions.
2 changes: 1 addition & 1 deletion content/docs/user-guide/gems/reference/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ toc: true

| Gem | Description |
| - | - |
| [ROS 2](./ros2/) | The ROS 2 Gem provides integration with the [Robot Operating System (ROS) 2](https://docs.ros.org/en/rolling/index.html) library and enables design of simulation of robotics systems. |
| [ROS 2](./robotics/ros2.md) | The ROS 2 Gem provides integration with the [Robot Operating System (ROS) 2](https://docs.ros.org/en/rolling/index.html) library and enables design of simulation of robotics systems. |

## Script

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ Open 3D Engine enables robotic simulation thanks to ROS 2 Gem. It has the follow
* Ackermann Steering, subscribes to message of type [AckermannDrive](http://docs.ros.org/en/api/ackermann_msgs/html/msg/AckermannDrive.html).
* Differential drive, subscribes to message of type [Twist](http://docs.ros.org/en/noetic/api/geometry_msgs/html/msg/Twist.html).
* URDF/XACRO (experimental).
* Allows to import robot from URDF format.
* Allows to import robot from URDF format.

## Related topics

| Topic | Description |
|------------------------------------------------------------------------------|---------------------------------------------------|
| [Robotics in O3DE](/docs/user-guide/interactivity/robotics) | Gems, Templates and Demos for Robotics |
| [Concepts and components - an overview](concepts-and-components-overview.md) | Overview of concepts and components |
| [Concepts and components - an overview](content/docs/user-guide/interactivity/robotics/concepts-and-components-overview.md) | Overview of concepts and components |
| [ROS 2 Gem API reference](/docs/api/gems/ros2) | ROS 2 Gem API reference (generated documentation) |
3 changes: 2 additions & 1 deletion content/docs/user-guide/interactivity/robotics/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
linkTitle: Robotics
title: Robotics
description: Gems for Robotics in O3DE
description: Learn how to create robotics simulation in Open 3D Engine (O3DE) with ROS 2.
---

O3DE supports simulation for robotics through a dedicated ROS 2 Gem (as well as additional Gems extending it).
Expand All @@ -13,6 +13,7 @@ There are components for simulation of sensors, robot control and steering, mani
| [Overview](overview.md) | Overview of Gems, Templates and Tutorials for robotics in O3DE |
| [ROS 2 Gem reference](/docs/user-guide/gems/reference/ros2) | Gem reference. Learn about components and structure of the Gem |
| [Configuration and build](project-configuration.md) | Learn how to configure, build and run a project with ROS 2 Gem |
| [Concepts and Components](concepts-and-components.md) | Overview of concepts and components of the ROS 2 Gem |
| [Creating robotic simulation with O3DE](creating-robotic-simulation.md) | High level steps to create a robotic simulation with O3DE |
| [Setting up CLion IDE](https://github.com/o3de/o3de-extras/blob/development/Gems/ROS2/docs/guides/development_in_clion.md) | CLion IDE project setup to support the Gem |
| [Open 3D Engine Contributor guide](/docs/contributing) | Read this guide if you wish to contribute to the Gem |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
linkTitle: Class Diagram
title: O3DE ROS 2 Gem Details
description: User guide to develop ROS 2 enabled simulation
title: ROS 2 Gem Details
description: Class Diagram for ROS 2 Gem in Open 3D Engine (O3DE).
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
linkTitle: Guide
title: O3DE ROS 2 Concepts and Structure
description: Understanding basic concepts and structure of O3DE ROS 2 Gem
linkTitle: Concepts and Structure
title: ROS 2 Concepts and Structure
description: Understanding basic concepts and structure of the ROS 2 Gem in Open 3D Engine (O3DE).
toc: true
---

Expand Down Expand Up @@ -52,7 +52,7 @@ Note that QoS class is a simple wrapper to [`rclcpp::QoS`](https://docs.ros.org/
- __Robot Import (URDF) system component__
- ROS2RobotImporterSystemComponent

See the [class diagram](class-diagram.md) to understand how components are connected.
See the [class diagram](content/docs/user-guide/interactivity/robotics/class-diagram.mdr-guide/interactivity/robotics/class-diagram.md) to understand how components are connected.

### Frames

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
linkTitle: CreatingYourSimulation
title: Creating a robotic simulation
description: Steps to create a robotic simulation using the Gem
linkTitle: Creating a Robotic Simulation
title: Creating a Robotic Simulation
description: A step-by-step process on how to create a robotic simulation using the ROS 2 Gem in Open 3D Engine (O3DE).
toc: true
---

Expand Down
6 changes: 3 additions & 3 deletions content/docs/user-guide/interactivity/robotics/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
linkTitle: RoboticsOverview
title: Overview
description: An overview of concepts, Gems, Templates and Demos for robotics.
linkTitle: Overview
title: Robotics Overview
description: An overview of concepts, Gems, templates and demos for robotics in Open 3D Engine (O3DE).
---

The ROS 2 Gem helps to build robotic simulations with [ROS 2 / Robot Operating System](https://www.ros.org/).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
linkTitle: ROS2ProjectConfiguration
title: Project Configuration
description: How to install dependencies and build a project with this Gem.
linkTitle: Project Configuration
title: ROS 2 Project Configuration
description: How to install dependencies and build a project with the ROS 2 Gem in Open 3D Engine (O3DE).
toc: true
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
linkTitle: Guide
title: O3DE ROS 2 Vehicle Dynamics
description: Understanding basic concepts and structure of O3DE ROS 2 Gem
linkTitle: Vehicle Dynamics
title: ROS 2 Vehicle Dynamics
description: Understanding basic concepts and structure of the ROS 2 Gem's vehicle dynamics in Open 3D Engine (O3DE).
toc: true
---

Expand Down

0 comments on commit 79eb9b0

Please sign in to comment.