Skip to content

[tracking] improving the onboarding experience #20388

@maribu

Description

@maribu

Description

RIOT does actually have a lot of good documentation, which however is difficult to find and poorly structure. Some documentation is outdated, lacking, or non-existend.

Let's try to fix this:

  • Agree on what the "landing page" or "onboarding page" should be. (IMO the README.md in the Github repo.)
    • Re-evaluate and improve the documentation. Double check e.g. with students if they actually manage to get started with RIOT by themselves, given just the documentation
  • Add missing doc
    • Setting up the toolchains (we had very outdated stuff on this in the Wiki)
    • Setting up common IDEs (unless they can automated)
    • Setting up the toolchains on Windows (this works quite well with WSL2 and USB-IP to do make flash and make term from within Linux to real hardware, it just needs to be better documented)
    • Link the board selection guide to the onboarding page
  • Improve structure of navigation in the doc
    • Reorder the items in the navigation menu
    • Add more structure to the navigation menu (e.g. group all build system stuff, group "creating modules", "creating apps", "creating a driver", "creating a board", ...)
    • Clean up the documentation (e.g. KConfig is still prominent there, not reflection what is current consensus)
    • Fix the hot mess Doxygen does when there are target specific variants of types. (Maybe what we did with gpio_conf_t in GPIO LL could be a solution?)
    • Fix the CSS of the "Table of Contents" box (as seen in the upper right corner e.g. here https://doc.riot-os.org/flashing.html - looks fine on mobile, though)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions