feat(no_drivable_lane): updating docs based on latest refactoring cha…

…nges Signed-off-by: AhmedEbrahim <ahmed.a.d.ebrahim@gmail.com>
autowarefoundation · Jun 6, 2023 · dbd3c04 · dbd3c04
1 parent 23372a5
commit dbd3c04
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 2 deletions.
diff --git a/...locity_planner/no-drivable-lane-design.md → ...ne_module/docs/no-drivable-lane-design.md b/...locity_planner/no-drivable-lane-design.md → ...ne_module/docs/no-drivable-lane-design.md
@@ -13,7 +13,7 @@ Some examples of No Drivable Lanes
 - Underpass road that goes under a railway, for safety reasons
 - Road with slope/inclination that the vehicle is not be able to drive autonomously due to technical limitations. And lots of other examples.
 
-![no-drivable-lane-design.svg](docs%2Fno_drivable_lane%2Fno_drivable_lane_design.svg)
+![no-drivable-lane-design.svg](no_drivable_lane_design.svg)
 
 A lanelet becomes invalid by adding a new tag under the relevant lanelet in the map file `<tag k="no_drivable_lane" v="yes"/>`.
 
@@ -42,7 +42,7 @@ This function is activated when the lane id of the target path has an no drivabl
   - the distance from front of the ego vehicle till the first intersection point between the ego path and the no drivable lane polygon is less than the `stop_margin`
 - Assign the state to `STOPPED` when the vehicle is completely stopped
 
-![no_drivable_lane_scenarios.svg](docs%2Fno_drivable_lane%2Fno_drivable_lane_scenarios.svg)
+![no_drivable_lane_scenarios.svg](no_drivable_lane_scenarios.svg)
 
 - At each state, RTC settings are assigned according to the following table
 

diff --git a/...drivable_lane/no_drivable_lane_design.svg → ...e_module/docs/no_drivable_lane_design.svg b/...drivable_lane/no_drivable_lane_design.svg → ...e_module/docs/no_drivable_lane_design.svg
diff --git a/...vable_lane/no_drivable_lane_scenarios.svg → ...odule/docs/no_drivable_lane_scenarios.svg b/...vable_lane/no_drivable_lane_scenarios.svg → ...odule/docs/no_drivable_lane_scenarios.svg
diff --git a/planning/behavior_velocity_planner/README.md b/planning/behavior_velocity_planner/README.md
@@ -20,6 +20,7 @@ It loads modules as plugins. Please refer to the links listed below for detail o
 - [Run Out](../behavior_velocity_run_out_module/docs/run-out-design.md)
 - [Speed Bump](../behavior_velocity_speed_bump_module/docs/speed-bump-design.md)
 - [Out of Lane](../behavior_velocity_out_of_lane_module/docs/out-of-lane-design.md)
+- [No Drivable Lane](../behavior_velocity_no_drivable_lane_module/docs/no-drivable-lane-design.md)
 
 When each module plans velocity, it considers based on `base_link`(center of rear-wheel axis) pose.
 So for example, in order to stop at a stop line with the vehicles' front on the stop line, it calculates `base_link` position from the distance between `base_link` to front and modifies path velocity from the `base_link` position.