doc: deprecate Doxygen `Getting Started` and add CoAP guide by LasseRosenow · Pull Request #21792 · RIOT-OS/RIOT

LasseRosenow · 2025-10-13T15:20:48Z

Contribution description

This deprecates the remaining sections in the Getting started page of the old doxygen docs.

This also adds a new CoAP guide, but this one is still WIP especially regarding the code testing part.

This also added support to the code_checker of the guides to check files in subfolders. I needed this for the new coap guide, which comes with a server and a client application.

LasseRosenow · 2025-10-13T21:08:08Z

This is ready for review now.
I hope this is the last time for the coming future that we need to push package-lock.json files without adding new packages.
I have changed the install script to use npm ci which does not modify the package-lock.json, but needs the package-lock.json to be "in-sync" with the package.json.
The state was, that it was not in-sync, so I needed to run npm install once more, so that it is in a good state now.

riot-ci · 2025-10-13T22:59:19Z

Murdock results

✔️ PASSED

d69396e dist/tools/code_in_guides_check: support subfolders

Success	Failures	Total	Runtime
37	0	37	01m:48s

Artifacts

Documentation preview

crasbe

There are some static errors about missing copyright notices and long lines, please check that at your own discretion :)

doc/guides/advanced_tutorials/creating_application.md

doc/guides/c_tutorials/coap.md

doc/starlight/Makefile

LasseRosenow · 2025-10-14T07:18:47Z

Thank you for your review :) I addressed everything except the points that need further clarification/discussion :)

AnnsAnns

You guys live in the same timezone as me why are you both doing stuff at 1am 😨 (Small nitpicks)

doc/guides/c_tutorials/coap.md

examples/guides/coap/client/main.c

LasseRosenow · 2025-10-14T09:18:52Z

You guys live in the same timezone as me why are you both doing stuff at 1am 😨 (Small nitpicks)

I was deep asleep at 1am lol wuat? 😲

crasbe · 2025-10-14T09:32:20Z

You guys live in the same timezone as me why are you both doing stuff at 1am 😨

Watching Starship Launch 11 🚀

LasseRosenow · 2025-10-14T09:35:39Z

Watching Starship Launch 11 🚀

Did it at least crash into some famous billionaires home?

LasseRosenow · 2025-10-14T09:49:58Z

All reviews addressed (I hope)

AnnsAnns · 2025-10-14T10:57:45Z

You guys live in the same timezone as me why are you both doing stuff at 1am 😨

Watching Starship Launch 11 🚀

Damn, you should work on space tech or something /s

doc/guides/c_tutorials/coap.md

AnnsAnns

Thank you for all your work on this, we finally have a guide for the one section we were really missing 😄 (And 🦀 doxygen guides are dead 🦀 )

(Squashable from my POV but wait for crasbe/mguetschow pls)

crasbe

Just a smöl thing, let's wait for @mguetschow too though.

doc/guides/advanced_tutorials/creating_application.md

AnnsAnns · 2025-10-14T13:10:03Z

Looks like he reacted with a 🚀 to his review. (Also, 3 Acks? Quick, rewrite the core of RIOT in Rust while you can and nobody notices /s)

crasbe · 2025-10-15T10:49:23Z

Let me run make generate-Makefile.ci for your two new examples real quick.

crasbe · 2025-10-15T11:06:37Z

Client:

buechse@skyleaf:~/RIOTstuff/riot-release/RIOT/examples/guides/coap$ cat client/Makefile.ci
BOARD_INSUFFICIENT_MEMORY := \
    arduino-duemilanove \
    arduino-leonardo \
    arduino-mega2560 \
    arduino-nano \
    arduino-uno \
    atmega328p \
    atmega328p-xplained-mini \
    atmega8 \
    bluepill-stm32f030c8 \
    i-nucleo-lrwan1 \
    msb-430 \
    msb-430h \
    nucleo-c031c6 \
    nucleo-f030r8 \
    nucleo-f031k6 \
    nucleo-f042k6 \
    nucleo-f303k8 \
    nucleo-f334r8 \
    nucleo-l011k4 \
    nucleo-l031k6 \
    nucleo-l053r8 \
    olimex-msp430-h1611 \
    olimex-msp430-h2618 \
    samd10-xmini \
    slstk3400a \
    stk3200 \
    stm32f030f4-demo \
    stm32f0discovery \
    stm32g0316-disco \
    stm32l0538-disco \
    telosb \
    weact-g030f6 \
    z1 \
    #

