added more links to the TUI in docs

Author: 2lian

docs/build/md/markdown/api/ms_operator/ms_operator.md

@@ -204,6 +204,24 @@ currently exists.
 
 ## ms_operator.operator_tui module
 
+### *class* ms_operator.operator_tui.GorillaSplash(art, palette_cycle=('gorilla0', 'gorilla1', 'gorilla2', 'gorilla1'), amplitude=3, wavelength=8.0, speed=0.6)
+
+Bases: `object`
+
+amplitude: max spaces to shift
+wavelength: how many lines per full sine cycle
+speed: phase advance per tick (bigger = faster)
+
+* **Parameters:**
+  * **art** (*str*)
+  * **amplitude** (*int*)
+  * **wavelength** (*float*)
+  * **speed** (*float*)
+
+#### widget()
+
+#### tick()
+
 ### *class* ms_operator.operator_tui.TriStateCheckbox(label: str | tuple[Hashable, str] | list[str | tuple[Hashable, str]], state: bool = False, has_mixed: Literal[False] = False, on_state_change: Callable[[Self, bool, \_T], Any] | None = None, user_data: \_T = ..., checked_symbol: str | None = ...)
 
 ### *class* ms_operator.operator_tui.TriStateCheckbox(label: str | tuple[Hashable, str] | list[str | tuple[Hashable, str]], state: bool = False, has_mixed: Literal[False] = False, on_state_change: Callable[[Self, bool], Any] | None = None, user_data: None = None, checked_symbol: str | None = ...)

docs/build/md/markdown/manual/install.md

@@ -51,6 +51,13 @@ pixi run ros2 launch motion_stack moonbot_zero.launch.py
 pixi run ros2 launch rviz_basic rviz_simu.launch.py
 ```
 
+And have fun with the [Operator TUI](operator_tui.md#tui).
+
+```bash
+# Terminal 3
+pixi run bash operator.bash
+```
+
 <a id="install-source-label"></a>
 
 # Installation from source
@@ -148,3 +155,11 @@ ros2 launch motion_stack moonbot_zero.launch.py
 # source your workspace and venv here
 ros2 launch rviz_basic rviz_simu.launch.py
 ```
+
+And have fun with the [Operator TUI](operator_tui.md#tui).
+
+```bash
+# Terminal 3
+# source your workspace and venv here
+bash operator.bash
+```

docs/build/md/markdown/manual/operator_tui.md

@@ -1,3 +1,5 @@
+<a id="tui"></a>
+
 # Operator TUI
 
 Welcome to the **Motion-Stack Operator** — a simple, text-based terminal user interface for interactively driving your robot’s legs, joints, wheels, and inverse-kinematics via ROS 2. This guide will walk you through launching, and basic usage of the TUI (textual user interface) and the keyboard inputs.

docs/build/md/markdown/manual/start.md

@@ -66,6 +66,12 @@ ros2 launch rviz_basic rviz_simu.launch.py # (separate terminal)
 
 **You should see a robot!**
 
+After reading the documentation, you can have fun with the [Operator TUI](operator_tui.md#tui).
+
+```bash
+bash operator.bash # (separate terminal)
+```
+
 ## Parameters and Launchers
 
 A customizable launching system is provided. It can be used (and modified) by your own packages.

docs/source/manual/install.rst

@@ -64,6 +64,13 @@ You can launch the *Moonbot Zero*:
    # Terminal 2
    pixi run ros2 launch rviz_basic rviz_simu.launch.py
 
+And have fun with the :ref:`tui`.
+
+.. code-block:: bash
+    
+   # Terminal 3
+   pixi run bash operator.bash
+
 
 .. Tip::
 
@@ -183,3 +190,11 @@ You can launch the *Moonbot Zero*:
     # Terminal 2
     # source your workspace and venv here
     ros2 launch rviz_basic rviz_simu.launch.py
+
+And have fun with the :ref:`tui`.
+
+.. code-block:: bash
+    
+   # Terminal 3
+   # source your workspace and venv here
+   bash operator.bash

docs/source/manual/operator_tui.rst

@@ -1,3 +1,4 @@
+.. _tui:
 Operator TUI
 ==================
 
@@ -225,4 +226,4 @@ Buttons unresponsive
 
 Rviz_simu not showing robot
   - Ensure that Fixed Frame in Rviz_simu is set to robot base link
-  - Ensure that Description Topic in Rviz_simu is robot description topic
+  - Ensure that Description Topic in Rviz_simu is robot description topic

docs/source/manual/start.rst

@@ -86,6 +86,12 @@ If it's your first time launching, lvl1 is waiting for lvl0's data, which comes
 .. Caution::
     ``rviz_simu.launch.py`` launches rviz and a simulation node that imitates a motor's response. When using the real robot, you must not use this additional node (it will interfere with messages from the motors). You should launch rviz without simulation using ``rviz_vizu.launch.py``
 
+After reading the documentation, you can have fun with the :ref:`tui`.
+
+.. code-block:: bash
+    
+   bash operator.bash # (separate terminal)
+
 Parameters and Launchers
 -------------------------