Merge pull request #22257 from LasseRosenow/fix-doc-links

treewide: Fix links in the docs and cleanup many boards

Author: AnnsAnns

boards/adafruit-clue/doc.md

@@ -29,6 +29,7 @@ The STDIO is directly accessible via the USB port. On a Linux host, it's
 generally mapped to `/dev/ttyACM0`.
 
 Use the `term` target to connect to the board serial port<br/>
-```
-    make BOARD=adafruit-clue -C examples/basic/hello-world term
+
+```shell
+make BOARD=adafruit-clue -C examples/basic/hello-world term
 ```

boards/adafruit-feather-nrf52840-express/doc.md

@@ -19,24 +19,30 @@ Flashing the Feather nRF52840 is described in the
 common [Adafruit nRF52 Bootloader](@ref boards_common_adafruit-nrf52-bootloader) section.
 
 Example with `hello-world` application:
-```sh
+
+```shell
 make BOARD=adafruit-feather-nrf52840-express -C examples/basic/hello-world flash
 ```
 
 ### Terminal
+
 To connect a terminal to the Feather, RIOT chooses `stdio_cdc_acm` per default.
 This lets you access the Feather directly over USB.
 
 You have several alternative possibilities to connect to the board.
 
 1. With
+
    ```makefile
    USEMODULE += stdio_uart
    ```
+
    and an FTDI adapter connected to the Feather's RX and TX ports you can use
    UART-based terminals to connect to the feather
 2. With
+
    ```makefile
    USEMODULE += stdio_rtt
    ```
+
    you can use the Segger J-Link Programmer as a serial interface to the device.

boards/adafruit-feather-nrf52840-sense/doc.md

@@ -25,6 +25,7 @@ Details to the Flashing process can be found in the common
 Both use the same flasher, bootloader, and terminal settings.
 
 Example with `hello-world` application:
