Repository navigation
docs(site): add an explainer, a message map and the roadmap - #22
Merged
Merged
Conversation
The site described the message schema but never the problem it solves. Its tagline, "coordination and situational awareness", left out arming, fire missions and remote weapon systems, which are most of the dialect. It never said the spec is a public draft, and it had no link to the mailing list, the only way to join the working group. Lead the home page with "one open interface for military payloads and platforms", with cards for safety and arming, targeting and engagement, remote weapon systems, and integrating once instead of per pair. Add a Why MAVLink-M page: the problem, a diagram of nine integrations against six implementations, why a dialect and not a fork, and why open. Open the Introduction and the README with the same explainer, and link the mailing list from the home page, the Introduction, the Contributing page and the README. No wire effect: only the documentation site and the README change. Validation: built with the docs workflow's environment, the site check reports 0 errors, the Why page is in the sitemap, and both diagrams draw in the browser, with 9 and 6 links. Assisted-by: Claude-Code:claude-opus-5-5 Signed-off-by: Ramon Roche <mrpollo@gmail.com>
A first-time reader had no way to see what the dialect covers short of reading the generated reference message by message, or to learn how far along the spec is and when it freezes. Add a Message Map that groups every message and command into safety and arming, targeting and engagement, remote weapon systems, and tracks and awareness, each with its ID, one line on what it carries, and a link to its definition. Add a Status and Roadmap page: what the public draft means for implementers, the phases up to the November 2026 freeze and the validation baseline after it, and how the work started. Link both from the home page, the Introduction, the Why page and the README. No wire effect: only the documentation site and the README change. Validation: built with the docs workflow's environment, the site check reports 0 errors and both pages are in the sitemap. The map names each of the 26 messages and 4 commands in military.xml once, with the ID the XML gives it, and every link from the map and the home page cards lands on an anchor. Assisted-by: Claude-Code:claude-opus-5-5 Signed-off-by: Ramon Roche <mrpollo@gmail.com>
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
1 participant
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.
A first-time visitor to mavlink-m.dronecode.org can now learn in a minute what MAVLink-M is, why it matters, what it covers and how far along it is. The site explained the message schema but never the problem it solves, its tagline left out arming, fire missions and remote weapon systems, and nothing said the spec is a public draft or pointed to the mailing list.
The home page now leads with "One open interface for military payloads and platforms". A new Why MAVLink-M page covers the problem: three platforms and three payloads take nine custom integrations today, or six implementations of one shared interface. It also explains why this is a dialect and not a fork, and why it is open. A Message Map groups all 26 messages and 4 commands into four areas, one line each, and a Status and Roadmap page says what the draft means for implementers and lays out the road to the November 2026 freeze. The Introduction, the README and the Contributing page now link the mailing list.
The Scope page and the README still describe the dialect as intent and observation only, while the map lists the ESAD arming and fire mission messages. That wording is left for its own change.
Wire impact: none, only the documentation site and the README change.
Built with the docs workflow's environment: the site check reports 0 errors, the three new pages are in the sitemap, the map names each message and command in military.xml once with its ID and every link lands on its anchor, and both diagrams render.
Assisted-by: Claude-Code:claude-opus-5-5