Description

After the last monthly discussion on better documentation efforts, it came the idea of improve several topics and maybe add stuff like openthread.io:

• Mantain an up-to-date webpage for each board, with better documentation on specific configurations, pinouts, etc.
• Add some guides and better end-user documentation (Lack of learning resources #5434).

I also take the opportunity to add additional ideas. Feel free to add more and discuss about these topics!

RFC/Ideas

• Move board specific documentation to Doxygen: doc: move wiki to Doxygen documentation (second attempt) #8516 (@smlng + @aabadie)
  • Where to put the files? boards/<board_name>/doc?
• Generate board/cpu-specific doxygen pages with a script (@bergzand)
• Add pinouts of peripherals
  • Generate pinout from code?
• Codelabs
  • RIOT-OS/Tutorials in Codelabs? (@miri64)
• End User/Developer guides (@emmanuelsearch )
  • RIOT fundamentals tutorial (like Angular's Tour of Heroes)
  • Migrate content from Wiki (partly in doc: move wiki to Doxygen documentation (second attempt) #8516)
  • Extend Doxygen? Static site with embedded Doxygen doc? (like openthread.io)
• Move @defgroup directives to doc.txt instead of header files
• Add categories to Doxygen modules
  • Serializations (doc: add serialization group to Doxygen #9840)
  • Math (doc: add math group to Doxygen #9842)
  • Power management
  • Hashes ( doc: refactor hashes group #9858)
  • Memory Management
  • Debugging
  • Data structures
  • More to be added...

Related issues

#8302, #7998, #7001, #5434