docs: more proper-names checks!

CopterExpress · Feb 14, 2019 · 67e2185 · 67e2185
1 parent 82f9b9d
commit 67e2185
Show file tree

Hide file tree

Showing 18 changed files with 81 additions and 37 deletions.
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -15,15 +15,59 @@
         "names": [
             "MAVLink",
             "ROS",
+            "ROS Kinetic",
+            "OpenCV",
+            "GitHub",
+            "FPV",
+            "PPM",
+            "PWM",
             "Python",
             "C++",
             "PX4",
+            "QGroundControl",
+            "QGC",
             "WireShark",
+            "FlightPlot",
+            "OFFBOARD",
+            "LPE",
+            "EKF2",
+            "SITL",
+            "PID",
             "Wi-Fi",
             "Raspberry Pi",
+            "RPi",
+            "Linux",
+            "Windows",
+            "macOS",
+            "iOS",
+            "Android",
+            "Bluetooth",
+            "Raspbian",
+            "Raspbian Jesse",
+            "Raspbian Stretch",
             "Pixhawk",
             "Pixracer",
-            "ArUco"
+            "Arduino",
+            "GPS",
+            "ArUco",
+            "LIRC",
+            "GPIO",
+            "HC-SR04",
+            "STM",
+            "LED",
+            "USB",
+            "FAT32",
+            "uORB",
+            "SSH",
+            "API",
+            "UART",
+            "GND",
+            "VCC",
+            "SCL",
+            "SDA",
+            "TCP",
+            "UDP",
+            "QR"
         ],
         "code_blocks": false
     },

diff --git a/docs/en/SUMMARY.md b/docs/en/SUMMARY.md
@@ -29,7 +29,7 @@
 * [Coordinate systems (frames)](frames.md)
 * [ROS](ros.md)
 * [MAVROS](mavros.md)
-* [Simple offboard](simple_offboard.md)
+* [Simple OFFBOARD](simple_offboard.md)
 * [Navigation using ArUco markers](aruco.md)
 * [Automatic check](selfcheck.md)
 * [Code examples](snippets.md)

diff --git a/docs/en/assemble_3.md b/docs/en/assemble_3.md
@@ -134,7 +134,7 @@ article [remote faults](radioerrors.md).
 
 1. Turn the transmitter ON
 
-    Make sure ppm in the RX Setup menu is disabled ([section "No communications with the flight controller"](radioerrors.md))
+    Make sure PPM in the RX Setup menu is disabled ([section "No communications with the flight controller"](radioerrors.md))
 
     In point 3, select “RX setup” > “PPM OUTPUT” > “Off”.
 
@@ -232,4 +232,4 @@ article [remote faults](radioerrors.md).
 
 ![Installation of USB connectors](../assets/cl3_mountUSBconnectors.JPG).
 
-Read more about connection in [article](connection.md).
+Read more about connection in [article](connection.md).
diff --git a/docs/en/connection.md b/docs/en/connection.md
@@ -1,9 +1,9 @@
 Connecting Pixhawk/Pixracer to Raspberry Pi
 ===
 
-To program [autonomous flights] (simple_offboard.md) [work with Pixhawk (Pixracer) over Wi-Fi] (gcs_bridge.md), use [of a phone transmitter] (rc.md), and other functions, it is necessary to connect Raspberry Pi to Pixhawk (Pixracer).
+To program [autonomous flights](simple_offboard.md) [work with Pixhawk (Pixracer) over Wi-Fi](gcs_bridge.md), use [of a phone transmitter] (rc.md), and other functions, it is necessary to connect Raspberry Pi to Pixhawk (Pixracer).
 
