Skip to content

Commit 28b9c76

Browse files
authored
Merge pull request #125 from hmakelin/cleanup
Update documentation
2 parents aa43ec3 + 93239a4 commit 28b9c76

File tree

6 files changed

+9
-14
lines changed

6 files changed

+9
-14
lines changed

.github/workflows/push_gisnav_images.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
name: Push latest GISNav multi-arch Docker images to GHCR
22

33
on:
4-
push:
5-
branches: [ "master" ]
4+
#push:
5+
# branches: [ "master" ]
66
pull_request:
77
branches: [ "master" ]
88

docs/vitepress/docs/generate-documentation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ cd ~/colcon_ws/src/gisnav
2525
make docs
2626
```
2727

28-
```bash [Docker (Todo: not implemented)]
28+
```bash [Docker]
2929
cd ~/colcon_ws/src/gisnav/docker
3030
docker compose -p gisnav run gisnav make docs
3131
```
@@ -35,7 +35,7 @@ docker compose -p gisnav run gisnav make docs
3535
The static HTML documentation will appear in the below folder:
3636

3737
```text
38-
~/colcon_ws/src/gisnav/docs/vitepress/docs/dist
38+
~/colcon_ws/src/gisnav/docs/vitepress/docs/.vitepress/dist
3939
```
4040

4141
## Serve VitePress documentation

docs/vitepress/docs/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ A software application that facilitates communication between other software app
167167

168168
### Model
169169
- A machine learning model or neural [network](#network). In GISNav used specifically for [camera](#camera) [pose](#pose) estimation.
170-
- A [Gazebo][#gazebo] model, more specifically a [vehicle](#vehicle) model
170+
- A [Gazebo](#gazebo) model, more specifically a [vehicle](#vehicle) model
171171

172172
### Module
173173
A [Python](#python) module.

docs/vitepress/docs/setup-gis-server.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,7 @@ firefox "http://localhost:80/?map=/etc/mapserver/wms.map&service=WMS&request=Get
9191
If you want to run your own GIS server or WMS proxy, you may want to consider these FOSS options:
9292

9393
- MapServer
94-
- [GeoServer](https://geoserver.org) (full-fledged OGC-compliant GIS server
95-
96-
)
94+
- [GeoServer](https://geoserver.org) (full-fledged OGC-compliant GIS server)
9795
- [Mapnik](https://mapnik.org) and [MapProxy](https://mapproxy.org)
9896

9997
## Orthoimagery and DEMs

docs/vitepress/docs/shared/clone-to-colcon-workspace.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ Clone latest version of GISNav and dependencies to colcon workspace:
44
cd ~/colcon_ws/src
55
git clone --branch v0.67.0 https://github.com/hmakelin/gisnav.git
66
git clone --branch gimbal-protocol-v2-plugin https://github.com/adinkra-labs/mavros_feature_gimbal-protocol-v2-plugin.git mavros
7+
git clone --branch release/1.14 https://github.com/px4/px4_msgs.git
78
```

docs/vitepress/docs/system-architecture.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
# System architecture
22

3-
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.
3+
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.
44

55
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).
66

77
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.
88

99
## ROS topography
1010

11-
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.
12-
13-
::: info `MonocularStereoImage` currently disabled
14-
This diagram depicts partially implemented but disabled visual odometry (VO) functionality (`MonocularStereoImage`).
15-
:::
11+
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.
1612

1713
::: info Todo
1814
- From BBoxNode, publish map to `base_link` and `base_link` to `camera` transformations separately to simplify implementation and reduce amount of maintained code.

0 commit comments

Comments
 (0)