Skip to content

Commit 7c5fd6e

Browse files
committed
docs: fix placeholder links and docs workflow deprecations
1 parent 924a6c6 commit 7c5fd6e

File tree

9 files changed

+11
-11
lines changed

9 files changed

+11
-11
lines changed

.github/workflows/docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
steps:
2323
- uses: actions/checkout@v4
2424
- name: Use Node.js
25-
uses: actions/setup-node@v1
25+
uses: actions/setup-node@v4
2626
with: { node-version: '10' }
2727
- name: Setup tools
2828
run: |
@@ -57,7 +57,7 @@ jobs:
5757
rm _book/clover_ru.pdf && mv _book/clover_ru_compressed.pdf _book/clover_ru.pdf
5858
rm _book/clover_en.pdf && mv _book/clover_en_compressed.pdf _book/clover_en.pdf
5959
ls -lah _book/clover*.pdf
60-
echo '::set-output name=GITBOOK_PDF_OK::1'
60+
echo 'GITBOOK_PDF_OK=1' >> "$GITHUB_OUTPUT"
6161
- name: Download older PDFs
6262
if: ${{ !steps.generate-pdf.outputs.GITBOOK_PDF_OK }}
6363
run: |

docs/en/network.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ network={
166166
}
167167
```
168168

169-
Inside the config file, general `wpa_supplicant` settings, and the settings for the adapter configuration are specified. The configuration file also contains `network` section with the basic settings of the Wi-Fi network, such as network SSID, password, adapter operating mode. There may be several `network` sections, but only the first valid one is used. For example, if the first section contains a connection to an unavailable network, the adapter will be configured according to a next valid section, if there is one. Read more about the syntax of `wpa_supplicant.conf` [TODO WIKI].
169+
Inside the config file, general `wpa_supplicant` settings, and the settings for the adapter configuration are specified. The configuration file also contains `network` section with the basic settings of the Wi-Fi network, such as network SSID, password, adapter operating mode. There may be several `network` sections, but only the first valid one is used. For example, if the first section contains a connection to an unavailable network, the adapter will be configured according to a next valid section, if there is one. Read more about the syntax of `wpa_supplicant.conf` in the [Debian manual page](https://manpages.debian.org/buster/wpasupplicant/wpa_supplicant.conf.5.en.html).
170170

171171
#### wpa_passphrase
172172

docs/en/optical_flow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,11 @@ Flying forward for 1m:
6666
navigate(x=1.5, frame_id='body')
6767
```
6868

69-
[Navigation using ArUco-markers](aruco_marker.md) and [using VPE] are available when using Optical Flow.
69+
[Navigation using ArUco-markers](aruco_marker.md) and [using VPE](aruco_map.md) are available when using Optical Flow.
7070

7171
## Additional settings
7272

73-
<!-- TODO: статья по пидам -->
73+
For additional background on PID tuning, see the [PID tuning guide](calibratePID.md).
7474

7575
If the copter has an unstable position, try to increase the *P* coefficient of speed PID controller - parameters are `MPC_XY_VEL_P` and `MPC_Z_VEL_P`.
7676

docs/en/rc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,6 @@ The sticks on the screen of the application work just like real sticks. To arm t
5151
Malfunctions
5252
---
5353

54-
* If the interface of the transmitter displays a surely incorrect voltage (e.g., > 5 V), check that the value of PX4 parameter `BAT_N_CELLS` matches the actual number of battery cells. If the displayed voltage is still incorrect, calibrate the battery (TODO: link).
54+
* If the interface of the transmitter displays a surely incorrect voltage (e.g., > 5 V), check that the value of PX4 parameter `BAT_N_CELLS` matches the actual number of battery cells. If the displayed voltage is still incorrect, calibrate the [power sensor](power.md).
5555

5656
* If instead of mode PX4, text "DISCONNECTED FROM FCU" is displayed, check [Raspberry Pi connection to Pixhawk](connection.md).

docs/en/setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Press the *Save* button to save the changed value to the flight controller. Chan
118118
* `MC_ROLLRATE_I` = 0.050
119119
* `MC_ROLLRATE_D` = 0.0025
120120

121-
> **Hint** Note that you should fine-tune the PID parameters for each drone individually. <!-- TODO: add PID article link -->
121+
> **Hint** Note that you should fine-tune the PID parameters for each drone individually. See the [PID tuning guide](calibratePID.md).
122122
123123
#### Circuit breaker parameters
124124

docs/ru/aruco_map.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ navigate(frame_id='aruco_5', x=0, y=0, z=1)
146146

147147
## Дополнительные настройки
148148

149-
<!-- TODO: статья по пидам -->
149+
Дополнительную информацию по настройке PID см. в статье [Настройка коэффициентов PID](calibratePID.md).
150150

151151
Если коптер нестабильно удерживает позицию по VPE, попробуйте увеличить коэффициенты *P* PID-регулятора по скорости – параметры `MPC_XY_VEL_P` и `MPC_Z_VEL_P`.
152152

docs/ru/network.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ network={
166166
}
167167
```
168168

169-
Внутри конфига указываются общие настройки `wpa_supplicant` и параметры для настройки адаптера. Также конфигурационный файл содержит секции `network` – основные настройки Wi-Fi сети такие как SSID сети, пароль, режим работы адаптера. Таких блоков может быть несколько, но используется первый рабочий. Например, если вы указали в первом блоке подключение к некоторой недоступной сети, то адаптер будет настроен следующей удачной секцией, если такая есть. Подробнее о синтаксисе `wpa_supplicant.conf` [TODO WIKI].
169+
Внутри конфига указываются общие настройки `wpa_supplicant` и параметры для настройки адаптера. Также конфигурационный файл содержит секции `network` – основные настройки Wi-Fi сети такие как SSID сети, пароль, режим работы адаптера. Таких блоков может быть несколько, но используется первый рабочий. Например, если вы указали в первом блоке подключение к некоторой недоступной сети, то адаптер будет настроен следующей удачной секцией, если такая есть. Подробнее о синтаксисе `wpa_supplicant.conf` см. в [man-странице Debian](https://manpages.debian.org/buster/wpasupplicant/wpa_supplicant.conf.5.en.html).
170170

171171
#### wpa_passphrase
172172

docs/ru/optical_flow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ navigate(x=-1, frame_id='navigate_target')
7676

7777
## Дополнительные настройки
7878

79-
<!-- TODO: статья по пидам -->
79+
Дополнительную информацию по настройке PID см. в статье [Настройка коэффициентов PID](calibratePID.md).
8080

8181
Если коптер нестабильно удерживает позицию, попробуйте увеличить коэффициенты *P* PID-регулятора по скорости – параметры `MPC_XY_VEL_P` и `MPC_Z_VEL_P`.
8282

docs/ru/rc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,6 @@ sudo systemctl restart clover
5151
Неисправности
5252
---
5353

54-
* Если интерфейс пульта отображает явно неправильное напряжение (напр. > 5 V), проверьте, что значение PX4-параметра `BAT_N_CELLS` соответствует реальному количество элементов батареи. Если отображаемое напряжение все равно неверно, откалибруйте батарею (TODO: ссылка).
54+
* Если интерфейс пульта отображает явно неправильное напряжение (напр. > 5 V), проверьте, что значение PX4-параметра `BAT_N_CELLS` соответствует реальному количеству элементов батареи. Если отображаемое напряжение все равно неверно, откалибруйте [датчик питания](power.md).
5555

5656
* Если вместо режима PX4 отображается текст "DISCONNECTED FROM FCU", проверьте [подключение Raspberry Pi к Pixhawk](connection.md).

0 commit comments

Comments
 (0)