-Check operability of the connection [by running on Raspberry Pi] (ssh.md):
+Check operability of the connection [by running on Raspberry Pi](ssh.md):
 
 ```bash
 rostopic echo /mavros/state
@@ -57,4 +57,4 @@ To connect locally/remotely to a running [SITL](sitl.md), set argument `fcu_conn
 ```xml
 <arg name="fcu_conn" default="udp"/>
 <arg name="fcu_ip" default="127.0.0.1"/>
-```
+```
diff --git a/docs/en/gps.md b/docs/en/gps.md
@@ -5,7 +5,7 @@ Upon connecting GPS, the following possibilities appear:
 
 * The copter can remain at the same point when flying outside
 * Autonomous missions may be programmed in the QGroundControl application
-* Flying may be performed by global points in standalone mode using the [simple offboard] module (simple_offboard.md).
+* Flying may be performed by global points in standalone mode using the [simple_offboard](simple_offboard.md) module.
 
 Useful links:
 
@@ -20,4 +20,4 @@ The GPS module is connected to "GPS" and "I2C" (compass) connectors of the fligh
 
 If GPS is connected, magnetometers are to be re-calibrated in the QGroundControl application via a [Wi-Fi](Wi-Fi.md) or USB connection.
 
-Next, GPS is to be enabled in parameter `EKF2_AID_MASK` (when EKF2is used) or `LPE_FUSION` (when LPE is used).
+Next, GPS is to be enabled in parameter `EKF2_AID_MASK` (when EKF2is used) or `LPE_FUSION` (when LPE is used).
diff --git a/docs/en/leds.md b/docs/en/leds.md
@@ -213,7 +213,7 @@ The result of the command:
 
 ## Why exactly so, and is there a different way?
 
-The main types of strips used for Clever 3 are WS2812, WS2812B and SK6812 \(analog to WS2812B\). They are controlled according to the same principle: for a massif of LEDs in the strip, a data packet at the rate of 24 bits per LED; each led reads the first 24 bits of received data, and sets the corresponding color, the rest of the data are sent to the next LED in the strip. Zeros and ones are determined by different combinations of the durations of high and low level in the pulse.
+The main types of strips used for Clever 3 are WS2812, WS2812B and SK6812 \(analog to WS2812B\). They are controlled according to the same principle: for a massif of LEDs in the strip, a data packet at the rate of 24 bits per LED; each LED reads the first 24 bits of received data, and sets the corresponding color, the rest of the data are sent to the next LED in the strip. Zeros and ones are determined by different combinations of the durations of high and low level in the pulse.
 
 All these strips are supported for library management [rpi_ws281x](https://github.com/jgarff/rpi_ws281x), with that, the DMA module\(direct memory access \) of the Raspberri processor, and one of the data channels re used for control: PWM, PCM, or SPI, which guarantees absence of delays in control \(and everything is controlled from a multitasking OS, it's important\).
 

diff --git a/docs/en/network.md b/docs/en/network.md
@@ -148,7 +148,7 @@ Below you can read more about how RPi networking is organized.
 
 ## RPi network organization
 
-Network operation in image **2017-11-29-raspbian-stretch-lite** is supported by two pre-installed services:
+Network operation in the [image](microsd_images.md) is supported by two pre-installed services:
 
 * **networking** — the service enables all network interfaces at the moment of start [5].
 * **dhcpcd** — the service ensures configuration of addressing and routing on the interfaces obtained dynamically, or specified statically in the config file.

diff --git a/docs/en/simple_offboard.md b/docs/en/simple_offboard.md
@@ -1,4 +1,4 @@
-Simple offboard
+Simple OFFBOARD
 ===
 
 > **Note** Documentation for the [image](microsd_images.md), versions, starting with **0.15**. For older versions refer to [documentation for version **0.14**](https://github.com/CopterExpress/clever/blob/v0.14/docs/ru/simple_offboard.md).
@@ -56,8 +56,8 @@ Response format:
 * `armed` `armed` state of propellers (the propellers are armed, if true);
 * `mode` – current [flight mode](modes.md);
 * `x, y, z` — local position of the copter *(m)*;
-* `lat, lon` – latitude, longitude *(degrees)*, [GPS] is to be available (gps.md);
-* `alt` – altitude in the global system of coordinates (standard [WGS-84](https://ru.wikipedia.org/wiki/WGS_84), not <abbr title="Above Mean Sea Level">AMSL</abbr>!), [GPS] is to be available (gps.md);
+* `lat, lon` – latitude, longitude *(degrees)*, [GPS](gps.md) is to be available;
+* `alt` – altitude in the global system of coordinates (standard [WGS-84](https://ru.wikipedia.org/wiki/WGS_84), not <abbr title="Above Mean Sea Level">AMSL</abbr>!), [GPS](gps.md) is to be available ;
 * `vx, vy, vz` – copter velocity *(m/s)*;
 * `pitch` – pitch angle *(radians)*;
 * `roll` – roll angle *(radians)*;
@@ -317,4 +317,4 @@ Additional materials
 ------------------------
 
 * [Flying in the field of ArUco markers](aruco.md).
-* [Samples of programs and snippets](snippets.md).
+* [Samples of programs and snippets](snippets.md).
diff --git a/docs/ru/assemble_3.md b/docs/ru/assemble_3.md
@@ -134,7 +134,7 @@ TODO
 
 1. Включить пульт.
 
-    Убедиться, что ppm в меню RX Setup отключен ([раздел "Нет связи с полетным контроллером"](radioerrors.md))
+    Убедиться, что PPM в меню RX Setup отключен ([раздел "Нет связи с полетным контроллером"](radioerrors.md))
 
     В пункте 3 выберите “RX setup” > “PPM OUTPUT” > “Off”.
 
@@ -204,7 +204,7 @@ TODO
 
 ## Монтаж камеры RPi
 
-1. Установить маунт для камеры Rpi в сборе на нижнюю деку винтами М3х12 (2 шт.).
+1. Установить маунт для камеры RPi в сборе на нижнюю деку винтами М3х12 (2 шт.).
 2. Подключить шлейф к камере RPi.
 3. Установить камеру в маунт, закрепить саморезами М2.
 4. Закрепить Raspberry стойками 30 мм (4 шт.).

diff --git a/docs/ru/face_recognition.md b/docs/ru/face_recognition.md
@@ -89,7 +89,7 @@ arr = np.asarray(bytearray(req.read()), dtype=np.uint8)
 frame = cv2.imdecode(arr, -1)
 ```
 
