Contributing to Documentation

Making quick fixes to existing text or raising issues is very easy. If you want to help, get in touch.

TIP

You will need a Github login to make and submit changes to this guide.

Overview

This guide is written in markdown and stored in the Github mavlink/MAVSDK repository under the docs/ folder.

The API Reference section is compiled from source code into markdown using a separate toolchain and then checked in. Updates to the reference should be made in the source code (see API Reference below for more information).

The guide is licensed under CC BY 4.0 - if you make any changes then they will be made available under the same license.

Making a Quick Fix

Simple fixes to an existing page can be made directly on Github:

1. Navigate to the relevant file in the docs/en/ folder.
2. Click the pencil (edit) icon to open the file editor.
3. Make the required changes.
4. At the bottom of the page, enter a commit message and select Create a new branch to open a pull request.

Raising an Issue

To raise an issue against the documentation, open a Github issue and include the page URL and a description of the problem.

Building the Docs Locally

The docs use VitePress. To build and preview locally:

cd docs
npm install
npm run dev

This starts a local dev server at http://localhost:5173.

API Reference

The C++ public header files are annotated using docstrings using Doxygen syntax. You can extract the documentation to markdown files (one per class) on macOS or Linux using the instructions in Build API Reference Documentation.

In order to include new API reference in the documentation:

• Copy the generated files into the docs/en/cpp/api_reference folder
• New APIs should be added to the appropriate sections in docs/en/SUMMARY.md and docs/en/cpp/api_reference/index.md.