Merge pull request #125 from hmakelin/cleanup

Update documentation
hmakelin · May 13, 2024 · 28b9c76 · 28b9c76
2 parents aa43ec3 + 93239a4
commit 28b9c76
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 14 deletions.
diff --git a/.github/workflows/push_gisnav_images.yml b/.github/workflows/push_gisnav_images.yml
@@ -1,8 +1,8 @@
 name: Push latest GISNav multi-arch Docker images to GHCR
 
 on:
-  push:
-    branches: [ "master" ]
+  #push:
+  #  branches: [ "master" ]
   pull_request:
     branches: [ "master" ]
 

diff --git a/docs/vitepress/docs/generate-documentation.md b/docs/vitepress/docs/generate-documentation.md
@@ -25,7 +25,7 @@ cd ~/colcon_ws/src/gisnav
 make docs
 ```
 
-```bash [Docker (Todo: not implemented)]
+```bash [Docker]
 cd ~/colcon_ws/src/gisnav/docker
 docker compose -p gisnav run gisnav make docs
 ```
@@ -35,7 +35,7 @@ docker compose -p gisnav run gisnav make docs
 The static HTML documentation will appear in the below folder:
 
 ```text
-~/colcon_ws/src/gisnav/docs/vitepress/docs/dist
+~/colcon_ws/src/gisnav/docs/vitepress/docs/.vitepress/dist
 ```
 
 ## Serve VitePress documentation

diff --git a/docs/vitepress/docs/glossary.md b/docs/vitepress/docs/glossary.md
@@ -167,7 +167,7 @@ A software application that facilitates communication between other software app
 
 ### Model
 - A machine learning model or neural [network](#network). In GISNav used specifically for [camera](#camera) [pose](#pose) estimation.
-- A [Gazebo][#gazebo] model, more specifically a [vehicle](#vehicle) model
+- A [Gazebo](#gazebo) model, more specifically a [vehicle](#vehicle) model
 
 ### Module
 A [Python](#python) module.

diff --git a/docs/vitepress/docs/setup-gis-server.md b/docs/vitepress/docs/setup-gis-server.md
@@ -91,9 +91,7 @@ firefox "http://localhost:80/?map=/etc/mapserver/wms.map&service=WMS&request=Get
 If you want to run your own GIS server or WMS proxy, you may want to consider these FOSS options:
 
 - MapServer
-- [GeoServer](https://geoserver.org) (full-fledged OGC-compliant GIS server
-
-)
+- [GeoServer](https://geoserver.org) (full-fledged OGC-compliant GIS server)
 - [Mapnik](https://mapnik.org) and [MapProxy](https://mapproxy.org)
 
 ## Orthoimagery and DEMs

diff --git a/docs/vitepress/docs/shared/clone-to-colcon-workspace.md b/docs/vitepress/docs/shared/clone-to-colcon-workspace.md
@@ -4,4 +4,5 @@ Clone latest version of GISNav and dependencies to colcon workspace:
 cd ~/colcon_ws/src
 git clone --branch v0.67.0 https://github.com/hmakelin/gisnav.git
 git clone --branch gimbal-protocol-v2-plugin https://github.com/adinkra-labs/mavros_feature_gimbal-protocol-v2-plugin.git mavros
+git clone --branch release/1.14 https://github.com/px4/px4_msgs.git
 ```
diff --git a/docs/vitepress/docs/system-architecture.md b/docs/vitepress/docs/system-architecture.md
@@ -1,18 +1,14 @@
 # System architecture
 
-The GISNav ROS 2 package receives upstream inputs from the autopilot via MAVLink and transforms them in multiple sequential steps to downstream outputs, the most important of which are the NMEA mock GPS messages. In GISNav this data processing algorithm is expressed as a distributed unidirectional network of ROS nodes.
+The GISNav ROS 2 package receives upstream inputs from the autopilot via MAVLink and transforms them in multiple sequential steps to downstream outputs, the most important of which are the mock GPS messages. In GISNav this data processing algorithm is expressed as a distributed unidirectional network of ROS nodes.
 
 The GISNav ROS application also has many external interfaces and effective development requires a simulation environment. GISNav defines and [deploys that simulation environment with Docker Compose](/deploy-with-docker-compose).
 
 This page provides an overview of both the topography of the GISNav ROS 2 package itself as well as how these different Docker Compose services that consitute the simulation environment relate to each other.
 
 ## ROS topography
 
-The core ROS topography diagram below depicts how ROS messages flow through GISNav. The API reference(under construction) has more detailed information on the purpose and design of each ROS node.
-
-::: info `MonocularStereoImage` currently disabled
-This diagram depicts partially implemented but disabled visual odometry (VO) functionality (`MonocularStereoImage`).
-:::
+The core ROS topography diagram below depicts how ROS messages flow through GISNav. The [API reference](/reference/) has more detailed information on the purpose and design of each ROS node.
 
 ::: info Todo
 - From BBoxNode, publish map to `base_link` and `base_link` to `camera` transformations separately to simplify implementation and reduce amount of maintained code.