Open MaureenHelm opened 4 years ago
I'm revisiting these recommendations since I've had mixed results trying to fix some of these problems and I'm listed as a potential mentor on the GSOD project to work on them.
In my opinion, this one is "done":
Here is a progress report on some others from my point of view:
west build
is much more than a wrapper around the CMake build system described in the build overview. That's all it is, though. west build
does have its own documentation which I hope is reasonably complete, but the misconception persists. IOW, the docs are there, but they must not be structured properly to make it easy for new users to understand.I don't feel as qualified to comment on these since I haven't worked on docs for them directly, but perhaps @carlescufi or someone else will chime in:
The following recommendations were made as a result of an Intel user experience study:
Documentation for early-phase developers:
[ ] What is the development model for RTOS (differences from bare metal or standard OS application)? development)
[ ] What is device tree and how to use it?
[ ] How to integrate sensors, drivers, and set configurations
[ ] Zephyr vs. Linux concepts (where the same, where different); leveraging Linux experience with Zephyr
[ ] Porting to custom boards; step-by-step tutorial
[ ] Memory management, preventing stack overflows, debugging tips
[ ] Document how Bluetooth and TCP/IP stack calls in Zephyr are different than Linux or Windows
[ ] Introduction to new tools like West. Be clear about optional versus required use
[ ] More information about West and how it uses Kconfig, DTS, Cmake
[ ] Create architecture diagrams to help with some of the topics above
[ ] Update error messages to be very specific to the error experienced to enable root cause identification
[ ] Adding tools to help with multi-thread application development and de-bug
[ ] Comprehensive sample app and tutorial.