doc/guides: migrate rpl networking guide from wiki by elenaf9 · Pull Request #22460 · RIOT-OS/RIOT

elenaf9 · 2026-07-10T14:33:39Z

Contribution description

Migrate the wiki Tutorial: RIOT and Multi Hop Routing with RPL to Starlight.

Small refactor:

Before: the tutorial included two guides, one for native and one for using the IoT-Lab. The RPL-related sections were mostly duplicated.
Now: One Starting RIOT section for three setups: Local hardware, native, and IoT-Lab. The remaining RPL-related sections are then shared.

Testing procedure

I am not familiar with Starlight. Can I preview the page locally somehow?

Issues/PRs references

Discussed in #22265.

Declaration of AI-Tools / LLMs usage:

AI-Tools / LLMs that were used are:

GPT 5.3 for spell-checking

elenaf9 · 2026-07-10T14:37:01Z

+To flash your application onto all nodes in the experiment, use the `iotlab-flash` command:
+
+```sh
+$ IOTLAB_USER=<iotlab_user> BOARD=iotlab-m3 make iotlab-flash
+```


The iotlab-exp command before should already flash the firmware onto all nodes.
However, the command somehow failed for me, so I removed the flashing part from iotlab-exp locally and added this step here. Before merging the PR, the iotlab-exp command should be fixed (or I should figure out why it didn't work for me specifically) and this section revisited.

AnnsAnns · 2026-07-10T15:17:48Z

I am not familiar with Starlight. Can I preview the page locally somehow?

Yes, https://guide.riot-os.org/misc/how_to_doc/ should help you with that 😄

AnnsAnns · 2026-07-10T15:29:37Z

+```sh
+$ make flash term
+```


Suggested change

```sh

$ make flash term

```

make flash term

Removing the $ makes it copy-pastable with the little button that pops up :) (The suggestion is broken though, don't apply it)

I was using the conventions from the riot exercises, to differentiate between Linux shell and RIOT shell commands.
Does that convention not apply in the guides here?

I have never seen that convention if I am totally honest with you, the repo is also outside of the RIOT org 🤓 ☝️

That being said, I think it's generally fine to keep it as is, esp. since you are following that convention. This was more of a "neat to have".

Don't have a strong opinion. The fact that you can't copy a command well if it's prepended with $ also annoys me sometimes ^^
Does someone else have an opinion on this? cc @mguetschow

Now that we have fancy starlight, couldn't we somehow mark the codeblock as being the host or RIOT shell and visualize that in starlight outside of the copy-able area? somehow annotate the codeblock HTML and a simple CSS rule should do.

Other than that, I would prefer removing the $ so it is easy to copy. Should be clear from the context anyhow what is meant.

It appears like that we can do this by directly using the Code component with the theme attribute, however, this might make it look weird depending on whether you use dark/light theme, e.g. if we make RIOT default to a dark blue theme for code blocks it would then look really out of place when using the light theme and I don't see an (easy) option to give a theme depending on that. (All that to say "Yes but hard")

I am also in favor to remove the $, as I have also already done at many places, we should update the docs

riot-ci · 2026-07-10T15:41:56Z

Murdock results

✔️ PASSED

970658c fixup! doc/starlight: move CoAP tutorial to networking group

Success	Failures	Total	Runtime
1	0	1	01m:12s

Artifacts

Documentation preview

crasbe

Thank you for starting the wiki move. This is a really good tutorial that was quite hidden in the Wiki 😅

crasbe · 2026-07-11T11:01:00Z

+
+Type the following command in three different terminals, using `tap0`, `tap1`, and `tap2`, respectively.
+
+```sh


Suggested change

```sh

```

These are not really shell commands.

See #22460 (comment).

crasbe · 2026-07-11T11:07:01Z

+
+List all connected boards, their port, and serial number.
+
+```sh


Suggested change

```sh

```

These are also not really shell commands but rather printout of a command.

Why would it not be a shell command? I think the format:

$ command printout printout

is quite common for markdown code blocks. ¹
Without the sh we loose syntax highlighting, which is generally recommended for all fenced code blocks. ²

Footnotes

https://github.com/DavidAnson/markdownlint/blob/main/doc/md014.md ↩

https://github.com/DavidAnson/markdownlint/blob/main/doc/md040.md ↩

Currently in starlight we don't use the "$" prefix because this is in conflict with the copy button and starlight already visualizes quite clear that it is a shell command.

We right now usually just split the command and output into 2 different code blocks at other places in the guides.

Apply suggestions from code review. Co-authored-by: crasbe <crasbe@gmail.com>

Max 80 characters per line.

Move coap.mdx to networking folder.

Add intro sentence.

AnnsAnns · 2026-07-18T09:30:42Z

+```sh
+$ make flash term
+```


It appears like that we can do this by directly using the Code component with the theme attribute, however, this might make it look weird depending on whether you use dark/light theme, e.g. if we make RIOT default to a dark blue theme for code blocks it would then look really out of place when using the light theme and I don't see an (easy) option to give a theme depending on that. (All that to say "Yes but hard")

crasbe · 2026-07-20T14:20:18Z

This has to be rebased, now that the #22481 PR is in.

doc/guides: migrate rpl networking guide from wiki

a8e21db

elenaf9 requested review from AnnsAnns, aabadie and jia200x as code owners July 10, 2026 14:33

github-actions Bot added the Area: doc Area: Documentation label Jul 10, 2026

elenaf9 commented Jul 10, 2026

View reviewed changes

AnnsAnns reviewed Jul 10, 2026

View reviewed changes

Comment thread doc/starlight/astro.config.ts Outdated

Comment thread doc/guides/networking/rpl.mdx

AnnsAnns reviewed Jul 10, 2026

View reviewed changes

docs/guides: fix rpl guide

a0c9f7b

crasbe added the Type: new feature The issue requests / The PR implemements a new feature for RIOT label Jul 11, 2026

crasbe reviewed Jul 11, 2026

View reviewed changes

crasbe mentioned this pull request Jul 11, 2026

Should we sunset the Wiki? #22265

Open

fixup! doc/guides: migrate rpl networking guide from wiki

f5da29c

Apply suggestions from code review. Co-authored-by: crasbe <crasbe@gmail.com>

github-actions Bot removed the Area: network Area: Networking label Jul 13, 2026

elenaf9 added 5 commits July 13, 2026 13:09

doc/starlight: move CoAP tutorial to networking group

3aa8174

fixup! doc/guides: migrate rpl networking guide from wiki

d196dcf

Max 80 characters per line.

fixup! doc/starlight: move CoAP tutorial to networking group

65fb519

Move coap.mdx to networking folder.

fixup! doc/guides: migrate rpl networking guide from wiki

3ec1a86

Add intro sentence.

fixup! doc/starlight: move CoAP tutorial to networking group

8bed332

AnnsAnns reviewed Jul 15, 2026

View reviewed changes

Comment thread doc/starlight/astro.config.ts

elenaf9 added 2 commits July 15, 2026 15:21

fixup! doc/starlight: move CoAP tutorial to networking group

9680b76

fixup! doc/starlight: move CoAP tutorial to networking group

970658c

AnnsAnns approved these changes Jul 18, 2026

View reviewed changes

AnnsAnns mentioned this pull request Jul 18, 2026

doc/starlight: split sidebar into categories #22481

Merged

crasbe added the State: needs rebase State: The codebase was changed since the creation of the PR, making a rebase necessary label Jul 20, 2026


		Type the following command in three different terminals, using `tap0`, `tap1`, and `tap2`, respectively.

		```sh


		List all connected boards, their port, and serial number.

		```sh

Uh oh!

Conversation

elenaf9 commented Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Contribution description

Testing procedure

Issues/PRs references

Declaration of AI-Tools / LLMs usage:

Uh oh!

elenaf9 Jul 10, 2026 • 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!

Uh oh!

Uh oh!

AnnsAnns commented Jul 10, 2026

Uh oh!

AnnsAnns Jul 10, 2026 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elenaf9 Jul 10, 2026 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LasseRosenow Jul 19, 2026 • 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!

riot-ci commented Jul 10, 2026 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Footnotes

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

crasbe commented Jul 20, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

elenaf9 commented Jul 10, 2026 •

edited

Loading

elenaf9 Jul 10, 2026 •

edited

Loading

AnnsAnns Jul 10, 2026 •

edited

Loading

elenaf9 Jul 10, 2026 •

edited

Loading

LasseRosenow Jul 19, 2026 •

edited

Loading

riot-ci commented Jul 10, 2026 •

edited

Loading