Merge pull request #21968 from maribu/doc/update-api-doc-link

doc: use https://api.riot-os.org for API doc

Author: maribu

CONTRIBUTING.md

@@ -23,13 +23,15 @@ As a reminder, all contributors are expected to follow our
 ## Getting Started
 [getting-started]: #getting-started
 If you are just beginning to work with RIOT you might first want to read our
-[documentation]. Especially the following sections might be of interest to you
+[guide] and [API documentation]. Especially the following sections might be of
+interest to you
 
 - [Getting Started](https://guide.riot-os.org/getting-started/installing/)
 - [Creating modules](https://guide.riot-os.org/advanced_tutorials/creating_modules/)
 - [Creating an application](https://guide.riot-os.org/advanced_tutorials/creating_application/)
 
-[documentation]: https://doc.riot-os.org
+[guide]: https://guide.riot-os.org
+[API documentation]: https://api.riot-os.org
 
 ## Bug reports and feature requests
 [issues]: #bug-reports-and-feature-requests

README.md

@@ -59,7 +59,7 @@ LGPL code.
 [license-badge]: https://img.shields.io/github/license/RIOT-OS/RIOT
 [license-link]: https://github.com/RIOT-OS/RIOT/blob/master/LICENSE
 [api-badge]: https://img.shields.io/badge/docs-API-informational.svg
-[api-link]: https://doc.riot-os.org/
+[api-link]: https://api.riot-os.org/
 [guide-badge]: https://img.shields.io/badge/docs-Getting_Started_Guide-informational.svg
 [guide-link]: https://guide.riot-os.org/getting-started/installing/
 [mastodon-badge]: https://img.shields.io/badge/social-Mastodon-informational.svg
@@ -81,7 +81,7 @@ LGPL code.
 [getting-started]: https://guide.riot-os.org/getting-started/installing/
 [tutorials]: https://github.com/RIOT-OS/Tutorials
 [riot-course]: https://github.com/RIOT-OS/riot-course
-[api-docs]: https://doc.riot-os.org/
+[api-docs]: https://api.riot-os.org/
 
 ## Features
 

boards/doc.md

@@ -79,7 +79,7 @@ Guide to board pinouts {#pinout_guide}
 The following are the steps to take to locate specific pinouts on boards.
 This is useful when connecting external hardware to RIOT supported boards.
 
-1. Check the [board documentation](http://doc.riot-os.org/group__boards.html)
+1. Check the [board documentation](http://api.riot-os.org/group__boards.html)
 to see if the pinout is available
 2. If the pinout is not available or up to date check the following:
     - `boards/<BOARD>/include/periph_conf.h` for board specific

dist/tools/uf2/nrf52_softdevice_check.sh

@@ -53,7 +53,7 @@ if [ "${SOFTDEVICE}" = "not found" ] && [ "${UF2_SOFTDEV}" != "DROP" ]; then
     echo -e "\033[0;31mNo SoftDevice present on the device, but the compilation is set" \
     "to expect a SoftDevice."
     echo -e "For more information see:" \
-    "https://doc.riot-os.org/group__boards__common__adafruit-nrf52-bootloader.html#ada-nrf52-update"\
+    "https://api.riot-os.org/group__boards__common__adafruit-nrf52-bootloader.html#ada-nrf52-update"\
     "\033[0m"
     exit 1
 fi

dist/tools/vagrant/freebsd/README.md

@@ -67,4 +67,4 @@ Iface  6  HWaddr: F1:28:23:23:F1:28
 ```
 
 [Vagrantfile]: ./Vagrantfile
-[native]: https://doc.riot-os.org/group__boards__native.html
+[native]: https://api.riot-os.org/group__boards__native.html

doc/doxygen/header.html

@@ -75,7 +75,7 @@
               <ul id="riot-navlist" class="nav navbar-nav"></ul>
               <!--BEGIN SEARCHENGINE-->
               <form id="riot-searchform" class="navbar-form navbar-left navbar-right" action="https://duckduckgo.com/" method="get">
-                 <input type="hidden" name="sites" value="doc.riot-os.org"/>
+                 <input type="hidden" name="sites" value="api.riot-os.org"/>
                  <input type="hidden" name="kt" value="h"/>
                  <div class="form-group">
                    <div id="MSearchBox" class="MSearchBoxActive">

doc/guides/advanced_tutorials/creating_application.mdx

@@ -81,9 +81,9 @@ target board's flash memory or RAM.
 
 By default a RIOT application comprises only of the applications' code itself,
 the kernel, and platform specific code. In order to use additional modules,
-such as a particular [device driver](https://doc.riot-os.org/group__drivers.html)
-or [a system library](https://doc.riot-os.org/group__sys.html)
-(including [networking capabilities](https://doc.riot-os.org/group__net.html)),
+such as a particular [device driver](https://api.riot-os.org/group__drivers.html)
+or [a system library](https://api.riot-os.org/group__sys.html)
+(including [networking capabilities](https://api.riot-os.org/group__net.html)),
 you have to append the modules' names to the USEMODULE variable.
 For example, to build an application using the
 SHT11 temperature sensor and UDP/IPv6 functionalities of the GNRC network stack,
@@ -119,7 +119,7 @@ CFLAGS += -DTHREAD_STACKSIZE_MAIN=2048
 ```
 
 For a list of all compile time configurations check the
-[API Documentation](https://doc.riot-os.org/group__config.html).
+[API Documentation](https://api.riot-os.org/group__config.html).
 
 #### Kconfig
 

doc/guides/advanced_tutorials/creating_modules.mdx

@@ -17,10 +17,10 @@ containing source files and a Makefile. Additionally their API can be defined
 in one or more header files, residing in the include path of their
 super-module.
 
-E.g. the [Shell](https://doc.riot-os.org/group__sys__shell.html) module
+E.g. the [Shell](https://api.riot-os.org/group__sys__shell.html) module
 is implemented in `sys/shell` and defines its
 API in `sys/include/shell.h` and the
-[ISL29020 light sensor](https://doc.riot-os.org/group__drivers__isl29020.html)
+[ISL29020 light sensor](https://api.riot-os.org/group__drivers__isl29020.html)
 driver is implemented in `drivers/isl29020`
 and defines its API in `drivers/include/isl29020.h`.
 

doc/guides/advanced_tutorials/device_drivers.md

@@ -204,10 +204,10 @@ above.
 ### Compile-time Configuration Documentation
 
 The macros that configure the driver during compilation is added to the listing
-for [Compile time configurations](https://doc.riot-os.org/group__config.html). Refer to the following example
+for [Compile time configurations](https://api.riot-os.org/group__config.html). Refer to the following example
 that exposes
 [TMP00x sensor](https://github.com/RIOT-OS/RIOT/blob/2025.07-branch/drivers/include/tmp00x.h#L96-L157)
-to [sensors group](https://doc.riot-os.org/group__config__drivers__sensors.htmls).
+to [sensors group](https://api.riot-os.org/group__config__drivers__sensors.htmls).
 
 ```c
 /**

doc/guides/advanced_tutorials/porting_boards.mdx

@@ -62,13 +62,13 @@ configurations. e.g:
   buttons. It might as well override default drivers parameters (e.g.: assigning
   specific pin connections to a LCD screen, radio, etc.).
 - `gpio_params.h`: if the board supports
-  [SAUL](https://doc.riot-os.org/group__drivers__saul.html) then its
-  [saul_gpio_params_t](https://doc.riot-os.org/structsaul__gpio__params__t.html)
+  [SAUL](https://api.riot-os.org/group__drivers__saul.html) then its
+  [saul_gpio_params_t](https://api.riot-os.org/structsaul__gpio__params__t.html)
   is defined here. (Analogously, an `adc_params.h` can
-  contain a [saul_adc_params_t](https://doc.riot-os.org/structsaul__adc__params__t.html)
+  contain a [saul_adc_params_t](https://api.riot-os.org/structsaul__adc__params__t.html)
   and `pwm_params.h` a
-  [saul_pwm_rgb_params_t](https://doc.riot-os.org/structsaul__pwm__rgb__params__t.html)
-  and a [saul_pwm_dimmer_params_t](https://doc.riot-os.org/structsaul__pwm__dimmer__params__t.html)).
+  [saul_pwm_rgb_params_t](https://api.riot-os.org/structsaul__pwm__rgb__params__t.html)
+  and a [saul_pwm_dimmer_params_t](https://api.riot-os.org/structsaul__pwm__dimmer__params__t.html)).
 - other: other specific headers needed by one `BOARD`
 
 :::note
@@ -128,12 +128,12 @@ present in the platform should be enabled. Each board (or CPU) has knowledge as
 to which drivers should be enabled in each case.
 
 The previous code snippet shows how a board which has a
-[Semtech SX1272 and SX1276 radio driver](https://doc.riot-os.org/group__drivers__sx127x.html)
+[Semtech SX1272 and SX1276 radio driver](https://api.riot-os.org/group__drivers__sx127x.html)
 device, pulls in its driver when the default network interfaces are required.
 
 When the pseudomodule `saul_default` is enabled, the board should pull in all
 the drivers of the devices it has which provide a
-[[S]ensor [A]ctuator [U]ber [L]ayer](https://doc.riot-os.org/group__drivers__saul.html)
+[[S]ensor [A]ctuator [U]ber [L]ayer](https://api.riot-os.org/group__drivers__saul.html)
 interface. This is usually done as following:
 
 ```makefile
@@ -273,8 +273,8 @@ For example: If you observe "erratic" blinking patterns in
 ### Overhead Calibration
 
 When using the high level timer `ztimer` there is an overhead in calling the
-[ztimer_sleep](https://doc.riot-os.org/group__sys__ztimer.html#gade98636e198f2d571c8acd861d29d360)
-and [ztimer_set](https://doc.riot-os.org/group__sys__ztimer.html#ga8934a79a89e35d58673418a1e4a2e69c)
+[ztimer_sleep](https://api.riot-os.org/group__sys__ztimer.html#gade98636e198f2d571c8acd861d29d360)
+and [ztimer_set](https://api.riot-os.org/group__sys__ztimer.html#ga8934a79a89e35d58673418a1e4a2e69c)
 functions. This offset can be compensated for.
 It can be measured by running `tests/sys/ztimer_overhead` on your board, i.e:
 
@@ -311,7 +311,7 @@ The last two lines can be added as defines to the new board `board.h`:
 ```
 
 Alternatively, the pseudomodule
-[ztimer_auto_adjust](https://doc.riot-os.org/group__pseudomodule__ztimer__auto__adjust.html)
+[ztimer_auto_adjust](https://api.riot-os.org/group__pseudomodule__ztimer__auto__adjust.html)
 can be used in an application to enable automatic timer offset compensation at board startup.
 This however incurs overhead both in the text segment and at bootup time.
 
@@ -572,10 +572,10 @@ in place of the actual board name in the environment or Make variable `BOARD`.
 
 A list of all existing board aliases can be found in
 [`makefiles/board_alias.inc.mk`](https://github.com/RIOT-OS/RIOT/blob/master/makefiles/board_alias.inc.mk).
-[`BOARD=native`](https://doc.riot-os.org/group__boards__common__native.html)
+[`BOARD=native`](https://api.riot-os.org/group__boards__common__native.html)
 is a special alias in that it
-resolves to either [`native32`](https://doc.riot-os.org/group__boards__native32.html)
-or [`native64`](https://doc.riot-os.org/group__boards__native64.html)
+resolves to either [`native32`](https://api.riot-os.org/group__boards__native32.html)
+or [`native64`](https://api.riot-os.org/group__boards__native64.html)
 depending on the host architecture.
 
 ## Tools
@@ -595,7 +595,7 @@ Some scripts and tools available to ease `BOARD` porting and testing:
 ## Further Reference
 
 - [In her blog](https://blog.martine-lenders.eu/riot-board-en.html), Martine Lenders documented her approach of
-  porting the [Adafruit Feather nRF52840 Express](https://doc.riot-os.org/group__boards__adafruit-feather-nrf52840-express.html)
+  porting the [Adafruit Feather nRF52840 Express](https://api.riot-os.org/group__boards__adafruit-feather-nrf52840-express.html)
   in February 2020.
 - [Over at HackMD](https://hackmd.io/njFHwQ33SNS3sQKAkLkNtQ), Akshai M documented his approach of
-  porting the [Silicon Labs SLSTK3400A starter kit](https://doc.riot-os.org/group__boards__slstk3400a.html) in July 2020.
+  porting the [Silicon Labs SLSTK3400A starter kit](https://api.riot-os.org/group__boards__slstk3400a.html) in July 2020.