Skip to content

Commit d537119

Browse files
authored
fix: update robotics documentation for clarity and correct terminology (#1166)
1 parent 395fca5 commit d537119

File tree

4 files changed

+15
-4
lines changed

4 files changed

+15
-4
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,10 @@ See this documentation
8989

9090
- [Getting Started — PythonRobotics documentation](https://atsushisakai.github.io/PythonRobotics/getting_started.html#what-is-pythonrobotics)
9191

92+
or this Youtube video:
93+
94+
- [PythonRobotics project audio overview](https://www.youtube.com/watch?v=uMeRnNoJAfU)
95+
9296
or this paper for more details:
9397

9498
- [\[1808\.10703\] PythonRobotics: a Python code collection of robotics algorithms](https://arxiv.org/abs/1808.10703) ([BibTeX](https://github.com/AtsushiSakai/PythonRoboticsPaper/blob/master/python_robotics.bib))

docs/modules/0_getting_started/1_what_is_python_robotics_main.rst

+6
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,12 @@ the following additional libraries are required.
110110
For instructions on installing the above libraries, please refer to
111111
this section ":ref:`How to run sample codes`".
112112

113+
Audio overview of this project
114+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
115+
For an audio overview of this project, please refer to this `YouTube video`_.
116+
117+
.. _`YouTube video`: https://www.youtube.com/watch?v=uMeRnNoJAfU
118+
113119
Arxiv paper
114120
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
115121

docs/modules/1_introduction/1_definition_of_robotics/definition_of_robotics_main.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,5 +103,5 @@ Robotics consists of several essential components:
103103
#. Power Supply – Provides energy to run the robot (e.g., Batteries, Solar power).
104104
#. Software & Algorithms – Allow the robot to function and make intelligent decisions (e.g., ROS, Machine learning models, Localization, Mapping, Path planning, Control).
105105

106-
This project, PythonRobotics, focuses on the software and algorithms part of robotics.
106+
This project, `PythonRobotics`, focuses on the software and algorithms part of robotics.
107107
If you are interested in `Sensors` hardware, you can check :ref:`Internal Sensors for Robotics`_ or :ref:`External Sensors for Robotics`_.

docs/modules/5_path_planning/elastic_bands/elastic_bands_main.rst

+4-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Core Concept
1616
* Maintain global path connectivity.
1717

1818
Bubble Representation
19-
~~~~~~~~~~~~~~~~~~~
19+
~~~~~~~~~~~~~~~~~~~~~~~~
2020
- **Definition**: A local free-space region around configuration :math:`b`:
2121

2222
.. math::
@@ -56,7 +56,7 @@ External Repulsion Force
5656
\frac{\partial \rho}{\partial x} \approx \frac{\rho(b_i + h) - \rho(b_i - h)}{2h}.
5757
5858
Dynamic Path Maintenance
59-
~~~~~~~~~~~~~~~~~~~~~~~
59+
~~~~~~~~~~~~~~~~~~~~~~~~~~
6060
1. **Node Update**:
6161

6262
.. math::
@@ -68,6 +68,7 @@ Dynamic Path Maintenance
6868
- Insert new nodes if adjacent nodes are too far apart
6969
- Remove redundant nodes if adjacent nodes are too close
7070

71-
Ref:
71+
References
72+
~~~~~~~~~~~~~~~~~~~~~~~
7273

7374
- `Elastic Bands: Connecting Path Planning and Control <http://www8.cs.umu.se/research/ifor/dl/Control/elastic%20bands.pdf>`__

0 commit comments

Comments
 (0)