Skip to content

Commit 130bb53

Browse files
committed
Fixed broken links.
1 parent 238203f commit 130bb53

13 files changed

Lines changed: 21 additions & 21 deletions

File tree

_docs/concepts/client_library/features/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ The micro-ROS Client Library, formed by standard [ROS 2 Client Support Library (
1313
* Lifecycle
1414
* Parameters
1515

16-
Most features are already available in the Foxy release. Please see our [Feature Overview page](/docs/overview/features/) for details on the status. To learn developing your own application nodes with rcl + rclc, please head to the corresponding [programming tutorial](/docs/tutorials/core/programming_rcl_rclc/).
16+
Most features are already available in the Foxy release. Please see our [Feature Overview page](/docs/overview/features/) for details on the status. To learn developing your own application nodes with rcl + rclc, please head to the corresponding [programming tutorial](/docs/tutorials/firststeps/programming_rcl_rclc/).

_docs/concepts/middleware/Micro_XRCE-DDS/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ These definitions allow to create a version of the library according to the appl
4444
For incorporating the desired configuration, it is necessary to run the `cmake` command every time the definitions change.
4545

4646
For more information on how to configure micro-ROS by opportunely tuning parameters either in the Micro XRCE-DDS library
47-
orin its rmw implementation [`rmw_microxrcedds`](https://github.com/micro-ROS/rmw-microxrcedds), consult this [tutorial](/docs/tutorials/core/microxrcedds_rmw_configuration/) and the `rmw_microxrcedds` [README](https://github.com/micro-ROS/rmw-microxrcedds#rmw-micro-xrce-dds-implementation).
47+
orin its rmw implementation [`rmw_microxrcedds`](https://github.com/micro-ROS/rmw-microxrcedds), consult this [tutorial](/docs/tutorials/advanced/microxrcedds_rmw_configuration/) and the `rmw_microxrcedds` [README](https://github.com/micro-ROS/rmw-microxrcedds#rmw-micro-xrce-dds-implementation).
4848

4949
### Multi-Transport Support
5050

@@ -76,7 +76,7 @@ Additionally, using references will also reduce the memory consumption of the Cl
7676
This is because the reference approach allows avoiding to build the parts of the code where XMLs are stored.
7777

7878
Notice that this mechanism is inherited by micro-ROS which, as a consequence, will be able to leverage the same full set of QoS as ROS 2.
79-
For a comprehensive review on how to use custom QoS in micro-ROS, please visit this [dedicated page](/docs/tutorials/core/create_dds_entities_by_ref/) in the tutorials section.
79+
For a comprehensive review on how to use custom QoS in micro-ROS, please visit this [dedicated page](/docs/tutorials/advanced/create_dds_entities_by_ref/) in the tutorials section.
8080

8181

8282
## Other links
@@ -87,5 +87,5 @@ For a comprehensive review on how to use custom QoS in micro-ROS, please visit t
8787
* [XRCE Agent on GitHub](https://github.com/eProsima/Micro-XRCE-DDS-Agent)
8888
* [rmw_microxrcedds on GitHub](https://github.com/micro-ROS/rmw-microxrcedds)
8989
* [Micro XRCE-DDS memory profiling](/docs/concepts/middleware/memo_prof/)
90-
* [Middleware optimization tutorial](/docs/tutorials/core/microxrcedds_rmw_configuration/).
91-
* [How to use custom QoS in micro-ROS](/docs/tutorials/core/create_dds_entities_by_ref/)
90+
* [Middleware optimization tutorial](/docs/tutorials/advanced/microxrcedds_rmw_configuration/).
91+
* [How to use custom QoS in micro-ROS](/docs/tutorials/advanced/create_dds_entities_by_ref/)

_docs/overview/ROS_2_feature_comparison/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ ROS 2 Feature | | Availability in micro-ROS
4545
-- | -- | --
4646
Transport and serialization over DDS-XRCE and DDS| <span class="status_flag">&#10003;&#43;</span> | Available transports: UDP, serial (UART) and custom as enabled by [Micro XRCE-DDS](https://github.com/eProsima/Micro-XRCE-DDS). Serialization between Client and Agent provided by [Micro-CDR](https://github.com/eProsima/Micro-CDR) and between Agent to standard DDS by [Fast-CDR](https://github.com/eProsima/Fast-CDR).
4747
Support for multiple DDS implementations, chosen at runtime | <span class="status_flag">&#10003;</span> | Support via the Micro XRCE-DDS Agent is possible in principle, but at compile-time only.
48-
Quality of service settings for handling non-ideal networks | <span class="status_flag">&#10003;&#43;</span> | For communication over the DDS-XRCE wire protocol, two QoS semantics, reliable and best-effort, are provided and can be set at compile-time. As for communication with the ROS 2 dataspace, micro-ROS entities can benefit from the whole set of QoS allowed by DDS when created [by Reference](https://micro-ros.github.io/docs/tutorials/core/create_dds_entities_by_ref/).
48+
Quality of service settings for handling non-ideal networks | <span class="status_flag">&#10003;&#43;</span> | For communication over the DDS-XRCE wire protocol, two QoS semantics, reliable and best-effort, are provided and can be set at compile-time. As for communication with the ROS 2 dataspace, micro-ROS entities can benefit from the whole set of QoS allowed by DDS when created [by Reference](https://micro-ros.github.io/docs/tutorials/advanced/create_dds_entities_by_ref/).
4949
DDS-Security support | <span class="status_flag">&#10003;&#45;</span> | Security is not yet supported in the communication process between the Client and the Agent. However, the micro-ROS Agent can benefit from Fast DDS security capabilities during the creation of DDS entities. *Roadmap: Implementation of security mechanisms in Micro XRCE-DDS are planned for future releases.*
5050
IDL | <span class="status_flag">&#10003;&#43;</span> | micro-ROS supports the same IDL types as ROS 2. Generation of C code from IDLs as handled by the Client is performed by the [Micro-XRCE-DDS-Gen](https://github.com/eProsima/Micro-XRCE-DDS-Gen) library, whereas generation of the C++ types handled by the Agent is handled by [Fast-DDS-Gen](https://github.com/eProsima/Fast-DDS-Gen).
5151
Logging | <span class="status_flag">&#8727;</span> | *Could be available as part of the standard logging mechanism in principle but not supported by Micro-XRCE-DDS due to dynamic message size. To be checked ...*

_docs/overview/hardware/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ permalink: /docs/overview/hardware/
3030

3131
Micro-ROS aims to **bring ROS 2 to a wide set of microcontrollers** to allow having first-class ROS 2 entities in the embedded world.
3232

33-
The main targets of micro-ROS are mid-range 32-bits microcontroller families. Usually, the minimum requirements for running micro-ROS in an embedded platform are memory constraints. Since memory usage in micro-ROS is a complex matter we provide a [complete article](https://micro-ros.github.io/docs/concepts/benchmarking/memo_prof/) describing it and a tutorial on [how to tune the memory consuption](https://micro-ros.github.io/docs/tutorials/core/microxrcedds_rmw_configuration/) in the micro-ROS middleware.
33+
The main targets of micro-ROS are mid-range 32-bits microcontroller families. Usually, the minimum requirements for running micro-ROS in an embedded platform are memory constraints. Since memory usage in micro-ROS is a complex matter we provide a [complete article](https://micro-ros.github.io/docs/concepts/benchmarking/memo_prof/) describing it and a tutorial on [how to tune the memory consuption](https://micro-ros.github.io/docs/tutorials/advanced/microxrcedds_rmw_configuration/) in the micro-ROS middleware.
3434

3535
In general micro-ROS will need MCUs that have tens of kilobytes of RAM memory and communication peripherals that enable the micro-ROS [Client to Agent communication](https://micro-ros.github.io//docs/overview/features/).
3636

_docs/overview/rtos/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Even though recent developments aim at loosening this requirement, with the inte
3737
To date, micro-ROS is supported by the RTOSes FreeRTOS, Zephyr, NuttX, in addition to Linux and Windows.
3838
All three RTOSes are downloaded natively with the [micro-ROS build system](https://github.com/micro-ROS/micro_ros_setup), and can be chosen when creating
3939
a new firmware workspace.
40-
Dedicated tutorials for running your first micro-ROS application on each of these Operating Systems can be found [here](https://micro-ros.github.io/docs/tutorials/core/first_application_rtos/).
40+
Dedicated tutorials for running your first micro-ROS application on each of these Operating Systems can be found [here](https://micro-ros.github.io/docs/tutorials/firststeps/first_application_rtos/).
4141
The features common to all supported RTOSes are an API compliant with POSIX to some degree, extremely low-to-low memory footprint, and availability of different scheduling algorithms to ensure determinism in micro-ROS apps behavior.
4242

4343
Find more details about each of the supported RTOSes below.
@@ -72,7 +72,7 @@ FreeRTOS is distributed under the MIT license. It is known particularly for its
7272
<b>FreeRTOS & micro-ROS:</b>
7373
<ul>
7474
<li><a href="https://www.freertos.org/2020/09/micro-ros-on-freertos.html">micro-ROS on FreeRTOS</a></li>
75-
<li><a href="https://micro-ros.github.io/docs/tutorials/core/first_application_rtos/freertos/">First micro-ROS Application on FreeRTOS</a></li>
75+
<li><a href="https://micro-ros.github.io/docs/tutorials/firststeps/first_application_rtos/freertos/">First micro-ROS Application on FreeRTOS</a></li>
7676
</ul>
7777
</div>
7878
</div>
@@ -109,7 +109,7 @@ Zephyr is a fairly new open-source RTOS, developed in a Linux Foundation Project
109109
<b>Zephyr & micro-ROS:</b>
110110
<ul>
111111
<li><a href="https://www.zephyrproject.org/micro-ros-a-member-of-the-zephyr-project-and-integrated-into-the-zephyr-build-system-as-a-module/">micro-ROS on Zephyr</a></li>
112-
<li><a href="https://micro-ros.github.io/docs/tutorials/core/first_application_rtos/zephyr/">First micro-ROS Application on Zephyr</a></li>
112+
<li><a href="https://micro-ros.github.io/docs/tutorials/firststeps/first_application_rtos/zephyr/">First micro-ROS Application on Zephyr</a></li>
113113
<li><a href="https://micro-ros.github.io/docs/tutorials/advanced/zephyr_emulator/">First micro-ROS Application on Zephyr Emulator</a></li>
114114
</ul>
115115
</div>
@@ -142,7 +142,7 @@ NuttX emphasizes its compliance with standards - including POSIX - and small foo
142142
</ul>
143143
<b>NuttX & micro-ROS:</b>
144144
<ul>
145-
<li><a href="https://micro-ros.github.io/docs/tutorials/core/first_application_rtos/nuttx/">First micro-ROS Application on NuttX</a></li>
145+
<li><a href="https://micro-ros.github.io/docs/tutorials/firststeps/first_application_rtos/nuttx/">First micro-ROS Application on NuttX</a></li>
146146
</ul>
147147
</div>
148148
</div>

_docs/tutorials/advanced/create_dds_entities_by_ref/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ But these QoS configurations may not fit some user's requirements. For these cas
6868
Additionally, using references will also reduce the memory consumption of the micro-ROS client inside the MCU. This is because the parts of the code where XML are handled are just not build with the references approach.
6969

7070
Let's see how to create a micro-ROS node that creates entities with custom QoS. First of all, independently of which RTOS you have selected in [First micro-ROS Application on an RTOS
71-
](https://micro-ros.github.io/docs/tutorials/core/first_application_rtos/) tutorial, you should have an app configuration file named `app-colcon.meta`.
71+
](https://micro-ros.github.io/docs/tutorials/firststeps/first_application_rtos/) tutorial, you should have an app configuration file named `app-colcon.meta`.
7272

7373
Inside this `app-colcon.meta` file we can set application specific CMake options for the micro-ROS packages that are going to be crosscompiled. So, let's setup the `rmw_microxrcedds` in order to use references; your `app-colcon.meta` should look like this:
7474

@@ -86,7 +86,7 @@ Inside this `app-colcon.meta` file we can set application specific CMake options
8686
}
8787
```
8888

89-
Of course you can combine these configurations with others, e.g. the ones described in the [Middleware Configuration](https://micro-ros.github.io/docs/tutorials/core/microxrcedds_rmw_configuration/) tutorial.
89+
Of course you can combine these configurations with others, e.g. the ones described in the [Middleware Configuration](https://micro-ros.github.io/docs/tutorials/advanced/microxrcedds_rmw_configuration/) tutorial.
9090

9191
Once you have this parameter, write your micro-ROS application using RCLC default convenience functions. Just remember that now you are not providing the topic name but a "QoS reference label":
9292

_docs/tutorials/advanced/microxrcedds_rmw_configuration/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The rmw-microxrcedds uses a static-memory message queue where to to keep the sub
5959
The size of this message queue could be set by the `RMW_UXRCE_MAX_HISTORY`.
6060

6161
It is worth noting that all the aforementioned CMake flags shall be set in a `.meta` for each platform supported in [micro_ros_setup](https://github.com/micro-ROS/micro_ros_setup).
62-
For example, in the [ping-pong application](https://micro-ros.github.io//docs/tutorials/core/first_application_linux/) the host [configuration file](https://github.com/micro-ROS/micro_ros_setup/blob/foxy/config/host/generic/client-host-colcon.meta) can be optimized with the following modifications:
62+
For example, in the [ping-pong application](https://micro-ros.github.io//docs/tutorials/firststeps/first_application_linux/) the host [configuration file](https://github.com/micro-ROS/micro_ros_setup/blob/foxy/config/host/generic/client-host-colcon.meta) can be optimized with the following modifications:
6363

6464
```
6565
{

_docs/tutorials/firststeps/first_application_linux/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ permalink: /docs/tutorials/firststeps/first_application_linux/
66
## Target platform
77

88
In this tutorial, you’ll learn the use of micro-ROS with Linux by testing a Ping Pong application.
9-
In the follow-up tutorial [*First micro-ROS application on an RTOS*](/docs/tutorials/core/first_application_rtos/),
9+
In the follow-up tutorial [*First micro-ROS application on an RTOS*](/docs/tutorials/firststeps/first_application_rtos/),
1010
you'll learn how to build and bring this application on a microcontroller running the RTOS NuttX, FreeRTOS, or Zephyr.
1111
Finally, in the tutorial [*Zephyr Emulator*](/docs/tutorials/advanced/zephyr_emulator/) you'll learn how to test
1212
a micro-ROS application on a Zephyr emulator.

_docs/tutorials/firststeps/first_application_rtos/freertos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Each app is represented by a folder containing the following files:
2828
* `app.c`: This file contains the logic of the application.
2929
* `app-colcon.meta`: This file contains the micro-ROS app specific colcon configuration. Detailed info on how to
3030
configure the RMW via this file can be found
31-
[here](https://micro-ros.github.io/docs/tutorials/core/microxrcedds_rmw_configuration/).
31+
[here](https://micro-ros.github.io/docs/tutorials/advanced/microxrcedds_rmw_configuration/).
3232

3333
For the user to create its custom application, a folder `<my_app>` will need to be registered in this location,
3434
containing the two files just described.

_docs/tutorials/old/add_microros_config/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ permalink: /docs/tutorials/old/add_microros_config/
99
|:-----:|:------------:|
1010
| NuttX | Dashing |
1111

12-
In this tutorial, we will see how to set a basic Micro-ROS configuration for NuttX over serial communication. Since this guide is only focused on setting the configuration, you should check the tutorial linked here before: [First micro-ROS Application on an RTOS](https://micro-ros.github.io/docs/tutorials/core/first_application_rtos/)
12+
In this tutorial, we will see how to set a basic Micro-ROS configuration for NuttX over serial communication. Since this guide is only focused on setting the configuration, you should check the tutorial linked here before: [First micro-ROS Application on an RTOS](https://micro-ros.github.io/docs/tutorials/firststeps/first_application_rtos/)
1313

1414
**Disclamer**
1515

@@ -76,7 +76,7 @@ make menuconfig
7676
The menu below should appear:
7777
![](images/nuttx_menuconfig.png)
7878

79-
Note: Remember that you should follow this previous tutorial before starting it. [First micro-ROS Application on an RTOS](https://micro-ros.github.io/docs/tutorials/core/first_application_rtos/)
79+
Note: Remember that you should follow this previous tutorial before starting it. [First micro-ROS Application on an RTOS](https://micro-ros.github.io/docs/tutorials/firststeps/first_application_rtos/)
8080

8181
In the menu, you need to set the following configuration.
8282

0 commit comments

Comments
 (0)