Skip to content

Commit cbba64a

Browse files
committed
Put versioned links in api pages
1 parent 510183e commit cbba64a

File tree

7 files changed

+15
-15
lines changed

7 files changed

+15
-15
lines changed

docs/40-api/21-transformations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This page is describing the upcoming ROS2 version of the MRS UAV System (however
1212

1313
![](fig/transformations.png)
1414

15-
As a robotic system, the MRS system makes use of many coordinate [reference frames](/docs/api/frames_of_reference).
15+
As a robotic system, the MRS system makes use of many coordinate [reference frames](./20-frames_of_reference.md).
1616
Transformations within the MRS system are maintained by the [tf2 ros package](http://wiki.ros.org/tf2) and [Transformer](https://ctu-mrs.github.io/mrs_lib/classmrs__lib_1_1Transformer.html) from the [mrs_lib package](https://ctu-mrs.github.io/mrs_lib/), which is a tf2 wrapper with several functions simplifying the work with transformations.
1717
The transformations within the MRS system are important not only for tracking the relationship among particular coordinate frames, but they are used also to enable sending commands in various reference frames independently on current control frame.
1818

docs/40-api/22-custom_real_world_file.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This page is describing the upcoming ROS2 version of the MRS UAV System (however
1010

1111
# Frames of Reference
1212

13-
As described in the [Frames of Reference](/docs/api/frames_of_reference) manual, the MRS system offers a flexible way to define the coordinate frames used in the system. This is enabled using geographical libraries in the real-world that map from latitude-longitude coordinates to the local Cartesian coordinate system. The MRS system uses the [GeographicLib](https://geographiclib.sourceforge.io/) library to handle these transformations.
13+
As described in the [Frames of Reference](./20-frames_of_reference.md) manual, the MRS system offers a flexible way to define the coordinate frames used in the system. This is enabled using geographical libraries in the real-world that map from latitude-longitude coordinates to the local Cartesian coordinate system. The MRS system uses the [GeographicLib](https://geographiclib.sourceforge.io/) library to handle these transformations.
1414

1515
# Custom Real World File
1616

docs/40-api/30-trajectories.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This page is describing the upcoming ROS2 version of the MRS UAV System (however
1515
- An ordered sequence of geometric poses without any notion of time.
1616
- Specifies what poses should the UAV fly through: no control over dynamics.
1717
- Has to be sampled first by sampling period `T`.
18-
- See [below](https://ctu-mrs.github.io/docs/system/trajectories.html#generating-trajectories-from-paths) on how to generate dynamically feasible trajectories from paths.
18+
- See [below](#generating-trajectories-from-paths) on how to generate dynamically feasible trajectories from paths.
1919

2020
**Trajectory** ([mrs_msgs/TrajectoryReference.msg](https://ctu-mrs.github.io/mrs_msgs/interfaces/msg/TrajectoryReference.html))
2121

@@ -36,13 +36,13 @@ It expects trajectory sampled with period of T = 0.2 s (can be modified in the m
3636
0.2,0.2,1.2,0.1
3737
0.3,0.1,1.4,0.15
3838
```
39-
The trajectory loaded with `mrs-ctu/trajectory_loader` will be input to the current [reference tracker](https://ctu-mrs.github.io/docs/software/uav_core/mrs_uav_trackers/), which will generate all-state and feasible reference for the [controller](https://ctu-mrs.github.io/docs/software/uav_core/mrs_uav_controllers/).
39+
The trajectory loaded with `mrs-ctu/trajectory_loader` will be input to the current [reference tracker](../50-features/20-trackers/index.md), which will generate all-state and feasible reference for the [controller](../50-features/10-controllers/index.md).
4040

4141
## Generating trajectories from paths
4242

43-
You can generate your own trajectories and publish them to `control_manager/trajectory_reference` to fly them (see [UAV-ROS interface](https://ctu-mrs.github.io/docs/system/uav_ros_interface.html#selected-services-for-program-to-machine-interaction)).
43+
You can generate your own trajectories and publish them to `control_manager/trajectory_reference` to fly them (see [UAV-ROS interface](./01-uav_ros_api.md#selected-services-for-program-to-machine-interaction)).
4444
This pipeline follows the same scheme `trajectory->tracker->controller` as if the trajectory was loaded with `mrs-ctu/trajectory_loader`.
4545
If a trajectory is **not feasible under dynamic constraints for the UAV, the resulting trajectory may be degraded**.
4646

47-
To convert a desired waypoint path to a **trajectory feasible under dynamic constraints of the UAV**, you can use the [`mrs_uav_trajectory_generation`](https://github.com/ctu-mrs/mrs_uav_trajectory_generation) package.
48-
See the package documentation for more information about generating trajectories under dynamic constraints and [list of topics/services](https://ctu-mrs.github.io/docs/system/uav_ros_interface.html#trajectory-generation) for using the `mrs_uav_trajectory_generation` package.
47+
To convert a desired waypoint path to a **trajectory feasible under dynamic constraints of the UAV**, you can use the [`mrs_uav_trajectory_generation`](../50-features/30-trajectory_generation/index.md) package.
48+
See the package documentation for more information about generating trajectories under dynamic constraints and [list of topics/services](./01-uav_ros_api.md#trajectory-generation) for using the `mrs_uav_trajectory_generation` package.

versioned_docs/version-1.5.0/40-api/20-frames_of_reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Coordinate systems for mobile robots follow hierarchical convention (check coord
2525
```bash
2626
world -> map -> odometry -> fcu -> sensors
2727
```
28-
The [transformations](/docs/api/transformations) (`->`) among coordination frames are maintained by [tf2 ROS library](http://wiki.ros.org/tf2).
28+
The [transformations](./21-transformations.md) (`->`) among coordination frames are maintained by [tf2 ROS library](http://wiki.ros.org/tf2).
2929
The `tf2` library requires the mutual transformations to be stored in a **tree structure**, where each node has a single *parent* and there exists only a single **root** node with no *parent*.
3030

3131
But, maintaining the **tree structure** is impossible for multiple *world*/*map*/*odometry* coordinate frames.

versioned_docs/version-1.5.0/40-api/21-transformations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: Handling transformations within the MRS
88

99
![](fig/transformations.png)
1010

11-
As a robotic system, the MRS system makes use of many coordinate [reference frames](/docs/api/frames_of_reference).
11+
As a robotic system, the MRS system makes use of many coordinate [reference frames](./20-frames_of_reference.md).
1212
Transformations within the MRS system are maintained by the [tf2 ros package](http://wiki.ros.org/tf2) and [Transformer](https://ctu-mrs.github.io/mrs_lib/classmrs__lib_1_1Transformer.html) from the [mrs_lib package](https://ctu-mrs.github.io/mrs_lib/), which is a tf2 wrapper with several functions simplifying the work with transformations.
1313
The transformations within the MRS system are important not only for tracking the relationship among particular coordinate frames, but they are used also to enable sending commands in various reference frames independently on current control frame.
1414

versioned_docs/version-1.5.0/40-api/22-custom_real_world_file.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: How to create a custom real world file for the MRS system to fly in
66

77
# Frames of Reference
88

9-
As described in the [Frames of Reference](/docs/api/frames_of_reference) manual, the MRS system offers a flexible way to define the coordinate frames used in the system. This is enabled using geographical libraries in the real-world that map from latitude-longitude coordinates to the local Cartesian coordinate system. The MRS system uses the [GeographicLib](https://geographiclib.sourceforge.io/) library to handle these transformations.
9+
As described in the [Frames of Reference](./20-frames_of_reference.md) manual, the MRS system offers a flexible way to define the coordinate frames used in the system. This is enabled using geographical libraries in the real-world that map from latitude-longitude coordinates to the local Cartesian coordinate system. The MRS system uses the [GeographicLib](https://geographiclib.sourceforge.io/) library to handle these transformations.
1010

1111
# Custom Real World File
1212

versioned_docs/version-1.5.0/40-api/30-trajectories.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: Supplying trajectory input
1111
- An ordered sequence of geometric poses without any notion of time.
1212
- Specifies what poses should the UAV fly through: no control over dynamics.
1313
- Has to be sampled first by sampling period `T`.
14-
- See [below](https://ctu-mrs.github.io/docs/system/trajectories.html#generating-trajectories-from-paths) on how to generate dynamically feasible trajectories from paths.
14+
- See [below](#generating-trajectories-from-paths) on how to generate dynamically feasible trajectories from paths.
1515

1616
**Trajectory** ([mrs_msgs/TrajectoryReference.msg](https://ctu-mrs.github.io/mrs_msgs/msg/TrajectoryReference.html))
1717

@@ -32,13 +32,13 @@ It expects trajectory sampled with period of T = 0.2 s (can be modified in the m
3232
0.2,0.2,1.2,0.1
3333
0.3,0.1,1.4,0.15
3434
```
35-
The trajectory loaded with `mrs-ctu/trajectory_loader` will be input to the current [reference tracker](https://ctu-mrs.github.io/docs/software/uav_core/mrs_uav_trackers/), which will generate all-state and feasible reference for the [controller](https://ctu-mrs.github.io/docs/software/uav_core/mrs_uav_controllers/).
35+
The trajectory loaded with `mrs-ctu/trajectory_loader` will be input to the current [reference tracker](../50-features/20-trackers/index.md), which will generate all-state and feasible reference for the [controller](../50-features/10-controllers/index.md).
3636

3737
## Generating trajectories from paths
3838

39-
You can generate your own trajectories and publish them to `control_manager/trajectory_reference` to fly them (see [UAV-ROS interface](https://ctu-mrs.github.io/docs/system/uav_ros_interface.html#selected-services-for-program-to-machine-interaction)).
39+
You can generate your own trajectories and publish them to `control_manager/trajectory_reference` to fly them (see [UAV-ROS interface](./01-uav_ros_api.md#selected-services-for-program-to-machine-interaction)).
4040
This pipeline follows the same scheme `trajectory->tracker->controller` as if the trajectory was loaded with `mrs-ctu/trajectory_loader`.
4141
If a trajectory is **not feasible under dynamic constraints for the UAV, the resulting trajectory may be degraded**.
4242

43-
To convert a desired waypoint path to a **trajectory feasible under dynamic constraints of the UAV**, you can use the [`mrs_uav_trajectory_generation`](https://github.com/ctu-mrs/mrs_uav_trajectory_generation) package.
44-
See the package documentation for more information about generating trajectories under dynamic constraints and [list of topics/services](https://ctu-mrs.github.io/docs/system/uav_ros_interface.html#trajectory-generation) for using the `mrs_uav_trajectory_generation` package.
43+
To convert a desired waypoint path to a **trajectory feasible under dynamic constraints of the UAV**, you can use the [`mrs_uav_trajectory_generation`](../50-features/30-trajectory_generation/index.md) package.
44+
See the package documentation for more information about generating trajectories under dynamic constraints and [list of topics/services](./01-uav_ros_api.md#trajectory-generation) for using the `mrs_uav_trajectory_generation` package.

0 commit comments

Comments
 (0)