Project

General

Profile

Feature #1701

Updated by Alexander Watzinger over 2 years ago

Although we already have an [[API|API documentation]], thanks to Bernhard, we should think about an overhaul to make it more accessible for beginners and experts alike. 

 A few ideas: 
 * We could take inspiration ideas from successful API documentations, e.g. "selected API examples":https://nordicapis.com/5-examples-of-excellent-api-documentation/ 
 * Maybe switch to the in-application Sphinx documentation. It looks better and would have the advantage to always be the right documentation for the right version 
 * Should be written primarily by @Berni but  
 ** Maybe @Nina could support with her excellent writing skills and with her perspective as an API beginner 
 ** We could ask API interested people about feedback e.g. @Eugen

Back