sys/riotboot: documentation issues

[gschorcht]

Description

The documentation of the riotboot module and its associated files has the following problems:

1. Documentation in sys/include/slot.h causes a problem in Modules / System page and further in Modules / System / Helpers ....

2. Documentation structure for associated files and pseudomodules seems to be a bit confusing. Documentation of associated files and pseudomodules is quite difficult to find in Modules / System page

   • riotboot_flashwrite is listed as riotboot flash writer
   • riotboot_hdr is listed as RIOT header helpers and tools
   • riotboot_slot is is listed as Helpers to manipulate partitions (slots)

   Due the alphabetical order they are difficult to find.

3. Page titles for riotboot_hdr and expecially riotboot_slot are not self explaining or even confusing.

Expected results

Even though it is possible to define pseudomodules riotboot_%, these pseudomodules are not used. In fact, there is only one module riotbootand riotboot_flashwrite, riotboot_hdr and riotboot_slot are simply parts of the riotboot module.

IMHO, it would be better to have one page Module / System / Riotboot ... or something self explaining for module riotboot and to add the documentation of associated files or pseudomodules to that group.

Related Issues/PRs

PR #11181

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If you want me to ignore this issue, please mark it with the "State: don't stale" label. Thank you for your contributions.

[kaspar030]

unstale