Merge pull request mavlink#4 from hamishwillee/restructure_for_multil…

…ingual_support Restructure for multilingual support
Skydio · May 2, 2017 · a4da6be · a4da6be
2 parents 8dd5495 + 4fc6979
commit a4da6be
Show file tree

Hide file tree

Showing 15 changed files with 32 additions and 15 deletions.
diff --git a/LANGS.md b/LANGS.md
@@ -0,0 +1,4 @@
+* [English](en/)
+<!-- * [Chinese (中文)](zh/) -->
+<!-- * [Español](es/) -->
+
diff --git a/README.md b/README.md
@@ -9,3 +9,4 @@ Because MAVLink doesn't require any additional framing it is very well suited fo
 MAVLink was first released early 2009 by Lorenz Meier and has now a [significant number of contributors](https://github.com/mavlink/mavlink/graphs/contributors).
 
 The content of this book is CC-BY 4.0 licensed.
+
diff --git a/SUMMARY.md b/SUMMARY.md
diff --git a/book.json b/book.json
@@ -7,7 +7,8 @@
         "page-toc-button",
         "mermaid",
         "-mermaid-2",
-        "toolbar@git+https://github.com/hamishwillee/gitbook-plugin-toolbar.git"
+        "toolbar@git+https://github.com/hamishwillee/gitbook-plugin-toolbar.git",
+        "language-picker"
     ],
     "pluginsConfig": {
         "theme-api": {
@@ -46,19 +47,19 @@
                     "label": "Bug tracker",
                     "icon": "fa fa-bug",
                     "position" : "left",
-                    "url": "https://github.com/mavlink/devguide/issues/new?title=Doc+Bug:+{{title}}&body=DESCRIBE+PROBLEM+WITH+DOCS+HERE%0A%0ABug+Page:+[{{title}}]({{url}})"
+                    "url": "https://github.com/mavlink/mavlink-devguide/issues/new?title=Doc+Bug:+{{title}}&body=DESCRIBE+PROBLEM+WITH+DOCS+HERE%0A%0ABug+Page:+[{{title}}]({{url}})"
 
                 },
                 {
                     "label": "GitHub",
                     "icon": "fa fa-github",
-                    "url": "https://github.com/mavlink/devguide"
+                    "url": "https://github.com/mavlink/mavlink-devguide"
                 },
                 {
                     "label": "Edit page on github",
                     "icon": "fa fa-pencil-square-o",
                     "position" : "left",
-                    "url": "https://github.com/mavlink/devguide/edit/master/{{filepath_lang}}"
+                    "url": "https://github.com/mavlink/mavlink-devguide/edit/master/{{filepath_lang}}"
                 }
             ]
         }

diff --git a/en/README.md b/en/README.md
@@ -0,0 +1,11 @@
+# MAVLink Developer Guide
+
+MAVLink is a very lightweight, header-only message marshalling library for micro air vehicles / drones.
+
+MAVLink follows a modern hybrid publish-subscribe and point-to-point design pattern: Data streams are sent / published as **topics** while configuration sub-protocols such as the [mission protocol](/mission-protocol.md) or [parameter protocol](/parameter-protocol.md) are point-to-point with retransmission.
+
+Because MAVLink doesn't require any additional framing it is very well suited for applications with very limited communication bandwidth. It's reference implementation in C/C++ is highly optimized for resource-constrained systems with limited RAM and flash memory. It is field-proven and deployed in many products where it serves as interoperability interface between components of different manufacturers.
+
+MAVLink was first released early 2009 by Lorenz Meier and has now a [significant number of contributors](https://github.com/mavlink/mavlink/graphs/contributors).
+
+The content of this book is CC-BY 4.0 licensed.
diff --git a/en/SUMMARY.md b/en/SUMMARY.md
@@ -0,0 +1,11 @@
+# Summary
+
+* [Introduction](README.md)
+* [Protocol Overview](protocol.md)
+* [Serialization](serialization.md)
+* [Routing](routing.md)
+* [General Telemetry](general_telemetry.md)
+* [Mission Protocol](mission_protocol.md)
+* [Parameter Protocol](parameter_protocol.md)
+* [Camera Protocol](camera_protocol.md)
+* [Gimbal Protocol](gimbal_protocol.md)
diff --git a/camera-protocol.md → en/camera_protocol.md b/camera-protocol.md → en/camera_protocol.md
diff --git a/general-telemetry.md → en/general_telemetry.md b/general-telemetry.md → en/general_telemetry.md
diff --git a/gimbal-protocol.md → en/gimbal_protocol.md b/gimbal-protocol.md → en/gimbal_protocol.md
diff --git a/mission-protocol.md → en/mission_protocol.md b/mission-protocol.md → en/mission_protocol.md
diff --git a/offboard-control.md → en/offboard_control.md b/offboard-control.md → en/offboard_control.md
diff --git a/parameter-protocol.md → en/parameter_protocol.md b/parameter-protocol.md → en/parameter_protocol.md
diff --git a/protocol.md → en/protocol.md b/protocol.md → en/protocol.md
diff --git a/routing.md → en/routing.md b/routing.md → en/routing.md
diff --git a/serialization.md → en/serialization.md b/serialization.md → en/serialization.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,3 +9,4 @@ Because MAVLink doesn't require any additional framing it is very well suited fo
		MAVLink was first released early 2009 by Lorenz Meier and has now a [significant number of contributors](https://github.com/mavlink/mavlink/graphs/contributors).

		The content of this book is CC-BY 4.0 licensed.