-```sh
+
+```shell
 make BOARD=adafruit-feather-nrf52840-sense -C examples/basic/hello-world flash term
 ```

boards/adafruit-grand-central-m4-express/doc.md

@@ -2,12 +2,12 @@
 @ingroup     boards
 @brief       Support for the Adafruit Grand Central M4 Express
 
-General information
-===================
+## General information
 
-@image html https://cdn-learn.adafruit.com/assets/assets/000/068/748/medium800/adafruit_products_grand_central_top_angle.jpg "Picture of the Adafruit Grand Central M4 Express"
+<img src="https://cdn-learn.adafruit.com/assets/assets/000/068/748/medium800/adafruit_products_grand_central_top_angle.jpg" alt="Picture of the Adafruit Grand Central M4 Express" />
 
 The main features of the board are:
+
 - ATSAMD51 Cortex M4 running at 120 MHz
 - Hardware DSP and floating point support
 - 1 MiB Flash
@@ -17,19 +17,16 @@ The main features of the board are:
 - Micro SD Card slot connected to SPI
 - native USB
 
-Pinout
-------
+### Pinout
 
-@image html https://cdn-learn.adafruit.com/assets/assets/000/115/366/original/adafruit_products_Adafruit-Grand-Central-M4-Express-Pinout.png "Official Pinout of the Grand Central M4 Express"
+<img src="https://cdn-learn.adafruit.com/assets/assets/000/115/366/original/adafruit_products_Adafruit-Grand-Central-M4-Express-Pinout.png" alt="Official Pinout of the Grand Central M4 Express" />
 
-Links
-=====
+## Links
 
 - [Overview](https://learn.adafruit.com/adafruit-grand-central)
 - [Schematics](https://learn.adafruit.com/assets/69175)
 
-Flash the board
-===============
+## Flash the board
 
 The board is flashed using its on-board
 [boot loader](https://github.com/adafruit/uf2-samdx1).

boards/adafruit-metro-m4-express/doc.md

@@ -2,12 +2,12 @@
 @ingroup     boards
 @brief       Support for the Adafruit Metro M4 Express
 
-General information
-===================
+## General information
 
-@image html https://cdn-learn.adafruit.com/assets/assets/000/085/521/large1024/adafruit_products_metro-m4-top.jpg "Picture of the Adafruit Metro M4 Express"
+<img src="https://cdn-learn.adafruit.com/assets/assets/000/085/521/large1024/adafruit_products_metro-m4-top.jpg" alt="Picture of the Adafruit Metro M4 Express" />
 
 The main features of the board are:
+
 - ATSAMD51 Cortex M4 running at 120 MHz
 - Hardware DSP and floating point support
 - 512 MiB Flash
@@ -17,23 +17,19 @@ The main features of the board are:
 - 32-bit, 3.3V logic and power
 - native USB
 
-Pinout
-------
+### Pinout
 
-@image html https://cdn-learn.adafruit.com/assets/assets/000/111/183/original/adafruit_products_Adafruit_Metro_M4_Express_Pinout.png "Official Pinout of the Metro M4 Express" width=100%
+<img src="https://cdn-learn.adafruit.com/assets/assets/000/111/183/original/adafruit_products_Adafruit_Metro_M4_Express_Pinout.png" alt="Official Pinout of the Metro M4 Express" width=100% />
 
-Links
-=====
+## Links
 
 - [Official Board Documentation](https://learn.adafruit.com/adafruit-metro-m4-express-featuring-atsamd51)
 
-Schematics
-==========
+## Schematics
 
-@image html https://cdn-learn.adafruit.com/assets/assets/000/053/093/original/adafruit_products_schem.png "Original Board Schematics"
+<img src="https://cdn-learn.adafruit.com/assets/assets/000/053/093/original/adafruit_products_schem.png" alt="Original Board Schematics" />
 
-Arduino Compatibility
-=====================
+## Arduino Compatibility
 
 The board is compatible with Shields for the Arduino UNO / Arduino Zero.
 
@@ -43,8 +39,7 @@ The board is compatible with Shields for the Arduino UNO / Arduino Zero.
             resorting to desperate means such as bit-banging either the SPI bus
             or the UART interface.
 
-Flash the board
-===============
+## Flash the board
 
 The board is flashed using its on-board
 [boot loader](https://github.com/adafruit/uf2-samdx1).
@@ -61,8 +56,7 @@ Readiness of the bootloader is indicated by LED pulsing in red.
 @note   You may need to pass `MOST_RECENT_PORT=0` and manually pass the `PORT`
         if you enter the bootloader by hand.
 
-Accessing STDIO
----------------
+### Accessing STDIO
 
 The usual way to obtain a console on this board is using an emulated USB serial
 port.

boards/adafruit-pybadge/doc.md

@@ -14,6 +14,7 @@ The display, RGB LEDs, buttons and accelerometer of this board are currently not
 The [Adafruit PyBadge LC](https://www.adafruit.com/product/3939) and
 [Adafruit EdgeBadge](https://www.adafruit.com/product/4400)) are
 variants of the Pybadge with small differences:
+
 - EdgeBadge provides an extra microphone (not supported)
 - PyBadgeLC only have one Neopixel LED (instead of 5)
 Both are compatible with the PyBadge RIOT port and the current port can easily
@@ -24,8 +25,9 @@ be adapted/extended with their respective differences.
 Connect the board via USB and use `BOARD=adafruit-pybadge` with the `make` command;
 this uses the Arduino style bootloader preprogrammed on the board.<br/>
 Example with `hello-world` application:
-```
-     make BOARD=adafruit-pybadge -C examples/basic/hello-world flash
+
+```shell
+make BOARD=adafruit-pybadge -C examples/basic/hello-world flash
 ```
 
 In case of a crash of the firmware, one has to manually reset the board in

boards/airfy-beacon/doc.md

