updated docs

This commit is contained in:
locker98 2024-11-25 15:49:34 -05:00
parent 8c34973617
commit 77354701a1
4 changed files with 98 additions and 89 deletions

View File

@ -20,7 +20,8 @@ Once this command is running then you should be able to drive the robot like nor
### Launching the SLAM command
Here is the `slam.yaml` config file. You can change the resolution by changing the resolution parameter, by default it is 0.05 but i have had great success when running synchronous SLAM with values as low as 0.01.
```yaml
```yaml title="slam.yaml"
slam_toolbox:
ros__parameters:
@ -106,6 +107,7 @@ Once you are done creating the map make sure you save it.
#### Navigation
To launch the navigation program on the Turtlebot 4 run the following commands. One per terminal window making sure to execute them on the Remote PC.
```bash
# Terminal Window 1
ros2 launch turtlebot4_navigation localization.launch.py map:/path/to/map.yaml

View File

@ -1,70 +1,10 @@
# Homepage
# Welcome
Welcome this is the documenation for the Rhodes State ROS 2 Robotics equitment. This information is a collection of useful tips gathered from [Clearpath Robot Docs](https://docs.clearpathrobotics.com/docs/robots/), [Clearpath ROS 2](https://docs.clearpathrobotics.com/docs/ros/), and [Turtlebot 4 Manuel](https://turtlebot.github.io/turtlebot4-user-manual/). It also has informtation from the following courses; [ROS2 For Beginners](https://www.udemy.com/course/ros2-for-beginners)
## Husky 200
This section has all the importent information on the Husky 200 and how to program it and using ROS 2.
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
## Turtlebot 4
This section has information on the Turtlebot 4 and how to program it and using ROS 2.
## Code Annotation Examples
### Codeblocks
Some `code` goes here.
### Plain codeblock
A plain codeblock:
```
Some code here
def myfunction()
// some comment
```
#### Code for a specific language
Some more code with the `py` at the start:
``` py
import tensorflow as tf
def whatever()
```
#### With a title
``` py title="bubble_sort.py"
def bubble_sort(items):
for i in range(len(items)):
for j in range(len(items) - 1 - i):
if items[j] > items[j + 1]:
items[j], items[j + 1] = items[j + 1], items[j]
```
asdkfaj;sldkf
#### With line numbers
```py linenums="1"
def bubble_sort(items):
for i in range(len(items)):
for j in range(len(items) - 1 - i):
if items[j] > items[j + 1]:
items[j], items[j + 1] = items[j + 1], items[j]
```
#### Highlighting lines
```py hl_lines="2 3"
def bubble_sort(items):
for i in range(len(items)):
for j in range(len(items) - 1 - i):
if items[j] > items[j + 1]:
items[j], items[j + 1] = items[j + 1], items[j]
```
## Icons and Emojs
:smile:
:fontawesome-regular-face-laugh-wink:
:fontawesome-brands-twitter:{ .twitter }
:octicons-heart-fill-24:{ .heart }
## General ROS 2
This section covers genral topics and tools that are useful for ROS 2 development.8

View File

@ -38,11 +38,12 @@ extra:
- icon: fontawesome/brands/gitlab
link: https://gitea.locker98.com
markdown_extensions:
copyright: |
&copy; 2023 <a href="https://github.com/thelocker98" target="_blank" rel="noopener">locker98</a>
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_langclass: true
- pymdownx.inlinehilite
- pymdownx.snippets
- admonition
@ -56,6 +57,3 @@ extra:
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
copyright: |
&copy; 2023 <a href="https://github.com/thelocker98" target="_blank" rel="noopener">locker98</a>

69
sample.md Normal file
View File

@ -0,0 +1,69 @@
# Homepage
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
## Code Annotation Examples
### Codeblocks
Some `code` goes here.
### Plain codeblock
A plain codeblock:
```
Some code here
def myfunction()
// some comment
```
#### Code for a specific language
Some more code with the `py` at the start:
``` py
import tensorflow as tf
def whatever()
```
#### With a title
``` py title="bubble_sort.py"
def bubble_sort(items):
for i in range(len(items)):
for j in range(len(items) - 1 - i):
if items[j] > items[j + 1]:
items[j], items[j + 1] = items[j + 1], items[j]
```
#### With line numbers
```py linenums="1"
def bubble_sort(items):
for i in range(len(items)):
for j in range(len(items) - 1 - i):
if items[j] > items[j + 1]:
items[j], items[j + 1] = items[j + 1], items[j]
```
#### Highlighting lines
```py hl_lines="2 3"
def bubble_sort(items):
for i in range(len(items)):
for j in range(len(items) - 1 - i):
if items[j] > items[j + 1]:
items[j], items[j + 1] = items[j + 1], items[j]
```
## Icons and Emojs
:smile:
:fontawesome-regular-face-laugh-wink:
:fontawesome-brands-twitter:{ .twitter }
:octicons-heart-fill-24:{ .heart }