-Объяснение дальнейшего кода можно найти на github’е используемого API в комментариях к [следующему скрипту](https://github.com/ageitgey/face_recognition/blob/master/examples/facerec_from_webcam_faster.py)
+Объяснение дальнейшего кода можно найти на GitHub’е используемого API в комментариях к [следующему скрипту](https://github.com/ageitgey/face_recognition/blob/master/examples/facerec_from_webcam_faster.py)
 
 ## Использование
 

diff --git a/docs/ru/gps.md b/docs/ru/gps.md
@@ -3,9 +3,9 @@
 
 При подключении GPS появляются следующие возможности:
 
-* Удерживание коптером позиции при полете на улице
-* Программирование автономных миссий в программе QGroundControl
-* Полеты на глобальные точки в автономном режиме при помощи модуля [simple offboard](simple_offboard.md).
+* удерживание коптером позиции при полете на улице;
+* программирование автономных миссий в программе QGroundControl;
+* полеты на глобальные точки в автономном режиме при помощи модуля [simple_offboard](simple_offboard.md).
 
 Полезные ссылки:
 
@@ -18,6 +18,6 @@
 
 GPS-модуль подключается к разъемам "GPS" и "I2C" (компас) полетного контроллера.
 
-При подключении GPS, необходимо заново откалибровать магнитометры в программе QGroundControl, подключившись по [Wi-Fi](wifi.md) или USB.
+При подключении GPS необходимо заново откалибровать магнитометры в программе QGroundControl, подключившись по [Wi-Fi](wifi.md) или USB.
 
 Далее, необходимо включить GPS в параметре `EKF2_AID_MASK` (при использовании EKF2) или `LPE_FUSION` (при использовании LPE).
diff --git a/docs/ru/leds.md b/docs/ru/leds.md
@@ -24,7 +24,7 @@
 cd ~
 ```
 
-Склонируйте репозиторий библиотеки для работы с led лентами на Raspberry Pi:
+Склонируйте репозиторий библиотеки для работы с LED-лентами на Raspberry Pi:
 
 ```bash
 git clone https://github.com/jgarff/rpi_ws281x.git

diff --git a/docs/ru/network.md b/docs/ru/network.md
@@ -147,7 +147,7 @@ ___
 
 ## Устройство сети RPi
 
-Работа сети на образе **2017-11-29-raspbian-stretch-lite** поддерживается двумя предустановленными службами:
+Работа сети на [образе](microsd_images.md) поддерживается двумя предустановленными службами:
 
 * **networking** — служба включает все сетевые интерфейсы в момент запуска [5].
 * **dhcpcd** — служба обеспечивает настройку адресации и маршрутризации на интерфейсах, полученных динамически или указаных в файле настроек статически.

diff --git a/docs/ru/optical_flow.md b/docs/ru/optical_flow.md
@@ -50,7 +50,7 @@ rostopic echo mavros/distance_sensor/rangefinder_3_sub
 
 ## Troubleshooting
 
-При появлении в QGC ошибок типа `EKF INTERNAL CHECKS` попробуйте перезагрузить ekf2. Для этого наберите в MAVLink-консоли:
+При появлении в QGC ошибок типа `EKF INTERNAL CHECKS` попробуйте перезагрузить EKF2. Для этого наберите в MAVLink-консоли:
 
 ```nsh
 ekf2 stop

diff --git a/docs/ru/setup.md b/docs/ru/setup.md
@@ -15,7 +15,7 @@
 * Форматируем карту в файловую систему FAT32
   правый клие на диске > Форматирование.
 * Выполняем "Безопасное извлечение" карты напанели инструментов, далее извлекаем карту.
-* Устанавливаем micrSD карту в полетный контроллер Pixhawk.
+* Устанавливаем microSD карту в полетный контроллер Pixhawk.
 
 ## Обновление прошивки Pixhawk
 

diff --git a/docs/ru/simple_offboard.md b/docs/ru/simple_offboard.md
@@ -1,4 +1,4 @@
-Simple offboard
+Simple OFFBOARD
 ===
 
 > **Note** Документация для версий [образа](microsd_images.md), начиная с **0.15**. Для более ранних версий см. [документацию для версии **0.14**](https://github.com/CopterExpress/clever/blob/v0.14/docs/ru/simple_offboard.md).

diff --git a/docs/ru/sitl.md b/docs/ru/sitl.md
@@ -7,7 +7,7 @@
 
 jMavSim является легковесной средой, предназначенной только для тестирование мультироторных летательных систем; Gazebo – универсальная среда для любых типов роботов.
 
-Запуск PX4 Sitl
+Запуск PX4 SITL
 --
 
 1. Склонировать репозиторий с PX4.

diff --git a/docs/ru/tests.md b/docs/ru/tests.md
@@ -953,10 +953,10 @@
 
 **1. Какой полетный режим используется для автономных полетов?**
 
-1. Stabilized
-2. Offboard
-3. Acro
-4. AltHold
+1. STABILIZED
+2. OFFBOARD
+3. ACRO
+4. ALTHOLD
 
 **2. Почему нельзя ориентироваться только на показания датчиков при автономном полете?**
 
@@ -967,7 +967,7 @@
 
 **3. Как называются метки, по которым ориентируется Clever?**
 
-1. Qr
+1. QR
 2. ArUco
 3. ID
 4. Map
@@ -1116,7 +1116,7 @@
 
 **19. Какой полетный режим используется для автономных полетов?**
 
-1. Stabilized
-2. Offboard
-3. Acro
-4. AltHold
+1. STABILIZED
+2. OFFBOARD
+3. ACTO
+4. ALTHOLD
-Original file line number
+Diff line change
@@ Expand Up / @@ -24,7 +24,7 @@ @@
     cd ~
     ```
-    Склонируйте репозиторий библиотеки для работы с led лентами на Raspberry Pi:
+    Склонируйте репозиторий библиотеки для работы с LED-лентами на Raspberry Pi:
     ```bash
     git clone https://github.com/jgarff/rpi_ws281x.git
@@ Expand Down @@