Server:

buechse@skyleaf:~/RIOTstuff/riot-release/RIOT/examples/guides/coap$ cat server/Makefile.ci
BOARD_INSUFFICIENT_MEMORY := \
    arduino-duemilanove \
    arduino-leonardo \
    arduino-mega2560 \
    arduino-nano \
    arduino-uno \
    atmega328p \
    atmega328p-xplained-mini \
    atmega8 \
    bluepill-stm32f030c8 \
    i-nucleo-lrwan1 \
    msb-430 \
    msb-430h \
    nucleo-c031c6 \
    nucleo-f030r8 \
    nucleo-f031k6 \
    nucleo-f042k6 \
    nucleo-f303k8 \
    nucleo-f334r8 \
    nucleo-l011k4 \
    nucleo-l031k6 \
    nucleo-l053r8 \
    olimex-msp430-h1611 \
    samd10-xmini \
    slstk3400a \
    stk3200 \
    stm32f030f4-demo \
    stm32f0discovery \
    stm32g0316-disco \
    stm32l0538-disco \
    telosb \
    weact-g030f6 \
    z1 \
    #

LasseRosenow · 2025-10-15T12:51:16Z

Thank you, I added them :)

crasbe · 2025-10-15T12:51:59Z

You can squash that directly.

Co-authored-by: crasbe <[email protected]> Co-authored-by: Ann🐸 <[email protected]>

LasseRosenow · 2025-10-15T12:52:48Z

Done

Teufelchen1 · 2025-10-15T12:57:31Z

dist/tools/code_in_guides_check/check_for_code.sh

+    while IFS= read -r -d '' src_file; do
        # Read the file content
        src_content=$(cat "$src_file")


Suggested change

while IFS= read -r -d '' src_file; do

# Read the file content

src_content=$(cat "$src_file")

# Exclude `/bin/` folders

INPUT_FILES=$(

find "$SOURCE_DIR" \

-type d -name "bin" -prune\

-or -type f -print\

)

for src_file in "$INPUT_FILES"; do

# Read the file content

src_content=$(cat "$src_file")

Why not like that? Am I missing something that the (for me) obvious solution was not chosen?

I also hate that $SOURCE_DIR is just magically known here...

Since this wasn't a patch but a hint at an alternative coupled to a question, patching this in broke the script.

Teufelchen1 · 2025-10-15T12:59:45Z

I feel like this should have been two or three PRs.

LasseRosenow · 2025-10-15T13:04:39Z

I applied your patches

AnnsAnns · 2025-10-15T13:07:22Z

dist/tools/code_in_guides_check/check_for_code.sh