@@ -52,8 +52,8 @@ registers. Just follow these steps:
 3. type `nrf51 mass_erase` to reset the code memory
 4. all done, `make flash` should now work as expected.
 
+## Flashing and Debugging
 
-##  Flashing and Debugging
 The Airfy Beacon comes without any on-board programming and flashing
 capabilities. It supports however to be programmed using off-the-shelf
 programmers such as Segger's JLink or STM's STLink.
@@ -65,10 +65,12 @@ ST-Link adapter, you just simply have to alter the wiring to fit for your
 programmer, the software part is identical.
 
 ### Hardware
+
 First of all make sure the your ST-Link device is detected and can be
 accessed properly. In Linux you might have to adept your `udev` rules
 accordingly:
-```
+
+```text
 > cat 49-stlinkv2.rules
 # stm32 discovery boards, with onboard st/linkv2
 # ie, STM32L, STM32F4.
@@ -87,6 +89,7 @@ SUBSYSTEMS=="usb", ATTRS{idVendor}=="0483", ATTRS{idProduct}=="3748", \
 > sudo udevadm control --reload-rules
 > sudo udevadm trigger
 ```
+
 now replug the usb cable and flash.
 
 Have a look at the 'Setting up udev rules' section in the
@@ -101,7 +104,8 @@ the port and enables direct access through the pin-header `CN3`, also labeled
 This module supports the Serial Wire Debug (SWD) interface. To access the
 device the following four lines need to be connected with the STM32x-discovery
 board:
-```
+
+```text
                  Airfy Beacon    STM32Fx-discovery
 common ground:       GND <-----------> GND
 supply voltage:      VDD <-----------> 3V
@@ -114,6 +118,7 @@ The following image shows the wiring for an SWD flasher board:
 ![airfy-beacon-flash-connect](https://raw.githubusercontent.com/wiki/RIOT-OS/RIOT/images/airfy-beacon-flash-connect.jpg)
 
 ### Software
+
 Debugging and programming this module works well with
 [OpenOCD](http://openocd.org/).
 
@@ -123,50 +128,61 @@ Version `Open On-Chip Debugger 0.9.0-dev-00184-g885f438 (2014-10-19-14:49)`
 is reported to work.
 
 ### Programming the Device
+
 To program the Airfy Beacon, just go to your RIOT application and type:
+
+```shell
+BOARD=airfy-beacon make flash
 ```
-make flash
-```
+
 and voila, the new firmware should be flashed onto your device.
 
 ### Resetting the Device
+
 As the Airfy Beacon module does not provide a reset button, RIOT includes a
 target to reset the board. To do that, just type
+
+```shell
+BOARD=airfy-beacon make reset
 ```
-make reset
-```
+
 and your board will reboot.
 
 ### Debugging the Device
+
 The debugging setup comprises of two parts: a GDB server and a GDB client. To
 usual workflow is to start the GDB server first and then connect to it with some
 kind of front-end (e.g. command line, IDE, ...).
 
 To start the GDB server, just type
+
+```shell
+BOARD=airfy-beacon make debug-server
 ```
-make debug-server
-```
+
 This will start a local GDB server on `port 3333`.
 
 If you are fine with working with the GDB command line client, you can start
 debugging your device by just typing
+
+```shell
+BOARD=airfy-beacon make debug
 ```
-make debug
-```
+
 in a second terminal window. This will automatically connect to your
 previously opened GDB server and will also load your corresponding .elf file.
 
 Alternatively you can configure your IDE (e.g. eclipse or similar) to connect
 directly to the GDB server. [See here for more information on how to configure
-Eclipse](https://github.com/RIOT-OS/RIOT/wiki/Using-the-Eclipse-IDE-for-C-and-
+Eclipse](<https://github.com/RIOT-OS/RIOT/wiki/Using-the-Eclipse-IDE-for-C-and->
 CPP-Developers,-Howto)
 
-
 ### Program the device manually
+
 For OpenOCD to work correctly, you need the following configuration file
-(which you can also find in `RIOTDIR/boards/airfy-beacon/dist/openocd.cfg`:
+(which you can also find in `RIOTDIR/boards/airfy-beacon/dist/openocd.cfg`):
 
-```
+```text
  $ cat RIOTDIR/boards/airfy-beacon/openocd.cfg
 # nRF51822 Target
 source [find interface/stlink-v2.cfg]
@@ -188,7 +204,7 @@ beacon/dist/openocd.cfg`
 3. do the following steps to flash (only use bank #0 starting from address
 0):
 
