From 00d2490f421bafd106d82a0896c58a35232c316d Mon Sep 17 00:00:00 2001 From: Hamish Willee Date: Wed, 11 Dec 2024 10:30:15 +1100 Subject: [PATCH] Sidebar and tidy fixes (#583) * Fix up sidebar to include dialects and clear separation of important thingies * Various typos --- en/SUMMARY.md | 36 +++++++++++++---------- en/mavgen_c/index.md | 6 ++-- en/mavgen_python/examples.md | 2 +- en/mavgen_python/howto_requestmessages.md | 2 +- en/mavgen_python/message_signing.md | 8 ++--- en/services/mission.md | 4 +-- 6 files changed, 33 insertions(+), 25 deletions(-) diff --git a/en/SUMMARY.md b/en/SUMMARY.md index 5d5cf84c0..b95cd211e 100644 --- a/en/SUMMARY.md +++ b/en/SUMMARY.md @@ -32,21 +32,11 @@ - [Defining XML Enums/Messages](guide/define_xml_element.md) - [MAVLink CRC](guide/crc.md) - [Debugging with Wireshark](guide/wireshark.md) - - [Dialects](messages/index.md) - - [ASLUAV.xml](messages/ASLUAV.md) - - [all.xml](messages/all.md) - - [ardupilotmega.xml](messages/ardupilotmega.md) - - [development.xml](messages/development.md) - - [icarous.xml](messages/icarous.md) - - [matrixpilot.xml](messages/matrixpilot.md) - - [minimal.xml](messages/minimal.md) - - [paparazzi.xml](messages/paparazzi.md) - - [python_array_test.xml](messages/python_array_test.md) - - [standard.xml](messages/standard.md) - - [test.xml](messages/test.md) - - [uAvionix.xml](messages/uAvionix.md) - - [ualberta.xml](messages/ualberta.md) -- [Messages (common)](messages/common.md) +- [Standard Messages/Commands](messages/index.md) + - [✔ common.xml](messages/common.md) + - [standard.xml](messages/standard.md) + - [minimal.xml](messages/minimal.md) + - [development.xml](messages/development.md) - [Microservices](services/index.md) - [Heartbeat/Connection Protocol](services/heartbeat.md) - [Mission Protocol](services/mission.md) @@ -79,5 +69,21 @@ - [Events Interface (WIP)](services/events.md) - [Standard Flight Modes (WIP)](services/standard_modes.md) - [Time Synchronization](services/timesync.md) +- [Dialects & Tests](messages/dialects.md) + - [ardupilotmega.xml](messages/ardupilotmega.md) + - [ASLUAV.xml](messages/ASLUAV.md) + - [AVSSUAS.xml](messages/AVSSUAS.md) + - [csAirLink.xml](messages/csAirLink.md) + - [cubepilot.xml](messages/cubepilot.md) + - [icarous.xml](messages/icarous.md) + - [loweheiser.xml](messages/loweheiser.md) + - [matrixpilot.xml](messages/matrixpilot.md) + - [paparazzi.xml](messages/paparazzi.md) + - [storm32.xml](messages/storm32.md) + - [uAvionix.xml](messages/uAvionix.md) + - [ualberta.xml](messages/ualberta.md) + - [all.xml](messages/all.md) + - [python_array_test.xml](messages/python_array_test.md) + - [test.xml](messages/test.md) - [Contributing](contributing/contributing.md) - [Support](about/support.md) diff --git a/en/mavgen_c/index.md b/en/mavgen_c/index.md index 845b5fde6..ed8ba8b52 100644 --- a/en/mavgen_c/index.md +++ b/en/mavgen_c/index.md @@ -89,8 +89,10 @@ This does not happen on most of the common architectures on which MAVLink is run You can suppress the warnings using `-Wno-address-of-packed-member`. -> **Note:** The issue causes hard faults on [Cortex-M0](https://github.com/ArduPilot/pymavlink/issues/5) and other platforms [listed here](https://github.com/ArduPilot/pymavlink/issues/836#issue-1788623502). -> Please raise issues in [ArduPilot/pymavlink](https://github.com/ArduPilot/pymavlink/) if you find other hardware that is affected. +::: info +The issue causes hard faults on [Cortex-M0](https://github.com/ArduPilot/pymavlink/issues/5) and other platforms [listed here](https://github.com/ArduPilot/pymavlink/issues/836#issue-1788623502). +Please raise issues in [ArduPilot/pymavlink](https://github.com/ArduPilot/pymavlink/) if you find other hardware that is affected. +::: ## Upgrading Library from MAVLink 1 diff --git a/en/mavgen_python/examples.md b/en/mavgen_python/examples.md index 6630b2753..d8f7bf07f 100644 --- a/en/mavgen_python/examples.md +++ b/en/mavgen_python/examples.md @@ -1,4 +1,4 @@ -## Examples (Pymavlink) +# Examples (Pymavlink) Other examples: diff --git a/en/mavgen_python/howto_requestmessages.md b/en/mavgen_python/howto_requestmessages.md index c2d56fb9c..e6a9c78f9 100644 --- a/en/mavgen_python/howto_requestmessages.md +++ b/en/mavgen_python/howto_requestmessages.md @@ -1,4 +1,4 @@ -#### How to Request & Stream Messages +# How to Request & Stream Messages A remote system will typically stream a _default_ set of messages to a connected GCS, camera or other system. This default set may be hard coded, and is necessarily limited to reduce traffic on the channel. diff --git a/en/mavgen_python/message_signing.md b/en/mavgen_python/message_signing.md index 22018c4f3..fb61077d2 100644 --- a/en/mavgen_python/message_signing.md +++ b/en/mavgen_python/message_signing.md @@ -1,4 +1,4 @@ -## Message Signing (Pymavlink) +# Message Signing (Pymavlink) Pymavlink supports [Message Signing](../guide/message_signing.md) (authentication) when using [MAVLink 2](../guide/mavlink_2.md). @@ -15,7 +15,7 @@ While not covered in this topic, you should also write code to: ::: -#### Signing using MAVLink Class +## Signing using MAVLink Class If you are using the `MAVLink` class directly, you can use the **`MAVLink.signing`** attribute to access a `MAVLinkSigning` object and set the required attributes. @@ -38,7 +38,7 @@ The initial timestamp should be based on current system time. For more information see [Message Signing](../guide/message_signing.md#timestamp). ::: -#### Signing using mavutil +## Signing using mavutil If you are using **mavutil** to manage the connection then you can set up/disable signing using the methods shown below: @@ -55,7 +55,7 @@ The `setup_signing()` method sets up the `MAVLink` object owned by the connectio - If `link_id` is not specified then internally the value is iterated. - If `initial_timestamp` is not set then an appropriate value for current time is populated from the underlying OS. -#### Using allow_unsigned_callback +## Using allow_unsigned_callback [Message Signing > Accepting Unsigned Packets](../guide/message_signing.md#accepting_unsigned_packets) and [Accepting Incorrectly Signed Packets](../guide/message_signing.md#accepting_incorrectly_signed_packets) specify that a message signing implementation should provide mechanisms such that library users can choose to conditionally accept unsigned or incorrectly signed packets. diff --git a/en/services/mission.md b/en/services/mission.md index cd6676dc2..b7f901537 100644 --- a/en/services/mission.md +++ b/en/services/mission.md @@ -188,8 +188,8 @@ Mission update must be robust! A new mission should be fully uploaded and accepted before the old mission is replaced/removed. ::: -::: -Mission upload/download can be bandwidth intensive and time consuming +::: tip +Mission upload/download can be bandwidth intensive and time consuming. [Check for plan changes](#detecting-missionplan-changes) before uploading (or downloading) a mission. :::