From 29d783f588312da10b5756c7e6d5a8b1e09b1fbd Mon Sep 17 00:00:00 2001 From: Andrew Jong Date: Fri, 19 Jul 2024 15:16:54 -0400 Subject: [PATCH] Add info about docs --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 7414f2b2..0c65847d 100644 --- a/README.md +++ b/README.md @@ -87,3 +87,8 @@ ros2 service call /controls/mavros/cmd/takeoff mavros_msgs/srv/CommandTOL "{alti # FLY TO POSITION. Put whatever position you want ros2 topic pub /controls/mavros/setpoint_position/local geometry_msgs/PoseStamped "{ header: { stamp: { sec: 0, nanosec: 0 }, frame_id: 'base_link' }, pose: { position: { x: 10.0, y: 0.0, z: 20.0 }, orientation: { x: 0.0, y: 0.0, z: 0.0, w: 1.0 } } }" -1 ``` + +# Edit Docs +`mkdocs serve` is automatically run in a Docker container when you run `docker compose up -d`. +You can edit the markdown files in the `docs` folder and see the changes in real time by visiting `http://localhost:8000`. +Navigation tree is editable in `mkdocs.yml`. \ No newline at end of file