Hi Everyone,

I want to raise a question about Documentation.

As everybody knows NuttX is missing Documentation for more than 90% of the
features it has.

So, in order to improve it when someone adds a new feature or modifies
something related to that feature I request to add or improve the existing
Documentation.

But we know that normally Developers don't want to write Documentation
(normally also don't know how to write a good Documentation).

So, I don't want to push so much, but on the other hand if I don't request
it, who will? And so NuttX will miss even more documentation.

How can we handle situations like this:
https://github.com/apache/nuttx/pull/17283

How can we fix the existing problem without creating a new one (developers
deciding to avoid contributing because they don't want to write
Documentation)? I don't know how other projects like FreeRTOS and Zephyr
handle it.

Recently I asked the contributor from Xiaomi to add Documentation for an
important new subsystem (ClockDevice) and after he said will do it later I
converted the PR to Draft to avoid the Documentation never coming (if you
look at Issues you will find a lot of false promises about Documentation
coming later).

Please let me know what path NuttX should follow: Add Documentation or
Ignore Documentation?

BR,

Alan

Reply via email to