-```
+```text
 > flash banks
 #0 : nrf51.flash (nrf51) at 0x00000000, size 0x00040000, buswidth 1,
 chipwidth 1
@@ -213,7 +229,7 @@ First you have to start OpenOCD as described in the section above.
 
 Then enter the following in a new terminal:
 
-```
+```text
 $ arm-none-eabi-gdb -tui "<your binary ELF>"
 
 (gdb) target remote localhost:3333

boards/arduino-due/doc.md

@@ -4,33 +4,26 @@
 
 \section arduino_due Arduino-Due
 
-## Table of Contents {#arduino_due_toc}
-
-1. [Overview](#arduino_due_overview)
-2. [Hardware](#arduino_due_hardware)
-    1. [MCU](#atmel_sam3x8e_mcu)
-    2. [Board Configuration](#arduino_due_board_configuration)
-    3. [Board Pinout](#arduino_due_pinout)
-3. [Flashing the Device](#arduino_due_flashing)
-
-## Overview {#arduino_due_overview}
+## Overview
 
 The Arduino Due is a microcontroller board based on the Atmel SAM3X8E ARM Cortex-M3 CPU.
 It is the first Arduino board based on a 32-bit ARM core microcontroller.
 
-\image html "https://store.arduino.cc/cdn/shop/files/A000062_00.front_1000x750.jpg" "Arduino Due board" width=750px
+<img src="https://store.arduino.cc/cdn/shop/files/A000062_00.front_1000x750.jpg" alt="Arduino Due board" width=750px />
 
-## Hardware {#arduino_due_hardware}
+## Hardware
 
-### MCU {#atmel_sam3x8e_mcu}
+### MCU
 
 The board features a SAM3X8E MCU (ARM Cortex-M3) running at up to 84MHz.
 It embeds 96 KiB of SRAM and 512 KiB of flash memory.
 The board reference manual is available [here](https://docs.arduino.cc/resources/datasheets/A000062-datasheet.pdf)
 and the MCU datasheet is available [here](https://ww1.microchip.com/downloads/en/DeviceDoc/Atmel-11057-32-bit-Cortex-M3-Microcontroller-SAM3X-SAM3A_Datasheet.pdf).
 
-### Board configuration {#arduino_due_board_configuration}
+### Board configuration
+
 The Arduino Due provides the following features:
+
 - 54 I/Os (of which 12 PWM outputs)
 - 12 analog inputs
 - 4 UARTs
@@ -44,15 +37,18 @@ The Arduino Due provides the following features:
 - A reset button
 - An erase button
 
-### Board pinout {#arduino_due_pinout}
+### Board pinout
 
-\image html "https://content.arduino.cc/assets/Pinout-Due_latest.png" "Arduino Due pinout"
+<img src="https://content.arduino.cc/assets/Pinout-Due_latest.png" alt="Arduino Due pinout" style="max-width: 100%" />
 
 The board schematics are available [here](https://docs.arduino.cc/resources/schematics/A000056-schematics.pdf).
 
-## Flashing the device {#arduino_due_flashing}
+## Flashing the device
+
 Flashing RIOT on the Arduino Due is quite straight forward as it relies on
 the preinstalled arduino bootloader. Connect your board using the programming
 port to your host computer and type:
 
-`make BOARD=arduino-due flash`
+```shell
+make BOARD=arduino-due flash
+```