docs: fix issues from MAVSDK-docs tracker#2922
Merged
Merged
Conversation
Resolves mavlink/MAVSDK-docs#259. CMake accepts both `-Bbuild` and `-B build` but the latter is more readable and consistent with modern cmake style. Updated all occurrences across build guides, toolchain, examples, and contributing docs.
The "Building on macOS" nav entry was pointing to build.md which is a routing page covering all platforms, not a macOS-specific guide. Updated to link directly to build_macos.md, consistent with build_linux.md and build_windows.md entries.
Four links in dev_logging.md and transition_vtol_fixed_wing.md were incorrectly pointing to a user's fork (JoC2000/MAVSDK) instead of the official mavlink/MAVSDK repository.
- index.md: fix C++ documentation issues link to point to mavlink/MAVSDK instead of the retired mavlink/MAVSDK-docs repo - contributing/documentation.md: rewrite to reflect that docs are now in-tree in mavlink/MAVSDK under docs/ and use VitePress (not Gitbook) - guide/toolchain.md: replace deprecated cmake -H. flag with -S.
The docs are now in the mavlink/MAVSDK repo under docs/, so the release process no longer requires separate MAVSDK-docs branch management or book.json updates. Simplified the documentation release steps accordingly.
The Return to Launch code snippet was calling telemetry.return_to_launch() but return_to_launch() is a method on Action, not Telemetry.
Typo in the gRPC comparison table: 'nan-native' should be 'non-native'.
Code snippet had std::this_thread_sleep_for (missing ::) which would not compile. Fixed to std::this_thread::sleep_for.
The VitePress info block was closed with triple-quotes (""") instead
of triple-colons (:::), which would break rendering of that section.
missions.md: - mavsdk.system() -> mavsdk.systems() (wrong method, should be plural) - Remove stray closing parenthesis on longitude_deg assignment - Remove duplicate gimbal_pitch_deg line - Fix extra closing paren in subscribe_mission_progress lambda syntax connections.md: - Remove inline backtick formatting inside a fenced code block
bansiesta
force-pushed
the
fix/docs-issues-from-mavsdk-docs
branch
from
e064c09 to
62049ab
Compare
Same rationale as -B: both flags were added in CMake 3.13 and the official docs show them as -S <path> and -B <path> with a space. Applies to all build guides, examples, and contributing docs.
julianoes
previously approved these changes
Jul 13, 2026
julianoes
approved these changes
Jul 13, 2026
This was referenced Jul 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes open issues from https://github.com/mavlink/MAVSDK-docs/issues applied to the in-tree docs, plus new Camera and Gimbal guide pages.
Test plan
cd docs && npm install && npm run dev