initial route tool tutorial development

john-chrosniak · john-chrosniak · commit 753e6fee3c43 · 2025-01-30T11:04:35.000-05:00
Signed-off-by: John Chrosniak &lt;chrosniakj@gmail.com&gt;
diff --git a/tutorials/docs/images/Navigation2_route_tool/route_tool_demo.gif b/tutorials/docs/images/Navigation2_route_tool/route_tool_demo.gif
diff --git a/tutorials/docs/navigation2_route_tool.rst b/tutorials/docs/navigation2_route_tool.rst
@@ -0,0 +1,29 @@
+.. _navigation2_route_tool:
+
+Using the Nav2 Route Tool
+*************************
+
+- `Overview`_
+- `Requirements`_
+- `Tutorial Steps`_
+
+.. image:: images/Navigation2_route_tool/route_tool_demo.gif
+    :width: 60%
+    :align: center
+
+Overview
+========
+
+The Nav2 route tool is an Rviz panel designed to ease the process of creating and editing the route graphs used by the Nav2 Route Server.
+
+Supported operations include loading in existing route graphs, adding new nodes/edges, editing existing nodes/edges, removing nodes/edges, and saving changes to a new file.
+
+Requirements
+============
+
+TODO
+
+Tutorial Steps
+==============
+
+TODO
diff --git a/tutorials/index.rst b/tutorials/index.rst
@@ -15,6 +15,7 @@ Nav2 Tutorials
    docs/using_groot.rst
    docs/integrating_vio.rst
    docs/navigation2_dynamic_point_following.rst
+   docs/navigation2_route_tool.rst
    docs/navigation2_with_keepout_filter.rst
    docs/navigation2_with_speed_filter.rst
    docs/using_docking.rst
