Skip to content

Commit 47768a6

Browse files
authored
Merge pull request #159 from LasseRosenow/rename-api-doc-links
Rename doc.riot-os.org to api.riot-os.org
2 parents a8c1ddf + 9b99769 commit 47768a6

6 files changed

Lines changed: 14 additions & 14 deletions

File tree

_faqs/faq-10.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
question: Does RIOT support Raspberry Pi?
33
---
44

5-
RIOT does support the [Raspberry Pi Pico](https://doc.riot-os.org/group__boards__rpi__pico.html) and the [Raspberry Pi Pico W](https://doc.riot-os.org/group__boards__rpi__pico__w.html).
5+
RIOT does support the [Raspberry Pi Pico](https://api.riot-os.org/group__boards__rpi__pico.html) and the [Raspberry Pi Pico W](https://api.riot-os.org/group__boards__rpi__pico__w.html).
66

7-
The Linux-capable Raspberry Pi boards are not supported, though. From the RIOT point of view these boards are supercomputers. RIOT targets mostly systems that are too constrained to run Linux (less than 1MB of RAM, no MMU). However, it is supported to run [RIOT native](https://doc.riot-os.org/group__boards__native.html) ([or the 64 bit native variant](https://doc.riot-os.org/group__boards__native64.html)) on platforms like the Raspberry Pi, and other hardware supported by Linux.
7+
The Linux-capable Raspberry Pi boards are not supported, though. From the RIOT point of view these boards are supercomputers. RIOT targets mostly systems that are too constrained to run Linux (less than 1MB of RAM, no MMU). However, it is supported to run [RIOT native](https://api.riot-os.org/group__boards__native.html) ([or the 64 bit native variant](https://api.riot-os.org/group__boards__native64.html)) on platforms like the Raspberry Pi, and other hardware supported by Linux.
88

9-
A good rule of thumb concerning RIOT support of a particular board is: can Linux support this board? If yes, then you should ask yourself *why* you really want to use RIOT (other than [native](https://doc.riot-os.org/group__boards__native.html)) on this board. If no, then RIOT support is probably desirable.
9+
A good rule of thumb concerning RIOT support of a particular board is: can Linux support this board? If yes, then you should ask yourself *why* you really want to use RIOT (other than [native](https://api.riot-os.org/group__boards__native.html)) on this board. If no, then RIOT support is probably desirable.

_faqs/faq-12.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -102,13 +102,13 @@ Contiki-NG's development is steered by a small group of (mostly) computer scienc
102102
[contiki-ng-homepage]: https://www.contiki-ng.org/
103103
[freertos-aws-homepage]: https://www.freertos.org/iot-libraries.html
104104
[freertos-homepage]: https://www.freertos.org
105-
[riot-arduino-nano]: https://doc.riot-os.org/group__boards__arduino-nano.html
106-
[riot-arduino]: https://doc.riot-os.org/group__sys__arduino.html
107-
[riot-community-process]: https://doc.riot-os.org/community-processes.html
108-
[riot-esp32c3-devkit]: https://doc.riot-os.org/group__boards__esp32c3__devkit.html
105+
[riot-arduino-nano]: https://api.riot-os.org/group__boards__arduino-nano.html
106+
[riot-arduino]: https://api.riot-os.org/group__sys__arduino.html
107+
[riot-community-process]: https://api.riot-os.org/community-processes.html
108+
[riot-esp32c3-devkit]: https://api.riot-os.org/group__boards__esp32c3__devkit.html
109109
[riot-forum]: https://forum.riot-os.org
110110
[riot-matrix]: https://matrix.to/#/#riot-os:matrix.org
111-
[riot-same54-xpro]: https://doc.riot-os.org/group__boards__same54-xpro.html
111+
[riot-same54-xpro]: https://api.riot-os.org/group__boards__same54-xpro.html
112112
[riot-zep-dispatcher]: https://github.com/RIOT-OS/RIOT/tree/master/dist/tools/zep_dispatch
113113
[zephyr-homepage]: https://www.zephyrproject.org
114114
[zephyr-tsc]: https://www.zephyrproject.org/wp-content/uploads/sites/38/2020/09/CLEAN-LF-Zephyr-Charter-20200624-effective-20200901.pdf

_includes/driver_list.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
{% include driver_list.html %}
66
{% endif %}
77
{% unless item.children %}
8-
<li class="list-group-item"><a href="https://doc.riot-os.org/{{ item.file }}.html" target="_blank">{{ item.name }}</a></li>
8+
<li class="list-group-item"><a href="https://api.riot-os.org/{{ item.file }}.html" target="_blank">{{ item.name }}</a></li>
99
{% endunless %}
1010
{% endfor %}
1111
</ul>

_includes/header.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<li><a href="https://www.hackster.io/riot-os" target="_blank">Tutorials@Hackster.io<i class="bi bi-box-arrow-up-right align-text-bottom"></i></a></li>
2222
<li><a href="{% link index.html %}#faq">FAQ</a></li>
2323
<li><a href="https://guide.riot-os.org/" target="_blank">Guides <i class="bi bi-box-arrow-up-right align-text-bottom"></i></a></li>
24-
<li><a href="https://doc.riot-os.org/" target="_blank">API Documentation <i class="bi bi-box-arrow-up-right align-text-bottom"></i></a></li>
24+
<li><a href="https://api.riot-os.org/" target="_blank">API Documentation <i class="bi bi-box-arrow-up-right align-text-bottom"></i></a></li>
2525
</ul>
2626
</li>
2727
<li class="dropdown">

_posts/2021-02-26-feather-nrf52840.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -460,12 +460,12 @@ source "$(RIOTBOARD)/common/nrf52/Kconfig"
460460
[Makefile.include]: https://github.com/RIOT-OS/RIOT/blob/78b5c1ee5c55/boards/feather-nrf52840/Makefile.include
461461
[periph_conf.h]: https://github.com/RIOT-OS/RIOT/blob/78b5c1ee5c55/boards/feather-nrf52840/include/periph_conf.h
462462
[schematics]: https://learn.adafruit.com/assets/68545
463-
[SAUL]: https://doc.riot-os.org/group__drivers__saul.html
463+
[SAUL]: https://api.riot-os.org/group__drivers__saul.html
464464
[gpio_params.h]: https://github.com/RIOT-OS/RIOT/blob/78b5c1ee5c55/boards/feather-nrf52840/include/gpio_params.h
465465
[GPIO]: https://en.wikipedia.org/wiki/General-purpose_input/output
466466
[board.h]: https://github.com/RIOT-OS/RIOT/blob/78b5c1ee5c55/boards/feather-nrf52840/include/board.h
467467
[board.c]: https://github.com/RIOT-OS/RIOT/blob/78b5c1ee5c55/boards/feather-nrf52840/board.c
468-
[boards doc]: https://doc.riot-os.org/group__boards.html
469-
[feather doc]: https://doc.riot-os.org/group__boards__feather-nrf52840.html
468+
[boards doc]: https://api.riot-os.org/group__boards.html
469+
[feather doc]: https://api.riot-os.org/group__boards__feather-nrf52840.html
470470
[CPUs]: {% link cpus.html %}
471471
[Kconfig]: https://github.com/RIOT-OS/RIOT/blob/ecebdb761b8dae7db4907af512f99329ddb1d6e4/boards/feather-nrf52840/Kconfig

_tools/fetch_riot_data.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
DEFAULT_RIOT_BASE = os.path.join(os.path.abspath(__file__), "_RIOT")
2525
RIOTBASE = os.path.abspath(os.getenv("RIOTBASE", DEFAULT_RIOT_BASE))
2626

27-
RIOT_DOC_BASE_URL = "https://doc.riot-os.org"
27+
RIOT_DOC_BASE_URL = "https://api.riot-os.org"
2828
TEMPLATE_BASE_DIR = os.path.dirname(os.path.abspath(__file__))
2929

3030
#

0 commit comments

Comments
 (0)