-    for src_file in "$SOURCE_DIR"/*; do
-        # Skip if not a regular file
-        [ -f "$src_file" ] || continue
-
+# Exclude `/bin/` folders
+INPUT_FILES=$(
+    find "$SOURCE_DIR" \
+    -type d -name "bin" -prune\
+    -or -type f -print\
+)


Wrong indentation

Actually, it appears like the CI fails completely 😅

Also the GitHub static test is very mad one line below. (Not sure why tho, works on my machine hehehehe)

dist/tools/code_in_guides_check/check_for_code.sh

LasseRosenow · 2025-10-15T13:24:53Z

Okay the script works again

dist/tools/code_in_guides_check/check_for_code.sh

Co-authored-by: Teufelchen <[email protected]> Co-authored-by: Ann🐸 <[email protected]>

AnnsAnns

🫡 Here we go again

github-actions bot added Area: doc Area: Documentation Area: examples Area: Example Applications labels Oct 13, 2025

doc/starlight: prevent package-lock.json to always change on install

762f42a

LasseRosenow force-pushed the doxygen-deprecate-getting-started branch 3 times, most recently from 2b8d906 to c6ad698 Compare October 13, 2025 20:55

github-actions bot added the Area: tools Area: Supplementary tools label Oct 13, 2025

LasseRosenow marked this pull request as ready for review October 13, 2025 21:06

LasseRosenow requested review from AnnsAnns, aabadie and jia200x as code owners October 13, 2025 21:06

crasbe reviewed Oct 13, 2025

View reviewed changes

crasbe changed the title ~~Doxygen deprecate getting started and add CoAP guide~~ doc: deprecate Doxygen Getting Started and add CoAP guide Oct 13, 2025

AnnsAnns requested changes Oct 14, 2025

View reviewed changes

doc/guides/c_tutorials/coap.md Outdated Show resolved Hide resolved

examples/guides/coap/client/main.c Outdated Show resolved Hide resolved

mguetschow reviewed Oct 14, 2025

View reviewed changes

doc/guides/c_tutorials/coap.md Show resolved Hide resolved

AnnsAnns reviewed Oct 14, 2025

View reviewed changes

doc/guides/c_tutorials/coap.md Outdated Show resolved Hide resolved

AnnsAnns approved these changes Oct 14, 2025

View reviewed changes

crasbe approved these changes Oct 14, 2025

View reviewed changes

doc/guides/advanced_tutorials/creating_application.md Outdated Show resolved Hide resolved

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 15, 2025

crasbe removed the CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs label Oct 15, 2025

doc/guides: add coap guide

6332834

Co-authored-by: crasbe <[email protected]> Co-authored-by: Ann🐸 <[email protected]>

LasseRosenow force-pushed the doxygen-deprecate-getting-started branch from 0468dde to 392729f Compare October 15, 2025 12:52

crasbe enabled auto-merge October 15, 2025 12:53

crasbe added this pull request to the merge queue Oct 15, 2025

Teufelchen1 reviewed Oct 15, 2025

View reviewed changes

crasbe removed this pull request from the merge queue due to a manual request Oct 15, 2025

AnnsAnns reviewed Oct 15, 2025

View reviewed changes

Teufelchen1 reviewed Oct 15, 2025

View reviewed changes

dist/tools/code_in_guides_check/check_for_code.sh Outdated Show resolved Hide resolved

AnnsAnns requested changes Oct 15, 2025

View reviewed changes

dist/tools/code_in_guides_check/check_for_code.sh Outdated Show resolved Hide resolved

dist/tools/code_in_guides_check/check_for_code.sh Outdated Show resolved Hide resolved

AnnsAnns reviewed Oct 15, 2025

View reviewed changes

dist/tools/code_in_guides_check/check_for_code.sh Outdated Show resolved Hide resolved

AnnsAnns reviewed Oct 15, 2025

View reviewed changes

dist/tools/code_in_guides_check/check_for_code.sh Show resolved Hide resolved

dist/tools/code_in_guides_check: support subfolders

d69396e

Co-authored-by: Teufelchen <[email protected]> Co-authored-by: Ann🐸 <[email protected]>

AnnsAnns approved these changes Oct 15, 2025

View reviewed changes

LasseRosenow force-pushed the doxygen-deprecate-getting-started branch from c34fab9 to d69396e Compare October 15, 2025 13:41

AnnsAnns enabled auto-merge October 15, 2025 13:43

AnnsAnns added this pull request to the merge queue Oct 15, 2025

Merged via the queue into RIOT-OS:master with commit e46e3ac Oct 15, 2025
26 checks passed

LasseRosenow deleted the doxygen-deprecate-getting-started branch October 15, 2025 13:56

benpicco added this to the Release 2025.10 milestone Dec 3, 2025

Conversation

LasseRosenow commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Contribution description

Uh oh!

LasseRosenow commented Oct 13, 2025

Uh oh!

riot-ci commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Murdock results

Artifacts

Uh oh!

crasbe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LasseRosenow commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AnnsAnns left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

LasseRosenow commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

crasbe commented Oct 14, 2025

Uh oh!

LasseRosenow commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LasseRosenow commented Oct 14, 2025

Uh oh!

AnnsAnns commented Oct 14, 2025

Uh oh!

Uh oh!

Uh oh!

AnnsAnns left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

crasbe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AnnsAnns commented Oct 14, 2025

Uh oh!

Uh oh!

crasbe commented Oct 15, 2025

Uh oh!

crasbe commented Oct 15, 2025

Uh oh!

LasseRosenow commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

crasbe commented Oct 15, 2025

Uh oh!

LasseRosenow commented Oct 15, 2025

Uh oh!

Teufelchen1 Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

Teufelchen1 Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LasseRosenow Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Teufelchen1 commented Oct 15, 2025

LasseRosenow commented Oct 13, 2025 •

edited

Loading

riot-ci commented Oct 13, 2025 •

edited

Loading

LasseRosenow commented Oct 14, 2025 •

edited

Loading

LasseRosenow commented Oct 14, 2025 •

edited

Loading

LasseRosenow commented Oct 14, 2025 •

edited

Loading

AnnsAnns left a comment •

edited

Loading

LasseRosenow commented Oct 15, 2025 •

edited

Loading

Teufelchen1 Oct 15, 2025 •

edited

Loading